gorm小技巧

编撰人：问冰
编撰时间：2022 年 2 月 27 日
当前版本：v1.1

例子表：
users：

一.如何查看gorm生成的sql语句

直接上例子：

stmt := db.Session(&gorm.Session{DryRun: true}).Where("id = ?", 1).First(&User{}).Statement
sql := stmt.SQL.String()
println(sql)

结果：SELECT * FROM `users` WHERE id = ? ORDER BY `users`.`id` LIMIT 1

二.基本查询

1.单个字段

var names []string
db.Model(&User{}).Select("name").Find(&names)
for _, name := range names {
    println(name)
}

输出：
NB
abcvv
cvba

2.多个字段

法一

var mps []map[string]interface{}
db.Model(&User{}).Select("name, number").Find(&mps)
for _, mp := range mps {
	println(mp["name"].(string), mp["number"].(uint))
}

输出：
NB 7
abcvv 8
cvba 9

法二

type UserResp struct {
	Name string `gorm:"column:name"`
	Age  uint   `gorm:"column:age"`
}

//var usersResp []*UserResp 也可
var usersResp []UserResp
db.Model(&User{}).Find(&usersResp)
for _, user := range usersResp {
	println(user.Name, user.Age)
}

输出：
NB 10
abcvv 20
cvba 30

备注：gorm会根据传入的结构体来进行自动的select（如上面的userResp会自动select（name,age）），因此这种情况不需要特意加上select。

三.综合应用：

1.根据用户的id获取出课程并组成一个切片

数据表：
users:

courses:

courses_users:

期望达到的效果:

需求：用户和课程是多对多的关系，因此有一个用户和课程的对应表courses_users，现在要根据用户的id来查询courses表中用户对应的所有课程的名字返回。最后需要组成一个切片。

①.sql原生语句实现

首先需要清除比较麻烦的是需要查询的course_name字段，course_name只在courses表中存在，因此需要在courses_users表中通过user_id查询到对应的course_id，再在courses表中通过course_id查询course_name，最后将course_name根据user_id聚合，将多条数据合成一条。
对于不熟悉的较为复杂的问题，在使用gorm解决前，一般先使用原生的sql语句完成功能，再编写gorm的代码完成功能。
完成上述功能的mySQL语句如下：

SELECT
	users.*,
	GROUP_CONCAT( courses.NAME ) courses_names 
FROM
	`users`
	LEFT JOIN ( SELECT id, NAME FROM courses ) courses ON courses.id IN ( SELECT course_id FROM courses_users WHERE user_id = users.id ) 
GROUP BY
	users.id

因为需要添加的course_name字段是在courses表中的，因此left join的数据表为courses，select出需要使用的字段id和name。再对其id添加约束条件。因为表是多对多的关系，因此一个users.id可能对应多个course_name，所以使用in。然后通过courses_users表中user_id等于users.id条件来筛选出需要的course_id范围。这样就拿到了一个user.id对应的course_name。但是这样直接输出是不会把相同的users.id的数据合成一条的，因此需要group by来分组实现，后面接上合并的依据的参数users.id。需要注意的是，这样在最上面的select不能直接用*,需要用users.，也就是users中的所有字段，加上course_name组成的一个字段。group_concat函数的作用是把同一组的多个数据合并成一条，效果如上图。如果直接用，会默认把course表中的id也加进去，但因为并没有对course_id进行聚合(使用group_concat函数)，因此会报错。而且需求中也不需要course_id这条字段。

②.gorm的实现

type UsersCourse struct {
	UserId uint `gorm:"column:id;"`
	Courses []string `gorm:"column:course_names;"`
	CoursesNames string `gorm:"column:course_names;"`
}

因为要获取的是course_name，因此最初的思路希望能直接把一个user.id的course_name组成一个切片返回。如果它不能作为一个切片返回，那么只能作为一个字符串返回再进行手动分割成切片。

db.Model(&User{}).Select("users.*,GROUP_CONCAT(courses.name) course_names").Joins("LEFT JOIN ( SELECT id, NAME FROM courses ) courses ON courses.id IN ( SELECT course_id FROM courses_users WHERE user_id = users.id ) ").Group("users.id").Find(&userCourses)

但是运行之后会报错：

sql: Scan error on column index 3, name "course_names": unsupported Scan, storing driver.Value type []uint8 into type *[]string

可见它是无法直接作为一个切片返回的。因此只能作为一个字符串返回（把字符串切片的gorm映射改为"gorm:"-""）

再次运行后：

可以拿到正确的返回值了。
再对字符串进行分割：

for index, _ := range userCourses {
	userCourses[index].Courses = strings.Split(userCourses[index].CoursesNames, ",")
	fmt.Printf("userCourse:%q\n", userCourses[index].Courses)
}

输出：

userCourse:["c" "java" "math" "english" "chinese" "computer"]
userCourse:["math" "c" "go"]
userCourse:["math"]
userCourse:["english"]
userCourse:["computer" "chinese"]
userCourse:["english" "chinese"]
userCourse:["chinese"]

需求完成~

备注：需要注意的是，不管是否需要所有的数据，在小编的经验中只要使用了gorm中的joins来left join时，无论是否需要所有的数据，都需要手动加上select条件。否则会获取不到数据。

var userCourses []*UsersCourse
db.Model(&User{}).Joins("LEFT JOIN ( SELECT id, NAME as courses_names FROM courses ) courses ON courses.id IN ( SELECT course_id FROM courses_users WHERE user_id = users.id ) ").Group("users.id").Find(&userCourses)
stmt := db.Session(&gorm.Session{DryRun: true}).Model(&User{}).Joins("LEFT JOIN ( SELECT id, NAME as courses_names FROM courses ) courses ON courses.id IN ( SELECT course_id FROM courses_users WHERE user_id = users.id ) ").Group("users.id").Find(&userCourses).Statement
sql := stmt.SQL.String()
println(sql)

结果：

sql="SELECT `users`.`id`,`users`.`name`,`users`.`age` FROM `users` LEFT JOIN ( SELECT id, NAME as courses_names FROM courses ) courses ON courses.id IN ( SELECT course_id FROM courses_users WHERE user_id = users.id )  GROUP BY `users`.`id`"

可以看出只有UserId有值，left join的成员无法进行赋值。原因是gorm自动增加的select是根据Model的结构体对应的数据表进行自动添加的，添加的字段只有Model对应的表中的字段，因此join的字段就无法获取了（当然还可能根据Find中的结构体成员和gorm的映射自动对select的字段进行减少，但也无法自动映射join的字段）。所以在有join的情况下必须手动加上select。

---