Golang

GORM框架初识

gorm介绍

安装

1

go get -u github.com/jinzhu/gorm

连接数据库

连接不同的数据库都需要导入对应数据的驱动程序，GORM已经贴心的包装了一些驱动程序，只需要按如下方式导入需要的数据库驱动即可：

1
2
3
4

import _ "github.com/jinzhu/gorm/dialects/mysql"
// import _ "github.com/jinzhu/gorm/dialects/postgres"
// import _ "github.com/jinzhu/gorm/dialects/sqlite"
// import _ "github.com/jinzhu/gorm/dialects/mssql"

连接MySQL（db最好定义为全局变量）

db定义为全局变量的原因首先是避免重复生成新的连接，并且db本身就代表orm的一个连接池句柄了，其他地方可以直接通过db. 来操作数据库 [redigo中通过初始化连接池然后Get()获取池里面的连接，这里db就是一个连接池，调用db的方法默认会从池中抽取一个连接来使用，使用完默认自动放回去] ，所以在定义全局的db后最好不要再close()掉db了，让它随程序的存在而存在，程序停止则池子停止。

db连接池默认空闲数好像是5，可以通过DB().SetMaxIdleConns()来设置最大空闲数，通过SetMaxOpenConns()设置最大连接数。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10

import (
  "github.com/jinzhu/gorm"
  _ "github.com/jinzhu/gorm/dialects/mysql"
)

func main() {
//parseTime 将数据中包含时间类型的解析成数据库时间类型
  db, err := gorm.Open("mysql", "user:password@(localhost:port)/dbname?charset=utf8mb4&parseTime=True")
//defer db.Close()
}

连接PostgreSQL

基本代码同上，注意引入对应 postgres驱动并正确指定 gorm.Open()参数。

1
2
3
4
5
6
7
8
9

import (
  "github.com/jinzhu/gorm"
  _ "github.com/jinzhu/gorm/dialects/postgres"
)

func main() {
  db, err := gorm.Open("postgres", "host=myhost port=myport user=gorm dbname=gorm password=mypassword")
  defer db.Close()
}

连接Sqlite3

基本代码同上，注意引入对应 sqlite驱动并正确指定 gorm.Open()参数。

1
2
3
4
5
6
7
8
9

import (
  "github.com/jinzhu/gorm"
  _ "github.com/jinzhu/gorm/dialects/sqlite"
)

func main() {
  db, err := gorm.Open("sqlite3", "/tmp/gorm.db")
  defer db.Close()
}

连接SQL Server

基本代码同上，注意引入对应 mssql驱动并正确指定 gorm.Open()参数。

1
2
3
4
5
6
7
8
9

import (
  "github.com/jinzhu/gorm"
  _ "github.com/jinzhu/gorm/dialects/mssql"
)

func main() {
  db, err := gorm.Open("mssql", "sqlserver://username:password@localhost:1433?database=dbname")
  defer db.Close()
}

GORM基本示例

GORM操作MySQL

使用GORM连接上面的 db1进行创建、查询、更新、删除操作。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57

package main

import (
	"fmt"
	"github.com/jinzhu/gorm"
	_ "github.com/jinzhu/gorm/dialects/mysql"
)

// UserInfo 用户信息
type UserInfo struct {
	ID uint
	Name string
	Gender string
	Hobby string
}

var db *gorm.DB

func initMysql()(err error){
	db, err = gorm.Open("mysql", "user:password@(localhost:port)/dbname?charset=utf8mb4&parseTime=True")
	if err != nil {
		return err
	}
	return err
}

func main() {
	err := initMysql()
	if err != nil {
		panic(err)
	}
	defer db.Close()

	//结构体名和成员名必须大写，否则在AutoMigrate函数中无法对其成员值进行修改
	//自动创建数据库表（它会将结构体和数据库表进行对应，对名称进行解析，两个单词之间用下划线分割，且加上复数，即user_infos）
	//此方法对给定的模型进行自动迁移，只会添加缺失的字段，不会删除/更改当前数据，当表存在也添加此方法，将结构体与数据库中的表进行关联,结构体与表不对应则会添加字段
	db.AutoMigrate(&UserInfo{})

	//添加数据, mysql无法添加切片类型数据
	//结构体对象比较大，建议传指针
	u:=UserInfo{Id:1,Name: "笑傩",Gender: "男",Hobby: "篮球"}
	db.Create(&u)
	//查询数据
	u:=UserInfo{Id: 1}
	db.Find(&u)

	var uu UserInfo
	//根据条件查询
	db.Find(&uu, "hobby=?", "足球")
	fmt.Printf("%#v\n", uu)

	//更新数据
	db.Model(&u).Update("hobby=?","足球")
	fmt.Println(u)
	////删除数据
	db.Delete(&u)
}

