这是我参与「第三届青训营 -后端场」笔记创作活动的的第4篇笔记

学习了gorm的一些基本增删改查的方法，记录了下载分享给大家

插入记录

// 模型
type User struct {
 gorm.Model
 Name string
 Age int
 Birthday time.Time
}
user := User{
    Name:     "Lee",
    Age:      18,
    Birthday: time.Now(),
}

result := db.Create(&user)        // 通过数据的指针来创建
id := user.ID               // 返回插入数据的主键
rowsAffected := result.RowsAffected    // 返回插入记录的条数
fmt.Println(id, rowsAffected)

根据给出字段插入数据

db.Select("Name", "Age", "CreatedAt").Create(&user)
// 仅插入"Name", "Age", "CreatedAt"三个字段
// INSERT INTO `users` (`name`,`age`,`created_at`) VALUES ("jinzhu", 18, now())

插入数据时忽略字段

db.Omit("Name", "Age", "CreatedAt").Create(&user)
// 插入时忽略"Name", "Age", "CreatedAt"三个字段
// INSERT INTO `users` (`birthday`,`updated_at`) VALUES ("2020-01-01 00:00:00.000", "2020-07-04 11:05:21.775")

批量插入

要有效地插入大量记录，将一个 slice 传递给 Create 方法。 GORM 将生成单独一条SQL语句来插入所有数据，并回填主键的值，钩子方法也会被调用。

var userList = []User{{Name: "Lee1", Age: 18},{Name: "Lee2", Age: 19},{Name: "Lee3", Age: 20}}
db.Create(userList)

使用 CreateInBatches 分批创建时，可以指定每批的数量，例如：

var userList = []User{{Name: "Lee1", Age: 18},{Name: "Lee2", Age: 19},{Name: "Lee3", Age: 20}}
// 指定批量插入每次10条
db.CreateInBatches(userList, 10)

根据 Map 插入

GORM 支持根据 map[string]interface{} 和 []map[string]interface{}{} 创建记录，使用Map时createAt，updateAt不会自动插入当前时间

// 插入数据
db.Model(&User{}).Create(map[string]interface{}{
    "Name":"Jack",
    "Age":23,
})
// 批量插入
db.Model(&User{}).Create([]map[string]interface{}{
    {"Name":"Jack001", "Age":30},
    {"Name":"Jack002", "Age":31},
    {"Name":"Jack003", "Age":32},
})

查询数据

First和Last

First 和 Last 会根据主键排序，分别查询第一条和最后一条记录。 只有在目标 struct 是指针或者通过 db.Model() 指定 model 时，该方法才有效。 此外，如果相关 model 没有定义主键，那么将按 model 的第一个字段进行排序。

var user User
// 获取主键升序第一条记录 =》 SELECT * FROM users ORDER BY id LIMIT 1;
db.First(&user)
// 获取主键升序最后一条记录 =》 SELECT * FROM users ORDER BY id DESC LIMIT 1;
db.Last(&user)
// 获取未排序第一条记录 =》 SELECT * FROM users LIMIT 1;
db.Take(&user)
fmt.Println(user)

// 有效，因为目标 struct 是指针
db.First(&user)
// SELECT * FROM `users` ORDER BY `users`.`id` LIMIT 1

// 有效，因为通过 `db.Model()` 指定了 model
result := map[string]interface{}{}
db.Model(&User{}).First(&result)
// SELECT * FROM `users` ORDER BY `users`.`id` LIMIT 1

// 无效，First和Last必须通过指针或db.Model才有效
result := map[string]interface{}{}
db.Table("users").First(&result)

// 配合 Take 有效
result := map[string]interface{}{}
db.Table("t_user").Take(&result)

主键检索

var user User
var users []User

db.First(&user, 10)
// SELECT * FROM users WHERE id = 10;

db.First(&user, "10")
// SELECT * FROM users WHERE id = 10;

db.Find(&users, []int{4,5,6})
// SELECT * FROM users WHERE id IN (1,2,3);

// 如果主键是字符串（例如像 uuid），查询将被写成这样
db.First(&user, "id = ?", "1b74413f-f3b8-409f-ac47-e8c062e3472a")
// SELECT * FROM users WHERE id = "1b74413f-f3b8-409f-ac47-e8c062e3472a";

检索全部

// 获取全部记录
result := db.Find(&user)
// SELECT * FROM user;

String条件

// 获取第一条匹配的记录
db.Where("name = ?", "jinzhu").First(&user)
// SELECT * FROM users WHERE name = 'jinzhu' ORDER BY id LIMIT 1;

// 获取全部匹配的记录
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';

Struct & 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;

// 主键切片条件
db.Where([]int64{20, 21, 22}).Find(&users)
// SELECT * FROM users WHERE id IN (20, 21, 22);

