之前咱们学习过原生的Go连接MYSQL的方法，使用Go自带的"database/sql"数据库连接api，"github.com/go-sql-driver/mysql"MYSQL驱动，通过比较原生的写法去写sql和处理事务。目前开源界也有很多封装好的orm操作框架，帮我们简省一些重复的操作，提高代码可读性。gorm就是这样的一款作品，我们来学习一下gorm的操作流程。
安装
go get -u github.com/jinzhu/gorm
数据库连接
要连接到数据库首先要导入驱动程序。例如
import _ "github.com/go-sql-driver/mysql"
为了方便记住导入路径，GORM包装了一些驱动。
1import _ "github.com/jinzhu/gorm/dialects/mysql" 2// import _ "github.com/jinzhu/gorm/dialects/postgres" 3// import _ "github.com/jinzhu/gorm/dialects/sqlite" 4// import _ "github.com/jinzhu/gorm/dialects/mssql"
所以包名可以改为如上：
1import ( 2 "github.com/jinzhu/gorm" 3 _ "github.com/jinzhu/gorm/dialects/mysql" 4) 5 6func main() { 7 db, err := gorm.Open("mysql", "user:password@tcp(IP:port)/dbname?charset=utf8&parseTime=True&loc=Local") 8 db.DB().SetMaxIdleConns(10) 9 db.DB().SetMaxOpenConns(100) 10 defer db.Close() 11}
注：为了处理time.Time，你需要包括parseTime作为参数。
数据模型定义
表名，列名如何对应结构体
在Gorm中，表名是结构体名的复数形式，列名是字段名的蛇形小写。
即，如果有一个user表，那么如果你定义的结构体名为：User，gorm会默认表名为users而不是user。
例如有如下表结构定义：
1CREATE TABLE `areas` ( 2 `id` int(11) NOT NULL AUTO_INCREMENT COMMENT '主键id', 3 `area_id` int(11) NOT NULL COMMENT '区县id', 4 `area_name` varchar(45) NOT NULL COMMENT '区县名', 5 `city_id` int(11) NOT NULL COMMENT '城市id', 6 `city_name` varchar(45) NOT NULL COMMENT '城市名称', 7 `province_id` int(11) NOT NULL COMMENT '省份id', 8 `province_name` varchar(45) NOT NULL COMMENT '省份名称', 9 `area_status` tinyint(3) NOT NULL DEFAULT '1' COMMENT '该条区域信息是否可用 ： 1:可用 2：不可用', 10 `created_at` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT '创建时间', 11 `updated_at` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP COMMENT '更新时间', 12 PRIMARY KEY (`id`) 13) ENGINE=InnoDB AUTO_INCREMENT=1 DEFAULT CHARSET=utf8mb4 COMMENT='区域表'
那么对应的结构体定义如下：
1type Area struct { 2 Id int 3 AreaId int 4 AreaName string 5 CityId int 6 CityName string 7 ProvinceId int 8 ProvinceName string 9 AreaStatus int 10 CreatedAt time.Time 11 UpdatedAt time.Time 12}
如何全局禁用表名复数呢？
可以在创建数据库连接的时候设置如下参数：
1// 全局禁用表名复数 2db.SingularTable(true) // 如果设置为true,`User`的默认表名为`user`,使用`TableName`设置的表名不受影响
这样的话，表名默认即为结构体的首字母小写形式。
CRUD 使用
下面我们使用一张User表来就CRUD做一些操作示例：
表结构如下：
1CREATE TABLE `user` ( 2 `id` bigint(20) NOT NULL AUTO_INCREMENT, 3 `name` varchar(30) NOT NULL DEFAULT '', 4 `age` int(3) NOT NULL DEFAULT '0', 5 `sex` tinyint(3) NOT NULL DEFAULT '0', 6 `phone` varchar(40) NOT NULL DEFAULT '', 7 `create_at` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP, 8 `updated_at` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP, 9 PRIMARY KEY (`id`) 10) ENGINE=InnoDB AUTO_INCREMENT=8 DEFAULT CHARSET=utf8mb4
首先初始化数据库连接：
1package main 2 3import ( 4 "github.com/jinzhu/gorm" 5 _ "github.com/jinzhu/gorm/dialects/mysql" 6) 7 8var db *gorm.DB 9 10type User struct { 11 Id int 12 Name string 13 Age int 14 Sex byte 15 Phone string 16} 17 18func init() { 19 var err error 20 db, err = gorm.Open("mysql", "root:123456@tcp(127.0.0.1:3306)/test?charset=utf8&parseTime=True&loc=Local") 21 if err != nil { 22 panic(err) 23 } 24 //设置全局表名禁用复数 25 db.SingularTable(true) 26} 27
下面所有的操作都是在上面的初始化连接上执行的操作。
插入
1//插入数据 2func (user *User) Insert() { 3 //这里使用了Table()函数，如果你没有指定全局表名禁用复数，或者是表名跟结构体名不一样的时候 4 //你可以自己在sql中指定表名。这里是示例，本例中这个函数可以去除。 5 db.Table("user").Create(user) 6}
更新
1//注意，Model方法必须要和Update方法一起使用 2//使用效果相当于Model中设置更新的主键key（如果没有where指定，那么默认更新的key为id），Update中设置更新的值 3//如果Model中没有指定id值，且也没有指定where条件，那么将更新全表 4//相当于：update user set name='xiaoming' where id=1; 5user := User{Id: 1,Name:"xiaoming"} 6db.Model(&user).Update(user) 7 8//注意到上面Update中使用了一个Struct，你也可以使用map对象。 9//需要注意的是：使用Struct的时候，只会更新Struct中这些非空的字段。 10//对于string类型字段的""，int类型字段0，bool类型字段的false都被认为是空白值，不会去更新表 11 12//下面这个更新操作只使用了where条件没有在Model中指定id 13//update user set name='xiaohong' wehre sex=1 14db.Model(&User{}).Where("sex = ?",1).Update("name","xiaohong")
如果你想手动将某个字段set为空值, 可以使用单独选定某些字段的方式来更新：
1user := User{Id: 1} 2db.Model(&user).Select("name").Update(map[string]interface{}{"name":"","age":0})
忽略掉某些字段：
当你的更新的参数为结构体，而结构体中某些字段你又不想去更新，那么可以使用Omit方法过滤掉这些不想update到库的字段：
1user := User{Id: 1,Name:"xioaming",Age:12} 2db.Model(&user).Omit("name").Update(&user)
删除
1//delete from user where id=1; 2user := User{Id: 1} 3db.Delete(&user) 4 5//delete from user where id > 11; 6db.Delete(&User{},"id > ?",11) 7
事务
1func CreateAnimals(db *gorm.DB) err { 2 tx := db.Begin() 3 // 注意，一旦你在一个事务中，使用tx作为数据库句柄 4 5 if err := tx.Create(&Animal{Name: "Giraffe"}).Error; err != nil { 6 tx.Rollback() 7 return err 8 } 9 10 if err := tx.Create(&Animal{Name: "Lion"}).Error; err != nil { 11 tx.Rollback() 12 return err 13 } 14 15 tx.Commit() 16 return nil 17}
查询：
1func (user *User) query() (u []User) { 2 //查询所有记录 3 db.Find(&u) 4 5 //Find方法可以带 where 参数 6 db.Find(&u,"id > ? and age > ?",2,12) 7 8 //带where 子句的查询，注意where要在find前面 9 db.Where("id > ?", 2).Find(&u) 10 11 // where name in ("xiaoming","xiaohong") 12 db.Where("name in (?)",[]string{"xiaoming","xiaohong"}).Find(&u) 13 14 //获取第一条记录，按照主键顺序排序 15 db.First(&u) 16 17 //First方法可以带where 条件 18 db.First(&u,"where sex = ?",1) 19 20 //获取最后一条记录，按照主键顺序排序 21 //同样 last方法也可以带where条件 22 db.Last(&u) 23 24 return u 25}
注意：方法中带的&u表示是返回值用u这个对象来接收。
上面的查询都将返回表中所有的字段，如果你想指定查询某些字段该怎么做呢？
指定查询字段-Select
1//指定查询字段 2db.Select("name,age").Where(map[string]interface{}{"age":12,"sex":1}).Find(&u)
使用Struct和map作为查询条件
1//使用Struct，相当于：select * from user where age =12 and sex=1 2db.Where(&User{Age:12,Sex:1}).Find(&u) 3 4//等同上一句 5db.Where(map[string]interface{}{"age":12,"sex":1}).Find(&u)
not 条件的使用
1//where name not in ("xiaoming","xiaohong") 2db.Not("name","xiaoming","xiaohong").Find(&u) 3 4//同上 5db.Not("name",[]string{"xiaoming","xiaohong"}).Find(&u)
or 的使用
1//where age > 12 or sex = 1 2db.Where("age > ?",12).Or("sex = ?",1).Find(&u)
order by 的使用
1//order by age desc 2db.Where("age > ?",12).Or("sex = ?",1).Order("age desc").Find(&u)
limit 的使用
1//limit 10 2db.Not("name",[]string{"xiaoming","xiaohong"}).Limit(10).Find(&u)
offset 的使用
1//limit 300,10 2db.Not("name",[]string{"xiaoming","xiaohong"}).Limit(10).Offset(300).Find(&u)
count(*)
1//count(*) 2var count int 3db.Table("user").Where("age > ?",0).Count(&count)
注意：这里你在指定表名的情况下sql为：select count(*) from user where age > 0;
如上代码如果改为：
1var count int 2var user []User 3db.Where("age > ?",0).Find(&user).Count(&count)
相当于你先查出来[]User，然后统计这个list的长度。跟你预期的sql不相符。
group & having
1rows, _ := db.Table("user").Select("count(*),sex").Group("sex"). 2 Having("age > ?", 10).Rows() 3for rows.Next() { 4 fmt.Print(rows.Columns()) 5}
join
db.Table("user u").Select("u.name,u.age").Joins("left join user_ext ue on u.user_id = ue.user_id").Row()
如果有多个连接，用多个Join方法即可。
原生函数
1db.Exec("DROP TABLE user;") 2db.Exec("UPDATE user SET name=? WHERE id IN (?)", "xiaoming", []int{11,22,33}) 3db.Exec("select * from user where id > ?",10).Scan(&user)
一些函数
FirstOrInit 和 FirstOrCreate
获取第一个匹配的记录，若没有，则根据条件初始化一个新的记录：
1//注意：where条件只能使用Struct或者map。如果这条记录不存在，那么会新增一条name=xiaoming的记录 2db.FirstOrInit(&u,User{Name:"xiaoming"}) 3//同上 4db.FirstOrCreate(&u,User{Name:"xiaoming"})
Attrs
如果没有找到记录，则使用Attrs中的数据来初始化一条记录：
1//使用attrs来初始化参数，如果未找到数据则使用attrs中的数据来初始化一条 2//注意：attrs 必须 要和FirstOrInit 或者 FirstOrCreate 连用 3db.Where(User{Name:"xiaoming"}).Attrs(User{Name:"xiaoming",Age:12}).FirstOrInit(&u)
Assign
1//不管是否找的到，最终返回结构中都将带上Assign指定的参数 2db.Where("age > 12").Assign(User{Name:"xiaoming"}).FirstOrInit(&u)
Pluck
如果user表中你只想查询age这一列，该怎么返回呢，gorm提供了Pluck函数用于查询单列，返回数组：
1var ages []int 2db.Find(&u).Pluck("age",&ages)
Scan
Scan函数可以将结果转存储到另一个结构体中。
1type SubUser struct{ 2 Name string 3 Age int 4} 5 6db.Table("user").Select("name,age").Scan(&SubUser)
sql.Row & sql.Rows
row和rows用户获取查询结果。
1//查询一行 2row := db.Table("user").Where("name = ?", "xiaoming").Select("name, age").Row() // (*sql.Row) 3//获取一行的结果后，调用Scan方法来将返回结果赋值给对象或者结构体 4row.Scan(&name, &age) 5 6//查询多行 7rows, err := db.Model(&User{}).Where("sex = ?",1).Select("name, age, phone").Rows() // (*sql.Rows, error) 8defer rows.Close() 9for rows.Next() { 10 ... 11 rows.Scan(&name, &age, &email) 12 ... 13}
日志
Gorm有内置的日志记录器支持，默认情况下，它会打印发生的错误。
1// 启用Logger，显示详细日志 2db.LogMode(true) 3 4// 禁用日志记录器，不显示任何日志 5db.LogMode(false) 6 7// 调试单个操作，显示此操作的详细日志 8db.Debug().Where("name = ?", "xiaoming").First(&User{})