要注意的是db.AutoMigrate()用于与数据库表进行同步，如果不需要同步，仅仅是绑定的话，可以使用 db.Model(&User{})，Model 指定你想运行db操作的模型，它不会因为结构体的新增改变数据库结构，仅绑定。

GORM Model定义

在使用ORM工具时，通常我们需要在代码中定义模型（Models）与数据库中的数据表进行映射，在GORM中模型（Models）通常是正常定义的结构体、基本的go类型或它们的指针。 同时也支持 sql.Scanner及 driver.Valuer接口（interfaces）。

gorm.Model

为了方便模型定义，GORM内置了一个 gorm.Model结构体。gorm.Model是一个包含了 ID, CreatedAt, UpdatedAt, DeletedAt四个字段的Golang结构体。

1
2
3
4
5
6
7

// gorm.Model 定义
type Model struct {
  ID        uint `gorm:"primary_key"`
  CreatedAt time.Time
  UpdatedAt time.Time
  DeletedAt *time.Time
}

可以将它嵌入到自己设置的模型中：

1
2
3
4
5

// 将 `ID`, `CreatedAt`, `UpdatedAt`, `DeletedAt`字段注入到`User`模型中
type User struct {
  gorm.Model
  Name string
}

当然也可以完全自己定义模型：

1
2
3
4
5

// 不使用gorm.Model，自行定义模型
type User struct {
  ID   int
  Name string
}

模型定义示例

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14

type User struct {
	gorm.Model
	Name string
	Age sql.NullInt64	//零值类型
	Birthday *time.Time
	Email string `gorm:"type:varchar(100);unique_index"`	//type设置字段类型。unique_index 建立一个唯一的索引
	Role string	`gorm:"size:255"`	//设置字段大小为255
	//默认情况下，所有字段的零值, 比如 0, '', false 或者其它 零值，都不会保存到数据库内，使用指针可以避免这种情况。
	//例如我给某字段赋予一个默认的零值，此时这个值并不会保存到数据库，而是使用数据库设定的默认值。当使用指针时，指针是一个十六位数，可以顺利存进去
	MemberNumber *string `gorm:"unique;not null"`	//设置会员号唯一并且不能为空
	Num int `gorm:"AUTO_INCREMENT"`		//设置num为自增类型
	Address string	`gorm:"index:addr"` 	//给address字段创建名为addr的索引
	IgnoreMe 	int `gorm:"-"`	//忽略本字段，即该字段不会体现在数据库中
}

结构体标记（tags）

使用结构体声明模型时，标记（tags）是可选项。gorm支持以下标记:

支持的结构体标记（Struct tags）

image.png

关联相关标记（tags）

image.png

主键、表名、列名的约定

主键（Primary Key）

GORM 默认会使用名为ID的字段作为表的主键。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11

type User struct {
  ID   string // 名为`ID`的字段会默认作为表的主键
  Name string
}

// 使用`AnimalID`作为主键
type Animal struct {
  AnimalID int64 `gorm:"primary_key"`
  Name     string
  Age      int64
}

表名（Table Name）

表名默认就是结构体名称的复数，例如：

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18

type User struct {} // 默认表名是 `users`

// 将 User 的表名设置为 `profiles`
func (User) TableName() string {
  return "profiles"
}

// 也可以在设置表名时进行判断
func (u User) TableName() string {
  if u.Role == "admin" {
    return "admin_users"
  } else {
    return "users"
  }
}

// 禁用默认表名的复数形式，如果置为 true，则 `User` 的默认表名是 `user`
db.SingularTable(true)

也可以通过 Table()指定表名：

1
2
3
4
5
6
7
8
9

// 使用User结构体创建名为`deleted_users`的表
db.Table("deleted_users").CreateTable(&User{})

var deleted_users []User
db.Table("deleted_users").Find(&deleted_users)
//// SELECT * FROM deleted_users;

db.Table("deleted_users").Where("name = ?", "jinzhu").Delete()
//// DELETE FROM deleted_users WHERE name = 'jinzhu';

GORM还支持更改默认表名称规则：

1
2
3
4

//每次执行创建语句之前会执行此函数，在每个表之前增加前缀
gorm.DefaultTableNameHandler = func (db *gorm.DB, defaultTableName string) string  {
  return "prefix_" + defaultTableName;
}

列名（Column Name）

列名由字段名称进行下划线分割来生成