注意 当使用结构作为条件查询时，GORM 只会查询非零值字段。这意味着如果字段值为 0、''、false 或其他 零值，该字段不会被用于构建查询条件，例如：

db.Where(&User{Name: "jinzhu", Age: 0}).Find(&users)
// SELECT * FROM users WHERE name = "jinzhu";

如果想要包含零值查询条件，你可以使用 map，其会包含所有 key-value 的查询条件，例如：

db.Where(map[string]interface{}{"Name": "jinzhu", "Age": 0}).Find(&users)
// SELECT * FROM users WHERE name = "jinzhu" AND age = 0;

指定结构体查询字段

当使用 struct 进行查询时，你可以通过向 Where() 传入 struct 来指定查询条件的字段、值、表名，例如：

db.Where(&User{Name: "jinzhu"}, "name", "Age").Find(&users)
// SELECT * FROM users WHERE name = "jinzhu" AND age = 0;

db.Where(&User{Name: "jinzhu"}, "Age").Find(&users)
// SELECT * FROM users WHERE age = 0;

db.Where(&User{Name: "jinzhu", Age:23}, "name", "Age").Find(&users)
// SELECT * FROM users WHERE name="jinzhu" and age = 0;

内联条件

查询条件也可以被内联到 First 和 Find 之类的方法中，其用法类似于 Where。

// 根据主键获取记录，如果是非整型主键
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;

Not条件

db.Not("name = ?", "jinzhu").First(&user)
// SELECT * FROM users WHERE NOT name = "jinzhu" ORDER BY id LIMIT 1;

// Not In
db.Not(map[string]interface{}{"name": []string{"jinzhu", "jinzhu 2"}}).Find(&users)
// SELECT * FROM users WHERE name NOT IN ("jinzhu", "jinzhu 2");

// Struct
db.Not(User{Name: "jinzhu", Age: 18}).First(&user)
// SELECT * FROM users WHERE name <> "jinzhu" AND age <> 18 ORDER BY id LIMIT 1;

// 不在主键切片中的记录
db.Not([]int64{1,2,3}).First(&user)
// SELECT * FROM users WHERE id NOT IN (1,2,3) ORDER BY id LIMIT 1;

Or条件

db.Where("role = ?", "admin").Or("role = ?", "super_admin").Find(&users)
// SELECT * FROM users WHERE role = 'admin' OR role = 'super_admin';

// Struct
db.Where("name = 'jinzhu'").Or(User{Name: "jinzhu 2", Age: 18}).Find(&users)
// SELECT * FROM users WHERE name = 'jinzhu' OR (name = 'jinzhu 2' AND age = 18);

// Map
db.Where("name = 'jinzhu'").Or(map[string]interface{}{"name": "jinzhu 2", "age": 18}).Find(&users)
// SELECT * FROM users WHERE name = 'jinzhu' OR (name = 'jinzhu 2' AND age = 18);

Order条件

db.Order("age desc, name").Find(&users)
// SELECT * FROM users ORDER BY age desc, name;

// Multiple orders
db.Order("age desc").Order("name").Find(&users)
// SELECT * FROM users ORDER BY age desc, name;

Limit和Offset

当Limit和Offset中填-1时，表示消除条件，和没有写这个条件一样

db.Limit(3).Find(&users)
// SELECT * FROM users LIMIT 3;

db.Limit(10).Offset(5).Find(&users)
// SELECT * FROM users OFFSET 5 LIMIT 10;

Group和Having

type result struct {
  Date  time.Time
  Total int
}

db.Model(&User{}).Select("name, sum(age) as total").Where("name LIKE ?", "group%").Group("name").First(&result)
// SELECT name, sum(age) as total FROM `users` WHERE name LIKE "group%" GROUP BY `name`

db.Model(&User{}).Select("name, sum(age) as total").Group("name").Having("name = ?", "group").Find(&result)
// SELECT name, sum(age) as total FROM `users` GROUP BY `name` HAVING name = "group"

Distinct

db.Distinct("name").Order("name desc").Find(&results)
// SELECT DISTINCT name FROM `users` ORDER BY `name` DESC

高级查询

智能选择字段

GORM 允许通过 Select方法选择特定的字段，如果您在应用程序中经常使用此功能，你也可以定义一个较小的结构体，以实现调用 API 时自动选择特定的字段

// User结构体总共有7个字段
type User struct {
 gorm.Model
 Name string
 Age int
 Birthday time.Time
}
// 可以定义一个接受结果的结构体，只接受Name和Age字段
type UserInfo struct{
    Name string
 Age int
}
var userInfo UserInfo
db.Model(&User{}).Select("name, age").First(&userInfo)
fmt.Println(userInfo)

