实践记录（二）Gin+Gorm实现简易增删查改 ｜ 青训营

goorkg
469 阅读7分钟

在这个教程中，我们将使用Gin框架和Gorm库来实现对一个user表的增加、查询、更新和删除功能。Gin是一个轻量级的Web框架，而Gorm是一个强大的Go语言ORM库，它们的结合将帮助我们快速构建这个应用程序。

1. 环境准备

在开始之前，确保你已经安装了Go语言环境，并且安装了Gin和Gorm的相关依赖。还需要一个MySQL数据库来存储user信息。

2. 安装依赖

首先，我们需要安装Gin和Gorm的相关依赖。

go get -u github.com/gin-gonic/gin
go get -u gorm.io/gorm
go get -u gorm.io/driver/mysql

3. 初始化数据库环境

  • 添加数据库 325366e268104745304052ae75fc9d4.png

  • 建立user表（id设置为自动递增） 微信图片_20230728223940.png

4. 初始化项目结构

image.png

  • controller存放业务逻辑
  • models存放数据模型
  • tools存放工具类
  • main.go为项目启动文件
  • router.go用于初始化Gin的路由

3. 创建数据模型

我们需要定义一个数据模型来表示user信息。在这个教程中，我们将创建一个名为"User"的结构体，包含ID、姓名、密码和邮箱字段，再models目录下新建user.go文件

package models  
  
type User struct {  
    Id int  
    Username string  
    Password string  
    Email string  
}  
  
func (User) TableName() string {  
    return "user"  
}

4. 初始化数据库连接

接下来，我们需要初始化数据库连接。在这里，我们将使用Gorm的MySQL驱动，在tools下新建db.go

package tools  
  
import (  
    "fmt"  
    "gorm.io/driver/mysql"  
    "gorm.io/gorm"  
)  
  
var _db *gorm.DB  
var err error  
  
func init() {  
    dsn := "username:password@tcp(127.0.0.1:3306)/dbname?charset=utf8&parseTime=True&loc=Local"  
    _db, err = gorm.Open(mysql.Open(dsn), &gorm.Config{})  
    if err != nil {  
        fmt.Println(err)  
    }  
    sqlDB, _ := _db.DB()  
  
    sqlDB.SetMaxOpenConns(100)  
    sqlDB.SetMaxIdleConns(20)  
}  
  
func GetDB() *gorm.DB {  
    return _db  
}

请将上面的dsn中的username、password和dbname替换为你自己的MySQL连接信息。

5. 创建Gin路由

现在，我们可以创建Gin路由并定义相应的处理函数。在这个教程中，我们将实现以下功能：

  • 增加user：向数据库中添加新的user信息。
  • 删除user：根据userID从数据库中删除user信息。
  • 查询单个user：根据userID查询特定user的信息。
  • 更新user信息：根据userID更新user的信息。 在router.go写入下列代码
package main  
  
import (  
    "github.com/gin-gonic/gin"  
    "gormProject/controller"  
)  
  
func initRouter(r *gin.Engine) {  
    apiRouter := r.Group("/gormtest")  
  
    apiRouter.POST("/user/", controller.Add)  
    apiRouter.DELETE("/user/:id", controller.Delete)  
    apiRouter.GET("/user/", controller.Select)  
    apiRouter.PUT("/user/", controller.Update)  
}

6. 实现controller

在controller下新建userController.go

package controller

import (
	"encoding/json"
	"fmt"
	"github.com/gin-gonic/gin"
	"gormProject/models"
	"gormProject/tools"
	"net/http"
	"strconv"
)

func Add(c *gin.Context) {
	username := c.PostForm("username")
	password := c.PostForm("password")
	email := c.PostForm("email")

	user := models.User{
		Username: username,
		Password: password,
		Email:    email,
	}

	err := tools.GetDB().Create(&user).Error

	if err != nil {
		c.JSON(http.StatusNotFound, gin.H{"message": "添加失败"})
	} else {
		c.JSON(http.StatusOK, gin.H{"message": "添加成功"})
	}
}

func Delete(c *gin.Context) {
	id, _ := strconv.Atoi(c.Param("id"))

	user := models.User{
		Id: id,
	}

	err := tools.GetDB().Delete(&user).Error

	if err != nil {
		c.JSON(http.StatusNotFound, gin.H{"message": "删除失败"})
	} else {
		c.JSON(http.StatusOK, gin.H{"message": "删除成功"})
	}
}

func Select(c *gin.Context) {
	id, _ := strconv.Atoi(c.Query("id"))

	var user models.User

	err := tools.GetDB().First(&user, "id = ?", id).Error

	if err != nil {
		c.JSON(http.StatusNotFound, gin.H{"message": "查找失败"})
	} else {
		c.JSON(http.StatusOK, gin.H{"message": user})
	}
}

func Update(c *gin.Context) {
	j, _ := c.GetRawData()

	var user models.User

	json.Unmarshal(j, &user)

	fmt.Println(user)

	err := tools.GetDB().Model(&user).Updates(user).Error

	if err != nil {
		c.JSON(http.StatusNotFound, gin.H{"message": "更改失败"})
	} else {
		c.JSON(http.StatusOK, gin.H{"message": user})
	}
}