1
2
3
4
5
6

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`
}

可以使用结构体tag指定列名：

1
2
3
4
5

type Animal struct {
  AnimalId    int64     `gorm:"column:beast_id"`         // set column name to `beast_id`
  Birthday    time.Time `gorm:"column:day_of_the_beast"` // set column name to `day_of_the_beast`
  Age         int64     `gorm:"column:age_of_the_beast"` // set column name to `age_of_the_beast`
}

时间戳跟踪

CreatedAt

如果模型有 CreatedAt字段，该字段的值将会是初次创建记录的时间。

1
2
3
4

db.Create(&user) // `CreatedAt`将会是当前时间

// 可以使用`Update`方法来改变`CreateAt`的值
db.Model(&user).Update("CreatedAt", time.Now())

UpdatedAt

如果模型有 UpdatedAt字段，该字段的值将会是每次更新记录的时间。

1
2
3

db.Save(&user) // `UpdatedAt`将会是当前时间

db.Model(&user).Update("name", "jinzhu") // `UpdatedAt`将会是当前时间

DeletedAt

如果模型有 DeletedAt字段，调用 Delete删除该记录时，将会设置 DeletedAt字段为当前时间，而不是直接将记录从数据库中删除（软删除）。删除后，无论查询还是修改都无法查询到该行数据了

CRUD

创建

创建记录

首先定义模型：

1
2
3
4
5

type User struct {
	ID           int64
	Name         string
	Age          int64
}

使用使用 NewRecord()查询主键是否存在，主键为空使用 Create()创建记录：

1
2
3
4

	u:=User{Name: "笑傩",Age: 18}
	fmt.Println(db.NewRecord(&u))	//如果自己设置主键的值，此方法是判断是否存在相同的主键值,不存在则返回true
	db.Create(&u)
	fmt.Println(db.NewRecord(&u))	//这个fmt返回的是false，因为当创建后，u实例获取到了数据库中ID的值，此值在数据库中存在，所以返回false

成员首字母一定要大写，不然无法创建对应的字段！！

默认值

可以通过 tag 定义字段的默认值，比如：

1
2
3
4
5

type User struct {
  ID   int64
  Name string `gorm:"default:'小王子'"`
  Age  int64
}

注意：通过tag定义字段的默认值，在创建记录时候生成的 SQL 语句会排除没有值或值为 零值 的字段(即insert时不设置字段为对应的零值，取决于数据库设置的默认值)。 在将记录插入到数据库后，Gorm会从数据库加载那些字段的默认值。（tag一定要在第一次建表时就设置好，因为当表建好后再设置默认值是无效的，数据库此时对应字段已经设置为了默认的NULL，它无法进行自动迁移）

举个例子：

1
2
3

var user = User{Name:"",Age: 18}
db.Debug().Create(&user)	//Debug()：在进行增删改查操作时会在终端打印出操作语句
//INSERT INTO `users` (`age`) VALUES (18)

上面代码实际执行的SQL语句是 INSERT INTO users("age") values('99');，排除了零值字段 Name，而在数据库中这一条数据会使用tag设置的默认值作为Name字段的值。

**注意：**所有字段的零值, 比如 0, "",false或者其它 零值，都不会保存到数据库内，但会使用他们数据库中的默认值。 如果你想避免这种情况，可以考虑使用指针或实现 Scanner/Valuer接口，比如：

使用指针方式实现零值存入数据库

1
2
3
4
5
6
7
8

// 使用指针
type User struct {
  ID   int64
  Name *string `gorm:"default:'笑傩'"`
  Age  int64
}
user := User{Name: new(string), Age: 18))}
db.Create(&user)  // 此时数据库中该条记录name字段的值就是''

使用Scanner/Valuer接口方式实现零值存入数据库

1
2
3
4
5
6
7
8

// 使用 Scanner/Valuer
type User struct {
	ID int64
	Name sql.NullString `gorm:"default:'笑傩'"` // sql.NullString 实现了Scanner/Valuer接口
	Age  int64
}
user := User{Name: sql.NullString{"", true}, Age:18}
db.Create(&user)  // 此时数据库中该条记录name字段的值就是''

扩展创建选项

例如 PostgreSQL数据库中可以使用下面的方式实现合并插入, 有则更新, 无则插入。只针对PostgreSQL

1
2
3

// 为Instert语句添加扩展SQL选项
db.Set("gorm:insert_option", "ON CONFLICT").Create(&product)
// INSERT INTO products (name, code) VALUES ("name", "code") ON CONFLICT;

查询

一般查询

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15

// 根据主键查询第一条记录，仅当主键为整型时可用
db.First(&user)
//// SELECT * FROM users ORDER BY userId LIMIT 1;

// 随机获取一条记录
db.Take(&user)
//// SELECT * FROM users LIMIT 1;

// 根据主键查询最后一条记录
db.Last(&user)
//// SELECT * FROM users ORDER BY id DESC LIMIT 1;

// 查询所有的记录，users是一个切片，用切片承载查询出来的结果
db.Find(&users)
//// SELECT * FROM users;

Where 条件

普通SQL查询

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31

// Get first matched record
db.Where("name = ?", "jinzhu").First(&user)
//// SELECT * FROM users WHERE name = 'jinzhu' limit 1;

// Get all matched records
db.Where("name = ?", "jinzhu").Find(&users)
//// SELECT * FROM users WHERE name = 'jinzhu';

// <>
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查询

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11

// Struct
db.Where(&User{Name: "jinzhu", Age: 20}).First(&user)
//// SELECT * FROM users WHERE name = "jinzhu" AND age = 20 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或者其他 零值时，将不会被用于构建查询条件，例如：

1
2

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

你可以使用指针或实现 Scanner/Valuer 接口来避免这个问题.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13

// 使用指针
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 接口
}

Not 条件（不等于）

作用与 Where 类似的情形如下：

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21

db.Not("name", "jinzhu").First(&user)
//// SELECT * FROM users WHERE name <> "jinzhu" LIMIT 1;

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

// Not In slice of primary keys
db.Not([]int64{1,2,3}).First(&user)
//// SELECT * FROM users WHERE id NOT IN (1,2,3);

db.Not([]int64{}).First(&user)
//// SELECT * FROM users;

// Plain SQL
db.Not("name = ?", "jinzhu").First(&user)
//// SELECT * FROM users WHERE NOT(name = "jinzhu");

// Struct
db.Not(User{Name: "jinzhu"}).First(&user)
//// SELECT * FROM users WHERE name <> "jinzhu";

Or条件

 1
 2
 3
 4
 5
 6
 7
 8
 9
10

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"}).Find(&users)
//// SELECT * FROM users WHERE name = 'jinzhu' OR name = 'jinzhu 2';

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

内联条件(在立即执行方法中添加条件，而不是使用where)

作用与 Where查询类似，当内联条件与多个立即执行方法一起使用时, 内联条件不会传递给后面的立即执行方法（即只有当前立即执行方法可以使用，后面的立即执行方法是无法复用当前方法的内联条件的）。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21

// 根据主键获取记录 (只适用于整形主键)
db.First(&user, 23)
//// SELECT * FROM users WHERE id = 23 LIMIT 1;
// 根据主键获取记录, 如果它是一个非整形主键
db.First(&user, "id = ?", "string_primary_key")
//// SELECT * FROM users WHERE id = 'string_primary_key' LIMIT 1;

// 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;

额外查询选项

1
2
3

// 为查询 SQL 添加额外的 SQL 操作
db.Set("gorm:query_option", "FOR UPDATE").First(&user, 10)
//// SELECT * FROM users WHERE id = 10 FOR UPDATE;

FirstOrInit

获取匹配的第一条记录，否则根据给定的条件初始化一个新的对象 (仅支持 struct 和 map 条件)（注意：这个仅仅是初始化一个新的实例，并不会入库到数据库，不会入库到数据库！！！）

1
2
3
4
5
6
7
8
9

// 未找到
db.FirstOrInit(&user, User{Name: "non_existing"})
//// user -> User{Name: "non_existing"}

// 找到
db.Where(User{Name: "Jinzhu"}).FirstOrInit(&user)
//// user -> User{Id: 111, Name: "Jinzhu", Age: 20}
db.FirstOrInit(&user, map[string]interface{}{"name": "jinzhu"})
//// user -> User{Id: 111, Name: "Jinzhu", Age: 20}

Attrs

如果记录未找到，将使用参数初始化 struct.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13

// 未找到
db.Where(User{Name: "non_existing"}).Attrs(User{Age: 20}).FirstOrInit(&user)
//// SELECT * FROM USERS WHERE name = 'non_existing';
//// user -> User{Name: "non_existing", Age: 20}

db.Where(User{Name: "non_existing"}).Attrs("age", 20).FirstOrInit(&user)
//// SELECT * FROM USERS WHERE name = 'non_existing';
//// user -> User{Name: "non_existing", Age: 20}

// 找到
db.Where(User{Name: "Jinzhu"}).Attrs(User{Age: 30}).FirstOrInit(&user)
//// SELECT * FROM USERS WHERE name = jinzhu';
//// user -> User{Id: 111, Name: "Jinzhu", Age: 20}

Assign

不管记录是否找到，都将参数赋值给 struct.

1
2
3
4
5
6
7
8

// 未找到
db.Where(User{Name: "non_existing"}).Assign(User{Age: 20}).FirstOrInit(&user)
//// user -> User{Name: "non_existing", Age: 20}

// 找到
db.Where(User{Name: "Jinzhu"}).Assign(User{Age: 30}).FirstOrInit(&user)
//// SELECT * FROM USERS WHERE name = jinzhu';
//// user -> User{Id: 111, Name: "Jinzhu", Age: 30}

FirstOrCreate

获取匹配的第一条记录, 否则根据给定的条件创建一个新的记录 (仅支持 struct 和 map 条件)（要入库到数据库中）

1
2
3
4
5
6
7
8

// 未找到
db.FirstOrCreate(&user, User{Name: "non_existing"})
//// INSERT INTO "users" (name) VALUES ("non_existing");
//// user -> User{Id: 112, Name: "non_existing"}

// 找到
db.Where(User{Name: "Jinzhu"}).FirstOrCreate(&user)
//// user -> User{Id: 111, Name: "Jinzhu"}

Attrs

如果记录未找到，将使用参数创建 struct 和记录.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10

 // 未找到
db.Where(User{Name: "non_existing"}).Attrs(User{Age: 20}).FirstOrCreate(&user)
//// SELECT * FROM users WHERE name = 'non_existing';
//// INSERT INTO "users" (name, age) VALUES ("non_existing", 20);
//// user -> User{Id: 112, Name: "non_existing", Age: 20}

// 找到
db.Where(User{Name: "jinzhu"}).Attrs(User{Age: 30}).FirstOrCreate(&user)
//// SELECT * FROM users WHERE name = 'jinzhu';
//// user -> User{Id: 111, Name: "jinzhu", Age: 20}

Assign

不管记录是否找到，都将参数赋值给 struct 并保存至数据库.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11

// 未找到
db.Where(User{Name: "non_existing"}).Assign(User{Age: 20}).FirstOrCreate(&user)
//// SELECT * FROM users WHERE name = 'non_existing';
//// INSERT INTO "users" (name, age) VALUES ("non_existing", 20);
//// user -> User{Id: 112, Name: "non_existing", Age: 20}

// 找到
db.Where(User{Name: "jinzhu"}).Assign(User{Age: 30}).FirstOrCreate(&user)
//// SELECT * FROM users WHERE name = 'jinzhu';
//// UPDATE users SET age=30 WHERE id = 111;
//// user -> User{Id: 111, Name: "jinzhu", Age: 30}

高级查询

子查询

基于 *gorm.expr 的子查询

1
2

db.Where("amount > ?", db.Table("orders").Select("AVG(amount)").Where("state = ?", "paid")).Find(&orders)
// SELECT * FROM "orders"  WHERE "orders"."deleted_at" IS NULL AND (amount > (SELECT AVG(amount) FROM "orders"  WHERE (state = 'paid')));

选择字段

Select，指定你想从数据库中检索出的字段，默认会选择全部字段。

1
2
3
4
5
6
7
8

db.Select("name, age").Find(&users)
//// SELECT name, age FROM users;

db.Select([]string{"name", "age"}).Find(&users)
//// SELECT name, age FROM users;

db.Table("users").Select("COALESCE(age,?)", 42).Rows()
//// SELECT COALESCE(age,'42') FROM users;

排序

Order，指定从数据库中检索出记录的顺序。设置第二个参数 reorder 为 true ，可以覆盖前面定义的排序条件（不加则是在原来的基础上继续排序）。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11

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

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

// 覆盖排序
db.Order("age desc").Find(&users1).Order("age", true).Find(&users2)
//// SELECT * FROM users ORDER BY age desc; (users1)
//// SELECT * FROM users ORDER BY age; (users2)

数量

Limit，指定从数据库检索出的最大记录数。

1
2
3
4
5
6
7

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

// -1 取消 Limit 条件
db.Limit(10).Find(&users1).Limit(-1).Find(&users2)
//// SELECT * FROM users LIMIT 10; (users1)
//// SELECT * FROM users; (users2)

偏移

Offset，指定开始返回记录前要跳过的记录数。

1
2
3
4
5
6
7

db.Offset(3).Find(&users)
//// SELECT * FROM users OFFSET 3;

// -1 取消 Offset 条件
db.Offset(10).Find(&users1).Offset(-1).Find(&users2)
//// SELECT * FROM users OFFSET 10; (users1)
//// SELECT * FROM users; (users2)

总数

Count，该 model 能获取的记录总数。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13

db.Where("name = ?", "jinzhu").Or("name = ?", "jinzhu 2").Find(&users).Count(&count)
//// SELECT * from USERS WHERE name = 'jinzhu' OR name = 'jinzhu 2'; (users)
//// SELECT count(*) FROM users WHERE name = 'jinzhu' OR name = 'jinzhu 2'; (count)

db.Model(&User{}).Where("name = ?", "jinzhu").Count(&count)
//// SELECT count(*) FROM users WHERE name = 'jinzhu'; (count)

// Table() 指定你要运行db操作的表
db.Table("deleted_users").Count(&count)
//// SELECT count(*) FROM deleted_users;

db.Table("deleted_users").Select("count(distinct(name))").Count(&count)
//// SELECT count( distinct(name) ) FROM deleted_users; (count)

注意 Count 必须是链式查询的最后一个操作 ，因为它会覆盖前面的 SELECT，但如果里面使用了 count 时（在查询语句中）不会覆盖

后端分页

post是文章的结构体，Limit(pageSize)表示每次查询的最大数量

image.png

一对多查询-预加载Preload

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30

//结构体定义
type Admin struct {
	User     []User
	ID       int
	Username string
	AdID     int
}

type User struct {
	UserID  int
	Price   float64
	AdminID int
	Admin   *Admin `gorm:"ForeignKey:UserID;AssociationForeignKey:AdID"`
}

//多表查询
	admin := Admin{ID: 1}
	db.Debug().Preload("User").Find(&admin)

	user := User{UserID: 1}
	db.Debug().Preload("Admin").Find(&user)

//[2021-03-11 22:35:40]  [83.77ms]  SELECT * FROM `admins`  WHERE `admins`.`id` = 1
//[2021-03-11 22:35:40]  [84.80ms]  SELECT * FROM `users`  WHERE (`admin_id` IN (1))

//Preload用于一对多查询，当查询admin表时又需要users表的数据，则可使用此方法，它不需要额外设置tag进行外键关联，但是对字段有要求，Preload方法的参数为另一个结构体的名称[要打双引号]（在admin结构体中所取的名称）。它会先查询admin表，再查询User表进行填充。

//主表的查询字段（主键）必须取名为  ID ，它会根据id查询到admin的数据，然后再查询User结构体所对应表中的数据，查询user表的查询字段是主表  <结构体名_主表查询字段成员名> ，因此user结构体中要设定AdminID成员进行关联

//如果主表的查询字段不为ID时则需要用tag额外定义，来指定外键进行查询 [ `gorm:"ForeignKey:UserID;AssociationForeignKey:AdID"` ]   ForeignKey指向当前结构体的成员名，AssociationForeignKey指向外键结构体的相对应的成员名

嵌套预加载Preload

GORM 支持嵌套预加载，例如：

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23

type Admin struct {
	ID       int
	Username string
	User     []User
}

type User struct {
	ID      int
	Price   float64
	AdminID int
	Student Student
}

type Student struct {
	Sid    int
	Name   string
	UserID int
}
//一定要注意的是嵌套是student有user的键(userid)，user有admin的键(adminid)，层层嵌套出去的

//[2021-03-11 23:45:55]  [83.77ms]  SELECT * FROM `admins`  WHERE `admins`.`id` = 1
//[2021-03-11 23:45:56]  [78.89ms]  SELECT * FROM `users`  WHERE (`admin_id` IN (1))
//[2021-03-11 23:45:56]  [82.81ms]  SELECT * FROM `students`  WHERE (`user_id` IN (1))

Preload在使用更新updates之类时也会同时更新结构体中子结构体的数据

1

INSERT INTO `experts` (`created_at`,`updated_at`,`deleted_at`,`nickname`,`account`,`password`,`id`) VALUES ('2020-03-21 08:10:01','2020-03-20 00:00:00',NULL,'专家谁','admin1','123456',1) ON DUPLICATE KEY UPDATE `id`=`id`

它会使用上述insert代码，且后面会有 ON DUPLICATE KEY UPDATE ,**这部分语句的作用会在新增时主键或外键冲突时更新，不冲突则会新增数据。**因为在value中加入了id，当id冲突时，本来会进行更新，又因为update id=id，即id依然等于1，依然冲突。表明当冲突时不进行更新。

如果想更新主表的同时新增子结构体对应的表，则需要将子结构体的id变为不冲突的id。但是这样子就会出现两条除id外其他数据相同的数据，而如果要进行更新操作，则必须在 ON DUPLICATE KEY UPDATE 后添加需要修改的字段才行，但是gorm并没有这种操作。如果要实现这种操作，可以在修改id的同时也修改子结构体的其他字段值，gorm会新增一条不同数据

1
2
3

[SQL] ON DUPLICATE KEY UPDATE 
id = 5,
password = 'upPassword';

如果想更新主表的同时不更新子结构体的表，则可以将子表进行初始化 obj.Experts = pkg.Experts{}

Group & Having

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24

rows, err := db.Table("orders").Select("date(created_at) as date, sum(amount) as total").Group("date(created_at)").Rows()
for rows.Next() {
  ...
}

// 使用Scan将多条结果扫描进事先准备好的结构体切片中
type Result struct {
	Date time.Time
	Total int
}
var rets []Result
db.Table("users").Select("date(created_at) as date, sum(age) as total").Group("date(created_at)").Scan(&rets)

rows, err := db.Table("orders").Select("date(created_at) as date, sum(amount) as total").Group("date(created_at)").Having("sum(amount) > ?", 100).Rows()
for rows.Next() {
  ...
}

type Result struct {
  Date  time.Time
  Total int64
}
//Having和where类似，但是where是对原始数据进行判断，having是判断经过计算后的数据
db.Table("orders").Select("date(created_at) as date, sum(amount) as total").Group("date(created_at)").Having("sum(amount) > ?", 100).Scan(&results)

连接

Joins，指定连接条件

1
2
3
4
5
6
7
8
9

rows, err := db.Table("users").Select("users.name, emails.email").Joins("left join emails on emails.user_id = users.id").Rows()
for rows.Next() {
  ...
}

db.Table("users").Select("users.name, emails.email").Joins("left join emails on emails.user_id = users.id").Scan(&results)

// 多连接及参数
db.Joins("JOIN emails ON emails.user_id = users.id AND emails.email = ?", "jinzhu@example.org").Joins("JOIN credit_cards ON credit_cards.user_id = users.id").Where("credit_cards.number = ?", "411111111111").Find(&user)

Pluck

Pluck，查询 model 中的一个列作为切片，如果您想要查询多个列，您应该使用 Scan

 1
 2
 3
 4
 5
 6
 7
 8
 9
10

var ages []int64
db.Find(&users).Pluck("age", &ages)

var names []string
db.Model(&User{}).Pluck("name", &names)

db.Table("deleted_users").Pluck("name", &names)

// 想查询多个字段？ 这样做：
db.Select("name, age").Find(&users)

扫描

Scan，扫描结果至一个 struct.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13

type Result struct {
  Name string
  Age  int
}

var result Result
db.Table("users").Select("name, age").Where("name = ?", "Antonio").Scan(&result)

var results []Result
db.Table("users").Select("name, age").Where("id > ?", 0).Scan(&results)

// 原生 SQL
db.Raw("SELECT name, age FROM users WHERE name = ?", "Antonio").Scan(&result)

链式操作相关

链式操作

Method Chaining，Gorm 实现了链式操作接口，所以你可以把代码写成这样：

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14


// 创建一个查询
tx := db.Where("name = ?", "jinzhu")

// 添加更多条件
if someCondition {
  tx = tx.Where("age = ?", 20)
} else {
  tx = tx.Where("age = ?", 30)
}

if yetAnotherCondition {
  tx = tx.Where("active = ?", 1)
}

在调用立即执行方法前不会生成 Query语句，借助这个特性你可以创建一个函数来处理一些通用逻辑。

立即执行方法

Immediate methods ，立即执行方法是指那些会立即生成 SQL语句并发送到数据库的方法, 他们一般是 CRUD方法，比如：

Create, First, Find, Take, Save, UpdateXXX, Delete, Scan, Row, Rows…

这有一个基于上面链式方法代码的立即执行方法的例子：

1

tx.Find(&user)

生成的SQL语句如下：

1

SELECT * FROM users where name = 'jinzhu' AND age = 30 AND active = 1;

范围

Scopes，Scope是建立在链式操作的基础之上的。

基于它，你可以抽取一些通用逻辑，写出更多可重用的函数库。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26

func AmountGreaterThan1000(db *gorm.DB) *gorm.DB {
  return db.Where("amount > ?", 1000)
}

func PaidWithCreditCard(db *gorm.DB) *gorm.DB {
  return db.Where("pay_mode_sign = ?", "C")
}

func PaidWithCod(db *gorm.DB) *gorm.DB {
  return db.Where("pay_mode_sign = ?", "C")
}

func OrderStatus(status []string) func (db *gorm.DB) *gorm.DB {
  return func (db *gorm.DB) *gorm.DB {
    return db.Scopes(AmountGreaterThan1000).Where("status IN (?)", status)
  }
}

db.Scopes(AmountGreaterThan1000, PaidWithCreditCard).Find(&orders)
// 查找所有金额大于 1000 的信用卡订单

db.Scopes(AmountGreaterThan1000, PaidWithCod).Find(&orders)
// 查找所有金额大于 1000 的 COD 订单

db.Scopes(AmountGreaterThan1000, OrderStatus([]string{"paid", "shipped"})).Find(&orders)
// 查找所有金额大于 1000 且已付款或者已发货的订单

多个立即执行方法

Multiple Immediate Methods，在 GORM 中使用多个立即执行方法时，后一个立即执行方法会复用前一个立即执行方法的条件 (不包括内联条件) 。

1

db.Where("name LIKE ?", "jinzhu%").Find(&users, "id IN (?)", []int{1, 2, 3}).Count(&count)

生成的 Sql

1
2
3

SELECT * FROM users WHERE name LIKE 'jinzhu%' AND id IN (1, 2, 3)

SELECT count(*) FROM users WHERE name LIKE 'jinzhu%'

更新

更新所有字段

Save()默认会根据指定的主键值查询并更新该对象的所有字段，即使你没有赋值。

如果save时没有指定主键值，或者根据主键值没有查询到数据，那么更新会变成插入新数据，这个点一定要注意

1
2
3
4
5
6
7
8

db.First(&user)

user.ID = 1
user.Name = "七米"
user.Age = 99
db.Save(&user)

////  UPDATE `users` SET `created_at` = '2020-02-16 12:52:20', `updated_at` = '2020-02-16 12:54:55', `deleted_at` = NULL, `name` = '七米', `age` = 99, `active` = true  WHERE `users`.`deleted_at` IS NULL AND `users`.`id` = 1

更新修改字段

如果你只希望更新指定字段，可以使用 Update(更新单个字段)或者 Updates(更新多个字段)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19

// 更新单个属性，如果它有变化
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

1
2
3
4
5

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更新(指定单一或多个字段更新，不更新钩子函数)

上面的更新操作会自动运行 model 的 BeforeUpdate, AfterUpdate 方法，更新 UpdatedAt 时间戳, 在更新时保存其 Associations, 如果你不想调用这些方法，你可以使用 UpdateColumn， UpdateColumns

1
2
3
4
5
6
7

// 更新单个属性，类似于 `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;

