go gin学习记录3

Posted 2023-03-04 梁吉林

环境

环境：mac m1，go version 1.17.2， goland， mysql

安装gorm

第二节学习了在gin中使用go的原生SQL进行操作，这节学习一下使用orm。
go的orm包有很多，gorm是使用较多较广的，所以我们就用gorm来学习。

首先要安装gorm以及相关的驱动：

$ go get -u gorm.io/gorm
go get: added github.com/jinzhu/inflection v1.0.0
go get: added github.com/jinzhu/now v1.1.5
go get: added gorm.io/gorm v1.24.5
$ go get -u gorm.io/driver/mysql
go get: added gorm.io/driver/mysql v1.4.6

安装好gorm之后，我们准备一下要使用的测试数据表，就叫student好了。

建测试表

mysql> create table student(
    -> id int not null auto_increment,
    -> name varchar(32) not null default "" comment "student name",
    -> birth varchar(32) not null default "" comment "student birth",
    -> primary key(id)
    -> )engine=innodb comment "student info";

好的，需要准备的东西都准备好了，下面开始撸码。

搭建代码架子

类似第二节，我们将对student的具体操作都放在一处，还是在controller/目录下新建student.go文件。

package controller

import "github.com/gin-gonic/gin"

type StudentController struct 


type Student struct 
	Id    int    `json:"id"`
	Name  string `json:"name"`
	Birth string `json:"birth"`


func (s *StudentController) CreateStudent(c *gin.Context) 



func (s *StudentController) GetStudentInfo(c *gin.Context) 



func (s *StudentController) UpdateStudent(c *gin.Context) 

然后在入口main.go中增加一个对student操作的路由组：

	student := r.Group("/student")
	
		stuCtrl := controller.StudentController
		student.POST("/createStudent", stuCtrl.CreateStudent)
		student.GET("/getStudentInfo", stuCtrl.GetStudentInfo)
		student.POST("/updateStudent", stuCtrl.UpdateStudent)
	

完善插入操作

下面开始完善具体实现。
由于多个方法中都需要使用dsn，所以先把dsn作为一个全局变量放外边定义

const dsn = "root:@tcp(127.0.0.1:3306)/t_gin?charset=utf8mb4&parseTime=True"

完善代码，从插入功能开始。

func (s *StudentController) CreateStudent(c *gin.Context) 
	var stu Student
	stu.Name = c.PostForm("name")
	stu.Birth = c.PostForm("birth")

	db, err := gorm.Open(mysql.Open(dsn))
	if err != nil 
		log.Panic(err.Error())
	

	result := db.Create(stu)
	if result.Error != nil 
		log.Panic(result.Error.Error())
	

	c.JSON(http.StatusOK, gin.H
		"code": 0,
		"data": result.RowsAffected,
	)

好的，启动项目，调用一下看看结果

出错了。
看一下终端的信息：

Error 1146 (42S02): Table 't_gin.students' doesn't exist

这意思是说t_gin数据库里没有找到students表。
这当然找不到，我们建的表明是student。。。所以这是把我们传入的student参数当成要操作的表名了？后面又给加了个s所以成了students?
为了验证这个猜想，我们换个struct当参数试一下

type Haha struct 
	Id    int    `json:"id"`
	Name  string `json:"name"`
	Birth string `json:"birth"`

复制一份student，就称之为Haha吧。然后把插入操作的代码调整一下

func (s *StudentController) CreateStudent(c *gin.Context) 
	/*var stu Student
	stu.Name = c.PostForm("name")
	stu.Birth = c.PostForm("birth")*/
	var haha Haha
	haha.Name = c.PostForm("name")
	haha.Birth = c.PostForm("birth")

	db, err := gorm.Open(mysql.Open(dsn))
	if err != nil 
		log.Panic(err.Error())
	

	result := db.Create(haha)
	if result.Error != nil 
		log.Panic(result.Error.Error())
	

	c.JSON(http.StatusOK, gin.H
		"code": 0,
		"data": result.RowsAffected,
	)

我们用修改后的代码再重新运行一下，调用看看结果如何：

Error 1146 (42S02): Table 't_gin.hahas' doesn't exist

果然没有意外，如果不知道表名，gorm就按照传入的参数结构体的名称+s作为表名。
有些难以理解。。。
那怎么指定表名呢？
有两种方法，一种是在SQL执行时指定，一种是整个文件范围内的默认指定。
我们先看看第一种，执行时指定：

	result := db.Table("student").Create(haha)

