gorm
做任何事情之前查阅官方文档
本文档只是学习笔记。
1. 概述
ORM让数据库里面的表结构变成代码定义的数据结构(golang里面结构体的结构),从而做到,代码结构即为数据库结构,代码行为即为数据库行为。
ORM也是面向对象思维方式的体现。
数据表---结构体
数据行---结构体实例
数据表字段---结构体字段(属性)
面向对象思维方式,一个结构体对象,具有属性和方法(行为)
ORM优缺点:
优点:
提高开发效率
缺点:
牺牲执行性能,弱化SQL能力
写ORM语句,相比于直接写SQL语句,多了一个将ORM语句翻译成SQL语句的过程,性能自然低一些。
2. 数据库连接、建表
2.1 连接
import ( "fmt" "gorm.io/driver/mysql" "gorm.io/gorm" ) func main() { dsn := "root:admin@tcp(xxx:xxx)/gorm_class?charset=utf8mb4&parseTime=True&loc=Local" db, err := gorm.Open(mysql.Open(dsn), &gorm.Config{}) fmt.Println(db, err) }
func main() { db, err := gorm.Open(mysql.New(mysql.Config{ DSN: "root:admin@tcp(xxx:xxx)/gorm_class?charset=utf8mb4&parseTime=True&loc=Local", DefaultStringSize: 171, }), &gorm.Config{ SkipDefaultTransaction: false, NamingStrategy: schema.NamingStrategy{ TablePrefix: "t_", // table name prefix, table for `User` would be `t_users` SingularTable: true, // use singular table name, table for `User` would be `user` with this option enabled }, DisableForeignKeyConstraintWhenMigrating: true, //现在主张逻辑外键(也就是在代码里面自动体现外键关系,而不真正地建立物理外键) }) fmt.Println(db, err) }
mysql.Config和gorm.Config都是配置类,在golang中是结构体,也就是Java中的配置类,那么这里相当于是传入引用类型,即传入对象,在这里也就是结构体的实例。
这两个配置类里分别有许多配置,具体配置见官网。
连接池
sqlDB, err := db.DB() // SetMaxIdleConns 设置空闲连接池中连接的最大数量 sqlDB.SetMaxIdleConns(10) // SetMaxOpenConns 设置打开数据库连接的最大数量。 sqlDB.SetMaxOpenConns(100) // SetConnMaxLifetime 设置了连接可复用的最大时间。 sqlDB.SetConnMaxLifetime(time.Hour)
2.2 表的操作
func main() { db, err := gorm.Open(mysql.New(mysql.Config{ DSN: "root:admin@tcp(xxx:xxx)/gorm_class?charset=utf8mb4&parseTime=True&loc=Local", DefaultStringSize: 171, }), &gorm.Config{ SkipDefaultTransaction: false, NamingStrategy: schema.NamingStrategy{ TablePrefix: "gva_", // table name prefix, table for `User` would be `t_users` SingularTable: true, // use singular table name, table for `User` would be `user` with this option enabled }, DisableForeignKeyConstraintWhenMigrating: true, // 现在主张逻辑外键(也就是在代码里面自动体现外键关系,而不真正地建立物理外键) }) fmt.Println(db, err) user := new(User) M := db.Migrator() // 判断表是否存在 if M.HasTable(user) { // 删除表 M.DropTable(user) } else { // 创建表 M.CreateTable(user) } } type User struct { Name string }
从上面代码的User结构体看出,gorm对数据库的操作的ORM。
GORM 提供了 Migrator 接口,该接口为每个数据库提供了统一的 API 接口,用于进行对数据库操作。
- 对数据库的操作
- 对表的操作
- 对列的操作
- 对索引的操作
3. 模型建立
3.1 概念
模型model:
一个结构体,携带gorm规定的标签或者实现了gorm的接口。
模型有什么用:
- 是gorm进行各种操作的基础
- 一个书写良好的模型会使得对数据库的操作事半功倍
在使用gorm框架时,通常需要我们在代码中定义模型和数据库中的数据进行映射。
3.2 定义
默认情况下,GORM使用ID作为主键,使用结构体的蛇形复数作为表名。
为了方便模型定义,GORM内置了一个gorm.Model结构体,gorm.Model是一个包含了ID,CreatedAt,UpdatedAt,DeletedAt四个字段的结构体。
我们可以将gorm.Model结构体嵌入到自己的模型中,当然也可以完全自己定义模型。
使用字段名的蛇形作为列名,并使用CreatedAt、UpdatedAt字段追踪创建、更新时间。
模型定义示例:
type Task struct { gorm.Model Name string `gorm:"column:name" json:"name"` Description string `gorm:"column:description" json:"description"` Spec string `gorm:"column:spec" json:"spec"` JobType string `gorm:"column:jobType" json:"job_type"` Protocol string `gorm:"column:protocol" json:"protocol"` HttpMethod string `gorm:"column:httpMethod" json:"http_method"` Url string `gorm:"column:url" json:"url"` JobBody string `gorm:"column:job" json:"job"` Timeout int `gorm:"column:timeout" json:"timeout"` RetryTimes int `gorm:"column:retryTimes" json:"retry_times"` RetryInterval int `gorm:"column:retryInterval" json:"retry_interval"` NotifyStatus int `gorm:"column:notifyStatus" json:"notify_status"` NotifyType int `gorm:"column:notifyType" json:"notify_type"` NotifyReceiverId string `gorm:"column:notifyReceiverId" json:"notify_receiver_id"` Status Status `gorm:"column:Status" json:"status"` }
type User1 struct { gorm.Model // 内嵌Gorm模型 Name string Age sql.NullInt64 Birthday *time.Time Email string `gorm:"type:varchar(100);unique_index"` Role string `gorm:"size:255"` // 设置字段大小为255 MemberNumber *string `gorm:"unique;not null"` // 设置会员号唯一且不为空 Num int `gorm:"AUTO_INCREMENT"` // 设置num为自增类型 Address string `gorm:"index:addr"` // 给address字段创建名为addr的索引 IgnoreMe int `gorm:"-"` // 忽略本字段 }
gorm标签的作用主要就是给这个golang结构体的字段(属性),定义他们对应在数据表中的字段,包括类型,是否非空,自增,主键,唯一性,大小等等。具体可以通过gorm标签定义哪些类型可以去查看gorm官网文档。
如果自己定义的模型里定义了ID字段,那么Gorm就会把这个ID字段当作主键。
3.3 约定
主键
Gorm默认会使用名为ID的字段作为表的主键。
如果要设置别的字段作为表的主键,那么就加上
gorm:"primary_key"
tag,这就是指定字段为主键。表名
表名默认是结构体名称的复数。
自定义,指定表名:
type User1 struct { gorm.Model // 内嵌Gorm模型 Name string Age sql.NullInt64 Birthday *time.Time Email string `gorm:"type:varchar(100);unique_index"` Role string `gorm:"size:255"` // 设置字段大小为255 MemberNumber *string `gorm:"unique;not null"` // 设置会员号唯一且不为空 Num int `gorm:"AUTO_INCREMENT"` // 设置num为自增类型 Address string `gorm:"index:addr"` // 给address字段创建名为addr的索引 IgnoreMe int `gorm:"-"` // 忽略本字段 } func (u *User1) TableName() string { return "qimi" }
func (u *User1) TableName() string { //在这个方法里,可以做判断来设置表名 if u.Role == "admin" { return "admin_users" } return "users" }
指定表的名称,同时创建表。用Table方法
func Create() { db := config.GetDB() err := db.Table("profiles").AutoMigrate(&model.User1{}) if err != nil { fmt.Println(err) } }
列名
列名由字段名称进行下划线分割来生成,可以使用结构体tag column来指定列名。
type User struct { ID uint // column name is "id" Name string // column name is "name" Birthday time.Time //column name is "birthday" CreatedAt time.Time //column name is "created_at" }
数据库里列名是用下划线连接,和json一样,go和Java代码里是驼峰命名式。
3.4 时间戳跟踪
CreatedAt
如果模型有CreatedAt字段,该字段的值将会是初次创建记录的时间
UpdatedAt
如果模型有UpdatedAt字段,该字段的值将会是每次更新记录的时间。
DeleteAt
使用gorm删除数据,默认是软删除,删除数据后,将会设置记录DeletedAt字段为删除时间,而不是直接将记录从数据库中删除。
3.5 默认值
可以通过tag定义字段的默认值,在创建记录时生成的SQL语句会排除没有值或值为零值的字段,在将记录插入到数据库后,Gorm会从数据库加载那些字段的默认值。
举个例子:
var user = User{Age:18, Name:""} db.Create(&User)
上面代码实际执行的SQL语句是
INSERT INTO users("age") values('18');
排除了零值字段Name,而在数据库中这一条数据会使用设置的默认值作为Name字段的值。
4. 增删改查
4.1 创建表
- 连接数据库
- 创建表、自动迁移
func CreateTable(userInfo *model.UserInfo1) {
// 创建表,自动迁移
// 自动迁移指的是把结构体和数据表进行对应
db := config.GetDB()
db.AutoMigrate(userInfo)
}
4.2 插入数据
4.2.1 单独创建
func Create(userInfo *model.UserInfo1) error {
// 创建表,自动迁移
// 自动迁移指的是把结构体和数据表进行对应
db := config.GetDB()
err := db.AutoMigrate(userInfo)
if err != nil {
return err
}
// 创建数据
db.Create(userInfo)
return nil
}
func TestUserCreate() {
migrator := GLOBAL_DB.Migrator()
testUser := new(TestUser)
testUser.Name = "Jinzhu"
testUser.Age = 18
testUser.Birthday = time.Now()
if !migrator.HasTable(testUser) {
migrator.CreateTable(testUser)
}
result := GLOBAL_DB.Create(testUser) // 通过数据的指针来创建
fmt.Println(testUser.ID) // 返回插入数据的主键
fmt.Println(result.Error) // 返回 error
fmt.Println(result.RowsAffected) // 返回插入记录的条数
}
4.2.2 指定字段创建
// 指定要创建的结构体的某个字段,其他字段不创建。
result := GLOBAL_DB.Select("Name").Create(testUser) // 通过数据的指针来创建
4.2.3 跳过字段创建
// 除了指定的该字段不创建,其他字段都创建
result := GLOBAL_DB.Omit("Name").Create(testUser) // 通过数据的指针来创建
4.2.4 批量创建
用切片的形式
对象的指针的切片
db.Create(&[]一个模型)
func TestUserCreate() {
migrator := GLOBAL_DB.Migrator()
testUser := new(TestUser)
user3 := new(TestUser)
user3.Name = "4444"
user3.Age = 18
user3.Birthday = time.Now()
user4 := new(TestUser)
user4.Name = "5555"
user4.Age = 18
user4.Birthday = time.Now()
user5 := new(TestUser)
user5.Name = "6666"
user5.Age = 18
user5.Birthday = time.Now()
if !migrator.HasTable(testUser) {
migrator.CreateTable(testUser)
}
var slice = []*TestUser{user3, user4, user5}
result := GLOBAL_DB.Create(slice) // 通过数据的指针来创建
fmt.Println(testUser.ID) // 返回插入数据的主键
fmt.Println(result.Error) // 返回 error
fmt.Println(result.RowsAffected) // 返回插入记录的条数
}
4.3 查询数据
查询 | GORM - The fantastic ORM library for Golang, aims to be developer friendly.
4.3.1 接收返回值的形式
- Map
- struct
一般就是这两种方式最常用,也更体现出面向对象和ORM
func TestUserFind() {
user := new(TestUser)
//testUser := new(TestUser)
//res := make(map[string]interface{})
result := GLOBAL_DB.First(user)
if result.Error != nil {
log.Println(result.Error)
return
}
fmt.Println(user.Name)
fmt.Println(user.Age)
fmt.Println(user.Birthday)
}
4.3.2 查询主键排序后的第一条
db.First(&一个模型)
4.3.3 查询一条记录(不推荐)
db.Take(&一个模型)
4.3.4 查询主键排序后的最后一条
db.Last(&一个模型)
4.3.5 查询所有的记录
db.Find(&users)
传入的是切片的指针
4.3.6 查询条件
根据主键检索
主键是唯一的,所以这里用了First
result := GLOBAL_DB.First(user, 5)
where
result := GLOBAL_DB.Where("name = ?", "2222").First(user)
// Get first matched record db.Where("name = ?", "jinzhu").First(&user) // SELECT * FROM users WHERE name = 'jinzhu' ORDER BY id LIMIT 1; // Get all matched records db.Where("name <> ?", "jinzhu").Find(&users) // SELECT * FROM users WHERE name <> 'jinzhu'; // IN db.Where("name IN ?", []string{"jinzhu", "jinzhu 2"}).Find(&users) // SELECT * FROM users WHERE name IN ('jinzhu','jinzhu 2'); // LIKE db.Where("name LIKE ?", "%jin%").Find(&users) // SELECT * FROM users WHERE name LIKE '%jin%'; // AND db.Where("name = ? AND age >= ?", "jinzhu", "22").Find(&users) // SELECT * FROM users WHERE name = 'jinzhu' AND age >= 22; // Time db.Where("updated_at > ?", lastWeek).Find(&users) // SELECT * FROM users WHERE updated_at > '2000-01-01 00:00:00'; // BETWEEN db.Where("created_at BETWEEN ? AND ?", lastWeek, today).Find(&users) // SELECT * FROM users WHERE created_at BETWEEN '2000-01-01 00:00:00' AND '2000-01-08 00:00:00';
where里面可以不用字符串,可以用结构体和map条件
// Struct db.Where(&User{Name: "jinzhu", Age: 20}).First(&user) // SELECT * FROM users WHERE name = "jinzhu" AND age = 20 ORDER BY id LIMIT 1; // Map db.Where(map[string]interface{}{"name": "jinzhu", "age": 20}).Find(&users) // SELECT * FROM users WHERE name = "jinzhu" AND age = 20; // Slice of primary keys db.Where([]int64{20, 21, 22}).Find(&users) // SELECT * FROM users WHERE id IN (20, 21, 22);
具体见官网介绍(查询 | GORM - The fantastic ORM library for Golang, aims to be developer friendly.)
内联条件
// Get by primary key if it were a non-integer type db.First(&user, "id = ?", "string_primary_key") // SELECT * FROM users WHERE id = 'string_primary_key'; // Plain SQL db.Find(&user, "name = ?", "jinzhu") // SELECT * FROM users WHERE name = "jinzhu"; db.Find(&users, "name <> ? AND age > ?", "jinzhu", 20) // SELECT * FROM users WHERE name <> "jinzhu" AND age > 20; // Struct db.Find(&users, User{Age: 20}) // SELECT * FROM users WHERE age = 20; // Map db.Find(&users, map[string]interface{}{"age": 20}) // SELECT * FROM users WHERE age = 20;
内联条件也可以有map、struct、string条件。
4.3.7 查询多条数据
传入切片的指针
func TestUserFind() {
var users []TestUser
result := GLOBAL_DB.Where("name <> ?", "jinzhu").Find(&users)
if result.Error != nil {
log.Println(result.Error)
return
}
fmt.Println(len(users))
for _, u := range users {
fmt.Println(u.Name)
fmt.Println(u.Age)
fmt.Println(u.Birthday)
fmt.Println("---------")
}
}
4.3.8 智能选择字段
要注意在查询的时候,如果希望返回值用结构体来接收,并且此结构体就是和表映射的结构体,那么可以直接用db.Find(&user)
这种形式,但是如果想用另一个结构体(比如用UserInfo结构体,减少了User的信息,让返回结构更简洁)来接收,那么就不能这样写,因为查询的时候必须和表映射起来。
func TestUserFind() {
var user TestUser
var userInfo []UserInfo
// 由于这个userInfo对象只有两个属性,此userInfo只是用来接收查询返回值的载体,而不是ORM,和数据库中的表完全映射的Model
// 所以我们在查询之前一定要和数据表映射起来
result := GLOBAL_DB.Model(user).Find(&userInfo)
if result.Error != nil {
log.Println(result.Error)
return
}
fmt.Println(len(userInfo))
fmt.Println(userInfo)
}
type UserInfo struct {
Name string
Age uint8
}
提示
当通过结构体进行查询时,GORM只会通过非零值字段查询,这意味着如果字段是0,"",false或其他零值时,将不会被用于构建查询条件,例如:
var users []User
db.Where(&User{Name:"jinzhu", Age:0}).Find(&users)
// select * from users where name = "jinzhu";
可以使用指针或实现Scanner/Valuer接口来避免这个问题
//使用指针
type User struct {
gorm.Model
Name string
Age *int
}
// 实现Scanner/Valuer接口
type User struct {
gorm.Model
Name string
Age sql.NullInt64 //sql.NullInt64实现了Scanner/Valuer接口
}
4.3.9 FirstOrInit
获取匹配的第一条记录,否则根据给定的条件初始化一个新的对象(仅支持map和struct条件)
db.FirstOrInit(&user, User{Name:"non_existing"})
db.where(&User{Name:"non_existing"}).First(&user)
4.4 更新数据
更新 | GORM - The fantastic ORM library for Golang, aims to be developer friendly.
Save
默认更新所有字段,即使只想更新user结构体的name和age字段
user.Name = "qimi" user.Age = 99 db.Save(&user)
Update
更新单个字段(属性)
只更新你选择的字段
func TestUpdate() { //save----无论如何都更新,所有的内容,包括0值 //update----只更新你选择的字段 //updates----更新所有字段,此时有两种形式,一种为Map,一种为结构体,结构体零值不参与更新 var user TestUser //var userInfo []UserInfo GLOBAL_DB.Model(user).Where("name IS NOT NULL").Update("name", "ekin") }
Updates
更新指定的多个字段,此时有两种形式,一种为Map,一种为结构体,结构体零值不参与更新
// 更新单个属性,如果它有变化 db.Model(&user).Update("name", "hello") //// UPDATE users SET name='hello', updated_at='2013-11-17 21:34:10' WHERE id=111; // 根据给定的条件更新单个属性 db.Model(&user).Where("active = ?", true).Update("name", "hello") //// UPDATE users SET name='hello', updated_at='2013-11-17 21:34:10' WHERE id=111 AND active=true; // 使用 map 更新多个属性,只会更新其中有变化的属性 db.Model(&user).Updates(map[string]interface{}{"name": "hello", "age": 18, "active": false}) //// UPDATE users SET name='hello', age=18, active=false, updated_at='2013-11-17 21:34:10' WHERE id=111; // 使用 struct 更新多个属性,只会更新其中有变化且为非零值的字段 db.Model(&user).Updates(User{Name: "hello", Age: 18}) //// UPDATE users SET name='hello', age=18, updated_at = '2013-11-17 21:34:10' WHERE id = 111; // 警告:当使用 struct 更新时,GORM只会更新那些非零值的字段 // 对于下面的操作,不会发生任何更新,"", 0, false 都是其类型的零值 db.Model(&user).Updates(User{Name: "", Age: 0, Active: false})
更新选定字段
如果想更新或忽略某些字段,可以使用
Select
,Omit
db.Model(&user).Select("name").Updates(map[string]interface{}{"name": "hello", "age": 18, "active": false}) //// UPDATE users SET name='hello', updated_at='2013-11-17 21:34:10' WHERE id=111; db.Model(&user).Omit("name").Updates(map[string]interface{}{"name": "hello", "age": 18, "active": false}) //// UPDATE users SET age=18, active=false, updated_at='2013-11-17 21:34:10' WHERE id=111;
无Hooks更新
这个指的是gorm默认会带几个钩子函数,比如上面的更新操作,会自动运行model的BeforeUpdate,AfterUpdate方法,更新UpdatedAt时间戳,如果不想调用这些方法,可以使用UpdateColumn,UpdateColumns
// 更新单个属性,类似于 `Update` db.Model(&user).UpdateColumn("name", "hello") //// UPDATE users SET name='hello' WHERE id = 111; // 更新多个属性,类似于 `Updates` db.Model(&user).UpdateColumns(User{Name: "hello", Age: 18}) //// UPDATE users SET name='hello', age=18 WHERE id = 111;
SQL表达式更新
db.Model(&user).Update("age", gorm.Expr("age * ? + ?", 2, 100)) //// UPDATE `users` SET `age` = age * 2 + 100, `updated_at` = '2020-02-16 13:10:20' WHERE `users`.`id` = 1;
4.5 删除数据
删除 | GORM - The fantastic ORM library for Golang, aims to be developer friendly.
警告
删除记录时,请确保主键字段有值,gorm会通过主键去删除记录,如果主键为空,gorm会删除该model的所有记录。
删除记录
db.Delete(&email)
批量删除
db.Where("email LIKE ?", "%jinzhu%").Delete(&Email{}) db.Delete(&Email{}, "email LIKE ?", "%jinzhu%")
软删除
db.Delete(&user) //// UPDATE users SET deleted_at="2013-10-29 10:23" WHERE id = 111; // 批量删除 db.Where("age = ?", 20).Delete(&user) //// UPDATE users SET deleted_at="2013-10-29 10:23" WHERE age = 20; // 查询记录时会忽略被软删除的记录 db.Where("age = 20").Find(&user) //// SELECT * FROM users WHERE age = 20 AND deleted_at IS NULL; // Unscoped 方法可以查询被软删除的记录 db.Unscoped().Where("age = 20").Find(&users) //// SELECT * FROM users WHERE age = 20;
不加unscope的查询,会有deleted_at IS NULL这个条件。
硬删除
// Unscoped 方法可以物理删除记录 db.Unscoped().Delete(&order) //// DELETE FROM orders WHERE id=10;
可见软删除实际上是更新操作,更新记录的DeletedAt字段,DeletedAt是默认为null的,查询记录时根据DeletedAt字段会忽略被软删除的记录。
增删改查除了增之外,都是要先查,查完之后再进行删除和更新的操作。
如果表中没有DeletedAt字段,那么就没有默认软删除。
4.6 原生SQL
GLOBAL_DB.Raw("select * from test_user where name = ?", 6666).Scan(&userSlice)
4.7 错误处理
通过db.Error属性判断查询结果是否出错, Error属性不等于nil表示有错误发生。
if err := db.Take(&food).Error; err != nil {
fmt.Println("查询失败", err)
}
5. 一对一、多对多、一对多关系的增删改查
5.1 一对一
Belongs To | GORM - The fantastic ORM library for Golang, aims to be developer friendly.
type User struct {
gorm.Model
Name string
CompanyID int
Company Company
}
type Company struct {
ID int
Name string
}
GLOBAL_DB.Model(&g).Association("Dog").Append()//Append() Replace() Clear()
// Model中的参数作为主体
// Association中的参数为关联的结构体
// 后面的Append() Replace() Clear()则为添加、替换、清除关联的结构体
事务操作
type TMG struct { ID uint Name string } func TestTransaction() { GLOBAL_DB.Transaction(test) } func test(tx *gorm.DB) error { GLOBAL_DB.AutoMigrate(&TMG{}) tmg := new(TMG) tmg.Name = "111" tmg1 := new(TMG) tmg1.Name = "222" tmg2 := new(TMG) tmg2.Name = "333" tmgSlice := []*TMG{tmg, tmg1, tmg2} tx.Create(tmgSlice) return nil }
如果test这个函数返回的error不为nil,说明这个事务出现了错误,那么所有操作都会回滚,这是体现了事务的一致性。
所以这个函数一定要有error返回值。
事务还可以嵌套。
手动创建事务
tx := GLOBAL_DB.BEGIN() // ... // ... // ... if (...) { tx.Rollback() } tx.Commit()
可以记录回滚点,并且通过Rollback,回滚到指定的回滚点。
tx := GLOBAL_DB.BEGIN() // ... // ... // ... tx.SavePoint("p") //... tx.RollbackTo("p") tx.Commit()
自定义数据类型
自定义数据类型 | GORM - The fantastic ORM library for Golang, aims to be developer friendly.