批量更新

批量更新时 Hooks（钩子函数）不会运行。

1
2
3
4
5
6
7
8
9

db.Table("users").Where("id IN (?)", []int{10, 11}).Updates(map[string]interface{}{"name": "hello", "age": 18})
//// UPDATE users SET name='hello', age=18 WHERE id IN (10, 11);

// 使用 struct 更新时，只会更新非零值字段，若想更新所有字段，请使用map[string]interface{}，map可以将零值携带进数据库
db.Model(&User{}).Updates(User{Name: "hello", Age: 18})
//// UPDATE users SET name='hello', age=18;

// 使用 `RowsAffected` 获取当前操作更新影响的行数
db.Model(&User{}).Updates(User{Name: "hello", Age: 18}).RowsAffected

使用SQL表达式更新

先查询表中的第一条数据保存至user变量。

1
2

var user User
db.First(&user)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11

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;

db.Model(&user).Updates(map[string]interface{}{"age": gorm.Expr("age * ? + ?", 2, 100)})
//// UPDATE "users" SET "age" = age * '2' + '100', "updated_at" = '2020-02-16 13:05:51' WHERE `users`.`id` = 1;

db.Model(&user).UpdateColumn("age", gorm.Expr("age - ?", 1))
//// UPDATE "users" SET "age" = age - 1 WHERE "id" = '1';