将db操作代码修改如上后，再运行看一下

reflect: reflect.Value.SetInt using unaddressable value

还是报错误，参考了一下官方文档，发现是参数传错了，传参应该给地址，再修改一下：

	result := db.Table("student").Create(&stu)

然后重新执行，这次成功了。

我们看下数据库里的数据

mysql> select * from student;
+----+------+----------+
| id | name | birth    |
+----+------+----------+
|  5 | toms | 2002-5-1 |
+----+------+----------+
1 row in set (0.01 sec)

下面我们再看一下第二种指定表名的方法，文件中全局指定：
我们修改一下student.go文件，加入下列代码：

type Tabler interface 
	TableName() string


func (Student) TableName() string 
	return "student"

相当于定义了一个接口并实现了其对应的方法，那我们看看这样是否有效。
继续修改插入操作的代码

	result := db.Create(&stu)

将sql操作中的表名指定去掉，然后我们再运行看看

运行成功，数据库也有了对应的数据。说明这种方法也是可行的。

完善查询操作

好的，基本的插入操作完善好了，下面来完善查询操作

func (s *StudentController) GetStudentInfo(c *gin.Context) 
	name := c.Query("name")

	db, err := gorm.Open(mysql.Open(dsn))
	if err != nil 
		log.Panic(err.Error())
	

	var stu Student
	result := db.Where("name=?", name).First(&stu)
	if result.Error == gorm.ErrRecordNotFound 
		c.JSON(http.StatusOK, gin.H
			"code": 0,
			"data": "",
		)
	
	if result.Error != nil 
		log.Panic(result.Error.Error())
	

	c.JSON(http.StatusOK, gin.H
		"code": 0,
		"data": stu,
	)

查询操作完善之后，我们运行一下看看

非常好，一次成功。
查询是日常开发中最常使用的功能，有许多中查询的方式，以及各种限制条件，这些官方文档里都有详细的说明，想了解具体的就去查一下官方文档，这里不做赘述。

完善更新操作

下面继续完善更新操作，完善后的代码如下：

func (s *StudentController) UpdateStudent(c *gin.Context) 
	name := c.PostForm("name")
	birth := c.PostForm("birth")
	
	db, err := gorm.Open(mysql.Open(dsn))
	if err != nil
		log.Panic(err.Error())
	
	
	var stu Student
	result := db.Model(&stu).Where("name=?", name).Update("birth", birth)
	if result.Error != nil 
		log.Panic(result.Error.Error())
	
	
	c.JSON(http.StatusOK, gin.H
		"code":0,
		"data": result.RowsAffected,
	)

我们继续允许看看

好的，运行成功了
那数据库中的数据确实更新了吗？

mysql> select * from student;
+----+------+------------+
| id | name | birth      |
+----+------+------------+
|  5 | toms | 2002-5-1   |
|  6 | gaga | 2023-02-17 |
+----+------+------------+
2 rows in set (0.00 sec)

好的，确实更新了，那基本的更新操作也完成了。

获取生成的SQL语句

有些情况下，我们可能想知道生成的sql是什么样子的，原生sql一目了然，而orm却有些云里雾里，就连记录sql log都有些无从下手。
没关系，我们找办法把gorm生成的sql打印出来。
我们用最近的更新操作来做实验，修改更新操作的db操作代码如下：

	var stu Student
	result := db.Model(&stu).Where("name=?", name).Update("birth", birth)
	ss := db.Session(&gorm.SessionDryRun: true).Model(&stu).Where("name=?", name).Update("birth", birth).Statement
	log.Println(ss.SQL.String(), ss.Vars)

	if result.Error != nil 
		log.Panic(result.Error.Error())
	

然后我们允许一下看看，就能看到在Terminal终端中打印出了生成的SQL语句：

[GIN-debug] Listening and serving HTTP on :8080
2023/02/17 23:09:56 UPDATE `student` SET `birth`=? WHERE name=? [2000-1-1 gaga]
[GIN] 2023/02/17 - 23:09:56 | 200 |   45.498834ms |             ::1 | POST     "/student/updateStudent"

那那那，gorm生成的sql也打印出来了，排查问题又简单了一步。

好了，今天就到这儿。