这段代码是一个用于处理用户信息的控制器(Controller)。它包含了四个主要功能函数：Add、Delete、Select和Update，分别用于添加用户、删除用户、查询用户和更新用户信息。

  1. Add函数：

    • 功能：用于添加用户信息到数据库。
    • 输入：通过POST请求获取用户名(username)、密码(password)和电子邮件(email)。
    • 处理：将获取的用户信息构建为models.User结构体，然后通过gorm库执行Create操作将用户信息插入数据库。
    • 输出：根据操作结果返回不同的JSON响应。若添加成功，返回状态码200和"添加成功"的消息；若添加失败，返回状态码404和"添加失败"的消息。

  2. Delete函数：

    • 功能：用于删除指定ID的用户信息。
    • 输入：通过URL的PathParam获取用户ID(id)。
    • 处理：将获取的ID构建为models.User结构体，并通过gorm库执行Delete操作删除数据库中对应的用户信息。
    • 输出：根据操作结果返回不同的JSON响应。若删除成功，返回状态码200和"删除成功"的消息；若删除失败，返回状态码404和"删除失败"的消息。

  3. Select函数：

    • 功能：用于查询指定ID的用户信息。
    • 输入：通过URL的查询参数获取用户ID(id)。
    • 处理：通过gorm库的First函数查询数据库中指定ID的用户信息，并将查询结果存储在变量user中。
    • 输出：根据查询结果返回不同的JSON响应。若查询成功，返回状态码200和查询到的用户信息；若查询失败（未找到指定ID的用户），返回状态码404和"查找失败"的消息。

  4. Update函数：

    • 功能：用于更新用户信息。
    • 输入：通过请求的body获取用户信息的JSON数据。
    • 处理：将获取的JSON数据解析为models.User结构体，并通过gorm库的Updates函数将用户信息更新到数据库。
    • 输出：根据操作结果返回不同的JSON响应。若更新成功，返回状态码200和更新后的用户信息；若更新失败，返回状态码404和"更改失败"的消息。

总结：这段代码是一个简单的用户信息处理控制器，提供了添加、删除、查询和更新用户信息的功能。它使用了Gin框架处理HTTP请求和响应，并通过GORM库与数据库交互。通过这些功能，我们可以对用户信息进行增删改查操作。

7.启动服务

package main  
  
import "github.com/gin-gonic/gin"  
  
func main() {  
    r := gin.Default()  
  
    initRouter(r)  
  
    r.Run(":8080")  
}

8.测试

现在，你可以运行这个应用程序，并访问以下URL来测试增删查改功能：

  • 增加学生：发送POST请求到http://127.0.0.1:8080/gormtest/user/，并在请求体中包含学生信息的表单数据。 image.png
  • 查询单个学生：发送GET请求到http://127.0.0.1:8080/gormtest/user/?id=:id，其中:id替换为user的ID。 image.png
  • 更新学生信息：发送PUT请求到http://127.0.0.1:8080/gormtest/user/，并在请求体中包含更新后的学生JSON数据。 image.png
  • 删除学生：发送DELETE请求到http://127.0.0.1:8080/gormtest/user/:id，其中:id替换为user的ID。 image.png

9.感悟

使用 GORM 框架是一种愉快的经历。GORM 是一个优秀的 Go 语言 ORM（对象关系映射）库，它为数据库操作提供了简洁、灵活和强大的解决方案。

首先，GORM 的易用性令人印象深刻。通过 GORM，我可以轻松地定义模型结构和数据库表之间的映射关系，无需手动编写繁琐的 SQL 语句。它提供了丰富的方法和函数，让我可以方便地进行增删改查操作。这使得数据库操作变得非常简单和高效。

其次，GORM 的灵活性使得它适用于多种数据库系统。它支持多种数据库后端，如 MySQL、PostgreSQL、SQLite 等，让我可以根据项目需求选择最合适的数据库。这种灵活性为开发提供了更多的选择和可能性。

GORM 还提供了强大的查询功能。通过链式调用，我可以灵活地构建复杂的查询条件，并且在查询结果中选择需要的字段。这样，我可以高效地从数据库中获取所需数据，而不必担心性能问题。

除此之外，GORM 还支持数据库迁移功能，可以自动创建和更新数据库表结构，方便数据库版本的管理和升级。这对于团队协作和项目维护非常有帮助。

最后，GORM 社区活跃，拥有大量的文档和示例代码。这让我在使用 GORM 过程中遇到问题时能够快速找到解决方案，并且能够学习到更多的最佳实践和开发技巧。

总的来说，使用 GORM 框架让我在开发中省去了很多繁琐的数据库操作，提高了开发效率和代码质量。它的简洁、灵活和强大让我在数据库操作中感受到了极大的便利，同时也增加了代码的可读性和可维护性。我会继续使用 GORM，并将其作为 Go 语言项目中不可或缺的重要工具。

avatar
文章
阅读
粉丝