db.Model(&user).Where("age > 10").UpdateColumn("age", gorm.Expr("age - ?", 1))
//// UPDATE "users" SET "age" = age - 1 WHERE "id" = '1' AND age > 10;

修改Hooks中的值

如果你想修改 BeforeUpdate, BeforeSave 等 Hooks 中更新的值，你可以使用 scope.SetColumn, 例如：

1
2
3
4
5
6
7

//加密明文，用于用户密码设置
func (user *User) BeforeSave(scope *gorm.Scope) (err error) {
//GenerateFromPassword: 将明文密码加密，然后通过SetColumn存入数据库
  if pw, err := bcrypt.GenerateFromPassword(user.Password, 0); err == nil {
    scope.SetColumn("EncryptedPassword", pw)
  }
}

其它更新选项(针对SQL Server)

1
2
3

// 为 update SQL 添加其它的 SQL
db.Model(&user).Set("gorm:update_option", "OPTION (OPTIMIZE FOR UNKNOWN)").Update("name", "hello")
//// UPDATE users SET name='hello', updated_at = '2013-11-17 21:34:10' WHERE id=111 OPTION (OPTIMIZE FOR UNKNOWN);

删除

删除记录（只针对通过ID主键进行删除）

警告 ：删除记录时，请确保主键字段有值，GORM 会通过主键去删除记录，如果主键为空，GORM 会删除该 model 的所有记录（表中所有数据都会被删除！！！）。