// 输出结果：{Lee 18}

更新

Save

Save 会保存所有的字段，即使字段是零值

// 先查询
db.First(&user)
// 再修改
user.Name = "Jerry"
user.Age = 0
// 最后更新
db.Save(&user)

Update

当使用 Update 更新单个列时，你需要指定条件，否则会返回 ErrMissingWhereClause 错误。当使用了 Model 方法，且该对象主键有值，该值会被用于构建条件。

db.Model(&User{}).Where("name = ?", "Jerry").Update("age", "18").Update("name", "Mike")
// UPDATE users SET name='Mike', age = 18 WHERE name='Jerry';

// 先查询出user，user的id为3
db.First(&user)
// 使用了Model方法则根据user的主键为条件进行更新
db.Model(&user).Update("name", "Jack")
// UPDATE users SET name = 'Jack' WHERE id = 3

// 根据条件和 model 两个的条件进行更新
db.Model(&user).Where("name", 'Jack').Update("name", "Jerry")
// UPDATE users SET name = 'Jerry' WHERE id=3 AND name = Jack;

Updates

Updates 方法支持 struct 和 map[string]interface{} 参数。当使用 struct 更新时，默认情况下，GORM 只会更新非零值的字段

// 先查询出user，user的id为3
db.First(&user)
// 使用结构体只会更新非零字段
db.Model(&user).Updates(User{Name: "", Age: 25})
// UPDATE users SET age = 25 WHERE id = 3

// 使用map会更新为零字段
db.Model(&user).Updates(map[string]interface{}{"name":"", "age":25})
// UPDATE users SET name = '', age = 25 WHERE id = 3

更新选定字段

如果想要在更新时选定、忽略某些字段，可以使用 Select、Omit

// 先查询出user，user的id为3
db.First(&user)

// 只更新name字段
db.Model(&user).Select("name").Updates(User{Name: "Java", Age: 30})
// UPDATE users SET name = 'Java' WHERE id = 3

// 忽略name字段，只更新age字段
db.Model(&user).Omit("name").Updates(User{Name: "Java", Age: 30})
// UPDATE users SET age = 30 WHERE id = 3

// 使用 Struct 进行 Select（会 select 零值的字段）
db.Model(&user).Select("name", "age").Updates(User{Name: "Java", Age: 0})
// UPDATE users SET name = 'Java', age = 0 WHERE id=3

// 更新除Role之外的所有字段
db.Model(&user).Select("*").Omit("Role").Update(User{Name: "Java", Role: "admin", Age: 0})
// UPDATA users SET name = 'Java', age = 0 where id = 3

删除

删除一条记录

GORM中删除记录时，使用的都是逻辑删除，都是更新delete_at字段，通过delete_at字段是否为空判断当前记录是否删除。删除一条记录时需要指定主键，否则会触发批量删除。

// 先查询出user，id = 3
db.First(&user)
// 删除id为 3 的记录，删除之后数据库还有这条记录，只是 delete_at 字段更新了删除时间
db.Delete(&users)
// DELETE from emails where id = 10;

// 带额外条件的删除
db.Where("name = ?", "Jack").Delete(&user)
// DELETE from emails where id = 3 AND name = "Jack";

使用主键

GORM 允许通过主键(可以是复合主键)和内联条件来删除对象。

db.Delete(&User{}, 10)
// DELETE FROM users WHERE id = 10;

db.Delete(&User{}, "10")
// DELETE FROM users WHERE id = 10;

db.Delete(&users, []int{1,2,3})
// DELETE FROM users WHERE id IN (1,2,3);

批量删除

db.Where("name like ?", "%Mike%").Delete(&User{})
// DELETE FROM users WHERE name LIKE '%Mike%''
db.Delete(&User{}, "age < ?", 20)
// DELETE FROM users WHERE age < 20

软删除

// 使用 Unscoped 方法查找软删除记录
db.Unscoped().Where("age = 20").Find(&user)
// SELECT * FROM users WHERE age = 20;

// 使用 Unscoped 方法永久删除记录
db.Unscoped().Delete(&user)
// DELETE FROM orders WHERE id=10;

原生SQL

使用原生SQL增删改查可以使用Raw方法和Scan方法

db.Raw("select id, name, age from t_user where id > ?", 6).Scan(&user)
var name []string
db.Raw("select name from t_user where name like ?", "%M%").Scan(&name)

使用Exec方法

db.Exec("DROP TABLE users")
db.Exec("UPDATE orders SET shipped_at = ? WHERE id IN ?", time.Now(), []int64{1, 2, 3})

// Exec with SQL Expression
db.Exec("UPDATE users SET money = ? WHERE name = ?", gorm.Expr("money * ? + ?", 10000, 1), "jinzhu")