1
2
3
4
5
6
7

// 删除现有记录
db.Delete(&email)
//// DELETE from emails where id=10;

// 为删除 SQL 添加额外的 SQL 操作
db.Set("gorm:delete_option", "OPTION (OPTIMIZE FOR UNKNOWN)").Delete(&email)
//// DELETE from emails where id=10 OPTION (OPTIMIZE FOR UNKNOWN);

批量删除

删除全部匹配的记录

1
2
3
4
5

db.Where("email LIKE ?", "%jinzhu%").Delete(Email{})
//// DELETE from emails where email LIKE "%jinzhu%";

db.Delete(Email{}, "email LIKE ?", "%jinzhu%")
//// DELETE from emails where email LIKE "%jinzhu%";

软删除（当没有使用gorm.Model构建结构体时，删除直接就是物理删除）

如果一个 model 有 DeletedAt 字段，他将自动获得软删除的功能！ 当调用 Delete 方法时， 记录不会真正的从数据库中被删除， 只会将 DeletedAt 字段的值会被设置为当前时间

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14

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;

物理删除（用gorm.Model构建结构体时）

1
2
3

// Unscoped 方法可以物理删除记录
db.Unscoped().Delete(&order)
//// DELETE FROM orders WHERE id=10;

DB.Where().Find().RecordNotFound()判断查询结果是否存在

Licensed under CC BY-NC-SA 4.0