Gorm入门

Gorm入门

声明:本博客为看李文周大佬gorm入门视频笔记
【GORM简明教程】关于GORM你看这一个就够了_哔哩哔哩_bilibili
我的代码仓库:6月/Gorm · 沉着冷静/2023 - 码云 - 开源中国 (gitee.com)

gorm介绍

安装库
go get -u github.com/jinzhu/gorm
go get -u github.com/jinzhu/gorm/dialects/mysql
连接数据库
func main() {
	// 使用 GORM 连接到 MySQL 数据库
	db, err := gorm.Open("mysql", "usr1:12345@tcp(*******:3306)/db1?charset=utf8mb4&parseTime=True&loc=Local")
	if err != nil {
		panic(err.Error())
	}
    fmt.Println("Connected to the database successfully!")
}
Connected to the database successfully!

Process finished with the exit code 0
创建表
// UserInfo 用户信息
type UserInfo struct {
	ID     uint
	Name   string
	Gender string
	Hobby  string
}
func main() {
   //连接数据库...
    
    // 自动迁移 把表和结构体对应起来
	db.AutoMigrate(&UserInfo{})
}

image-20240530201343630

插入数据
func main() {
   //连接数据库...
    
    // 自动迁移 把表和结构体对应起来
	db.AutoMigrate(&UserInfo{})
    u1 := UserInfo{1, "张三", "男", "篮球"}
	db.Create(&u1)
}

image-20240530201513595

数据查询
func main() {
   //连接数据库...
        
    //查询
	var u UserInfo
	db.First(&u)					//查询表中第一条数据
	fmt.Println("u:%v\n", u)
}

image-20240530201714182

更新数据
func main() {
   //连接数据库...
    
    var u UserInfo
	db.First(&u) //查询表中第一条数据   
    //更新
	db.Model(&u).Update("hobby", "乒乓球")
	fmt.Println("u:%#v\n", u)
}

image-20240530202321464

删除数据
func main() {
   //连接数据库...
    
    var u UserInfo
	db.First(&u) //查询表中第一条数据   
    //删除
    db.Delete(&u)
	fmt.Println("u:%#v\n", u)
}

image-20240530202517634

gorm.Model

model定义

1.定义模型

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

2.嵌套

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

3.自定义

// 不使用gorm.Model,自行定义模型
type User struct {
  ID   int
  Name string
}
model示例
type User struct {
	gorm.Model   //内嵌gorm.Model
	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"` // 设置会员号(member number)唯一并且不为空
	Num          int     `gorm:"AUTO_INCREMENT"`  // 设置 num 为自增类型
	Address      string  `gorm:"index:addr"`      // 给address字段创建名为addr的索引
	IgnoreMe     int     `gorm:"-"`               // 忽略本字段
}
主键

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

image-20240530203617906

设置主键:使用gorm的tag设置主键

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

func main() {
	// 使用 GORM 连接到 MySQL 数据库
	db, err := gorm.Open("mysql", "usr1:12345@tcp(***:3306)/db1?charset=utf8mb4&parseTime=True&loc=Local")
	if err != nil {
		panic(err.Error())
	}

	// 关闭数据库连接
	defer db.Close()

	//db.AutoMigrate(&User{})
	db.AutoMigrate(&Animal{})
	fmt.Println("Connected to the database successfully!")
}

image-20240530204019772

表名

表名默认就是结构体名称的复数

type User struct {
    //...
}

image-20240530203711239

设置表名

1.TableName()

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

///或者加一些判断
func (u User) TableName() string {
  if u.Role == "admin" {
    return "admin_users"
  } else {
    return "users"
  }
}

image-20240530204533292

2.禁用复数形式

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

func main() {
	// 使用 GORM 连接到 MySQL 数据库...
	
	//禁用默认表名的复数形式,如果置为 true,则 `User` 的默认表名是 `user`
	db.SingularTable(true)//
	// 关闭数据库连接...

	db.AutoMigrate(&User{})
	fmt.Println("Connected to the database successfully!")
}

image-20240530204838024

3.指定表名

func main() {
	// 使用 GORM 连接到 MySQL 数据库
	db, err := gorm.Open("mysql", "usr1:12345@tcp(***:3306)/db1?charset=utf8mb4&parseTime=True&loc=Local")
	if err != nil {
		panic(err.Error())
	}
	//禁用默认表名的复数形式,如果置为 true,则 `User` 的默认表名是 `user`
	db.SingularTable(true)
	// 关闭数据库连接
	defer db.Close()
	db.Table("Lion").AutoMigrate(&Animal{})
	
	fmt.Println("Connected to the database successfully!")
}

image-20240530205154050

4.修改默认规则

gorm.DefaultTableNameHandler = func (db *gorm.DB, defaultTableName string) string  {
    //增加前缀  “prefix_”
    return "prefix_" + defaultTableName;
}
func main() {
	// 使用 GORM 连接到 MySQL 数据库
	db, err := gorm.Open("mysql", "usr1:12345@tcp(***:3306)/db1?charset=utf8mb4&parseTime=True&loc=Local")
	if err != nil {
		panic(err.Error())
	}
	//禁用默认表名的复数形式,如果置为 true,则 `User` 的默认表名是 `user`
	db.SingularTable(true)
	//更改默认表名称规则:增加前缀  “prefix_”
	gorm.DefaultTableNameHandler = func(db *gorm.DB, defaultTableName string) string {
		return "prefix_" + defaultTableName
	}
	// 关闭数据库连接
	defer db.Close()
	db.AutoMigrate(&Animal{})

	fmt.Println("Connected to the database successfully!")
}

image-20240530205628969

gorm.DefaultTableNameHandler只修改默认前缀

//1. 
// 将 Animal 的表名设置为 `an1`
func (Animal) TableName() string {
  return "an1"
}
//2.
db.Table("Lion").AutoMigrate(&Animal{})

以上两种是不行的

列名

1.默认

列名由字段名称进行下划线分割来生成:两个单词以上组成的字段会使用下划线分割

type User struct {
	gorm.Model   //内嵌gorm.Model
	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"` // 设置会员号(member number)唯一并且不为空
	Num          int     `gorm:"AUTO_INCREMENT"`  // 设置 num 为自增类型
	Address      string  `gorm:"index:addr"`      // 给address字段创建名为addr的索引
	IgnoreMe     int     `gorm:"-"`               // 忽略本字段
}

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

image-20240530210017533

2.使用tag

type Animal struct {
	AnimalID int64  `gorm:"primary_key"`
	Name     string `gorm:"column:animal_name"` // tag
	Age      int64
}
func main() {
	// 使用 GORM 连接到 MySQL 数据库
	db, err := gorm.Open("mysql", "usr1:12345@tcp(***:3306)/db1?charset=utf8mb4&parseTime=True&loc=Local")
	if err != nil {
		panic(err.Error())
	}
	//禁用默认表名的复数形式,如果置为 true,则 `User` 的默认表名是 `user`
	db.SingularTable(true)
	//更改默认表名称规则:增加前缀  “prefix_”
	gorm.DefaultTableNameHandler = func(db *gorm.DB, defaultTableName string) string {
		return "prefix_" + defaultTableName
	}
	// 关闭数据库连接
	defer db.Close()
	db.AutoMigrate(&Animal{})

	fmt.Println("Connected to the database successfully!")
}

image-20240530210703629

只会做一些安全的操作,防止原数据的损失。

所以在prefix_animal中最后一列插入的一个animal_name

时间戳跟踪
CreatedAt

字段的值将会是初次创建记录的时间。

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

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

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

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

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

如果模型有DeletedAt字段,调用Delete删除该记录时,将会设置DeletedAt字段为当前时间,而不是直接将记录从数据库中删除。

是一种软删除:防止数据出现损失

gorm的curd

创建记录/默认值

1.定义模型

// 定义模型
type User struct {
	ID   int64
	Name string
	Age  int64
}

2.判断主键是否存在

fmt.Println(db.NewRecord(&u)) //判断主键是否为空

3.创建记录

func main() {
	// 使用 GORM 连接到 MySQL 数据库
	db, err := gorm.Open("mysql", "usr1:12345@tcp(***:3306)/db1?charset=utf8mb4&parseTime=True&loc=Local")
	if err != nil {
		panic(err.Error())
	}
	// 关闭数据库连接
	defer db.Close()

	//模型与表进行对应
	db.AutoMigrate(&User{})
	//创建记录
	u := User{Name: "lisi", Age: 18}
	fmt.Println(db.NewRecord(&u)) //判断主键是否为空:无,true;有false
	db.Create(&u)

	fmt.Println("Connected to the database successfully!")
}

image-20240530212007657

image-20240530212215842

4.默认值(类似理解为c++中的缺省值)

// 定义模型
type User struct {
	ID   int64
	Name string `gorm:"default:'张三'"`
	Age  int64
}

原来表中的name,不能为空,先删除这个表

image-20240530212641243

func main() {
	// 使用 GORM 连接到 MySQL 数据库
	db, err := gorm.Open("mysql", "usr1:12345@tcp(***:3306)/db1?charset=utf8mb4&parseTime=True&loc=Local")
	if err != nil {
		panic(err.Error())
	}
	// 关闭数据库连接
	defer db.Close()

	//模型与表进行对应
	db.AutoMigrate(&User{})
	//创建记录
	u := User{Age: 18}
	fmt.Println(db.NewRecord(&u)) //判断主键是否为空:无,true;有false
	db.Create(&u)

	fmt.Println("Connected to the database successfully!")
}

image-20240530212801882

name默认值为张三

image-20240530212954059

默认值为0或空串“”

通过tag定义字段的默认值,在创建记录时候生成的 SQL 语句会排除没有值或值为 零值 的字段。 在将记录插入到数据库后,Gorm会从数据库加载那些字段的默认值。

func main() {
	// 使用 GORM 连接到 MySQL 数据库
	db, err := gorm.Open("mysql", "usr1:12345@tcp(***:3306)/db1?charset=utf8mb4&parseTime=True&loc=Local")
	if err != nil {
		panic(err.Error())
	}
	// 关闭数据库连接
	defer db.Close()

	//模型与表进行对应
	db.AutoMigrate(&User{})
	//创建记录
	u := User{Name: "", Age: 99}
	fmt.Println(db.NewRecord(&u)) //判断主键是否为空:无,true;有false
	db.Create(&u)

	fmt.Println("Connected to the database successfully!")
}

没有使用空串“”,还是使用了默认值

image-20240530213143042

Debug查看原因

在create前加一个Debug

db.Debug().Create(&u)

实际上执行的sql语句是:

image-20240530213459883

注意:所有字段的零值, 比如0, "",false或者其它零值,都不会保存到数据库内,但会使用他们的默认值。

使用指针或实现 Scanner/Valuer接口避免这种空串的情况:

(1)使用指针

type User struct {
	ID   int64
	Name *string `gorm:"default:'张三'"` //指针 *string
	Age  int64
}

image-20240530214015615

对应88岁的name处插入了空串

image-20240530214050670

(2)使用Scanner/Valuer接口方式

image-20240530214234203

// 定义模型
type User struct {
	ID   int64
	Name sql.NullString `gorm:"default:'张三'"` // sql.NullString
	Age  int64
}
func main() {
	//...
	//创建记录
	u := User{Name: sql.NullString{String: "", Valid: true}, Age: 77} 
	//...
}

image-20240530214456298

对应77岁的name处插入了空串

image-20240530214510373

练习:创建年龄为0的记录

法1:

// 定义模型
type User struct {
	ID   int64
	Name sql.NullString `gorm:"default:'张三'"`
	Age  *int64         `gorm:"default:'100'"`
}
u := User{Name: sql.NullString{String: "年龄为0", Valid: true}, Age: new(int64)}

法2:

// 定义模型
type User struct {
	ID   int64
	Name sql.NullString `gorm:"default:'张三'"`
	Age  sql.NullInt64  `gorm:"default:'0'"`
}
u := User{Name: sql.NullString{String: "NullString年龄为0", Valid: true}, Age: sql.NullInt64{Int64: 0, Valid: true}}

image-20240530215245885

查询记录
一般操作
// 定义模型
type User struct {
	gorm.Model
	Name string
	Age  int64
}

1.先建一张表

image-20240530215857998

2.查询

(1)一般查询

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

image-20240530220518426

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

image-20240530220731578

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

image-20240530221115003

// 查询所有的记录
var user []User
db.Find(&users)
 SELECT * FROM users;

image-20240530221653475

// 查询指定的某条记录(仅当主键为整型时可用)
db.First(&user, 10)
 SELECT * FROM users WHERE id = 10;

image-20240530221750669

(2)where条件

普通sql查询

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

image-20240530222327853

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

image-20240530222441721

// <> 不等于
db.Where("name <> ?", "李四").Find(&users)
 SELECT * FROM users WHERE name <> '李四';

image-20240530222613299

// IN 范围
db.Where("name IN (?)", []string{"李四", "李四 2"}).Find(&users)
 SELECT * FROM users WHERE name in ('李四','李四 2');

image-20240530222705133

// LIKE
db.Where("name LIKE ?", "%李四%").Find(&users)
 SELECT * FROM users WHERE name LIKE '%李四%';

image-20240530222757326

// AND
db.Where("name = ? AND age >= ?", "李四", "22").Find(&users)
 SELECT * FROM users WHERE name = '李四' AND age >= 22;

image-20240530222849787

// Time
lastWeek := time.Now().Add(-7 * 24 * time.Hour)
db.Where("updated_at > ?", lastWeek).Find(&users)
 SELECT * FROM users WHERE updated_at > '2000-01-01 00:00:00';

image-20240530223323060

// BETWEEN
lastWeek := time.Now().Add(-7 * 24 * time.Hour)
today := time.Now()
db.Where("created_at BETWEEN ? AND ?", lastWeek, today).Find(&users)
 SELECT * FROM users WHERE created_at BETWEEN '2000-01-01 00:00:00' AN

image-20240530223420202

Struct & Map查询

// Struct
db.Where(&User{Name: "李四", Age: 20}).First(&user)
 SELECT * FROM users WHERE name = "jinzhu" AND age = 20 LIMIT 1;

image-20240530224904973

// Map
db.Where(map[string]interface{}{"name": "李四", "age": 20}).Find(&user)
 SELECT * FROM users WHERE name = "jinzhu" AND age = 20;

image-20240530224943735

// 主键的切片
db.Where([]int64{1, 2}).Find(&users)
 SELECT * FROM users WHERE id IN (1, 2);

image-20240530225051875

(3) Not条件

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

image-20240530225519532

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

image-20240530225544460

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

image-20240530225610302

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

image-20240530225844106

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

image-20240530225909500

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

image-20240530225932007

(4)Or条件

db.Where("age = ?", "18").Or("age = ?", "19").Find(&user)
 SELECT * FROM users WHERE age = '18' OR age = '19';

image-20240530230352152

// Struct
db.Where("name = '张三'").Or(User{Name: "张三 2"}).Find(&user)
 SELECT * FROM users WHERE name = '张三' OR name = '张三 2';

image-20240530230427929

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

image-20240530230458435

(5) 内联条件

作用与Where查询类似,当内联条件与多个立即执行方法一起使用时, 内联条件不会传递给后面的立即执行方法。

立即执行方法

Immediate methods ,立即执行方法是指那些会立即生成SQL语句并发送到数据库的方法, 他们一般是CRUD方法。Create, First, Find, Take, Save, UpdateXXX, Delete, Scan, Row, Rows

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

image-20240530231110398

// Plain SQL
db.Find(&user, "name = ?", "张三")
 SELECT * FROM users WHERE name = "张三";

image-20240530231203177

db.Find(&users, "name <> ? AND age > ?", "张三", 20)
 SELECT * FROM users WHERE name <> "张三" AND age > 20;

image-20240530231231955

// Struct
db.Find(&users, User{Age: 20})
 SELECT * FROM users WHERE age = 20;

image-20240530231256911

// Map
db.Find(&users, map[string]interface{}{"age": 20})
 SELECT * FROM users WHERE age = 20;

image-20240530231320312

(6)额外查询选项

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

在GORM中,db.Set("gorm:query_option", "FOR UPDATE").First(&user, 1) 这行代码的意图是查询ID为1的用户,并且使用 FOR UPDATE 锁定这条记录,以便在事务中进行更新而不会被其他事务干扰。

image-20240530231506209

(7)FirstOrInit

获取匹配的第一条记录,否则根据给定的条件初始化一个新的对象 (仅支持 struct 和 map 条件)

如果找不到,则初始化一个新的用户实例,但不会将其插入到数据库中

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

image-20240530232412950

image-20240530232430461

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

image-20240530232539691

Attrs

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

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

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

在GORM中,db.Where(User{Name: "王五"}).Attrs(User{Age: 100}).FirstOrInit(&user) 这行代码的意图是查询名为"王五"的用户,如果找不到,则初始化一个新的用户实例,并设置其年龄为100,但不会将其插入到数据库中。

image-20240530232927902

// 找到
db.Where(User{Name: "张三"}).Attrs(User{Age: 100}).FirstOrInit(&user)
 SELECT * FROM USERS WHERE name = 张三';
 user -> User{Id: 1, Name: "张三", Age: 100}

找到了,就不用100去初始化struct

image-20240530233153241

Assign

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

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

image-20240530233255952

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

image-20240530233330783

(8)FirstOrCreate

获取匹配的第一条记录, 否则根据给定的条件创建一个新的记录 (仅支持 struct 和 map 条件)

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

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

image-20240530233454379

image-20240530233506681

Attrs

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

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

image-20240530233621061

image-20240530233634132

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

image-20240530233656107

Assign

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

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

image-20240530233835989

image-20240530233849521

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

image-20240530233910808

image-20240530233922885

(9)高级查询

子查询

基于 *gorm.expr 的子查询:SubQuery()

db.Where("age > ?", db.Table("users").Select("AVG(age)").Where("name = ?", "'张三;").SubQuery()).Find(&user)
// SELECT * FROM "users"  WHERE "users"."deleted_at" IS NULL AND (age > (SELECT AVG(age) FROM "users"  WHERE (name = '*')));

在GORM中,db.Where("age > ?", db.Table("users").Select("AVG(age)").Where("name LIKE ?", "%").SubQuery()).Find(&user) 这行代码的意图是查询所有年龄大于平均年龄的用户,但仅限于名字包含任意字符的用户。

image-20240530235025672

我们可以看到有5个用户,他们的年龄分别是18、20、10、20和20。平均年龄是 (18 + 20 + 10 + 20 + 20) / 5 = 18.2。

image-20240530234915581

选择字段

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

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

image-20240530235135542

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

image-20240530235159863

a, _ := db.Table("users").Select("COALESCE(age,?)", 20).Rows()
	//fmt.Println(user)
	for a.Next() {
		var b int64
		err = a.Scan(&b)
		if err != nil {
			panic(err)
		}
		fmt.Println(b)
	}
 SELECT COALESCE(age,'20') FROM users;

image-20240531001947915

排序

Order,指定从数据库中检索出记录的顺序。设置第二个参数 reorder 为 true ,可以覆盖前面定义的排序条件。

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

在 GORM 中,db.Order 方法用于指定查询结果的排序方式。在你提供的代码片段中,db.Order("age desc, name").Find(&user) 表示按照 age 字段降序排序,如果 age 相同,则按照 name 字段升序排序。

image-20240531002212540

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

年龄降序,再按姓名升序

image-20240531002416666

// 覆盖排序
db.Order("age desc").Find(&user).Order("age", true).Find(&user)

 SELECT * FROM users ORDER BY age desc; (users1)
 SELECT * FROM users ORDER BY age; (users2)

覆盖后只显示升序

image-20240531003425816

数量

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

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

image-20240531003553426

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

image-20240531003623307

偏移

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

db.Offset(3).Limit(10).Find(&user)

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

配合limit使用,否则不生效

image-20240531004058746

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

image-20240531004202580

总数

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

var count int64
db.Where("name = ?", "张三").Or("name = ?", "张三 2").Find(&user).Count(&count)
fmt.Println(count)
 SELECT * from USERS WHERE name = '张三' OR name = '张三 2'; (users)
 SELECT count(*) FROM users WHERE name = '张三' OR name = '张三 2'; (count)

image-20240531004430100

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

image-20240531004527152

db.Table("users").Count(&count)
 SELECT count(*) FROM users;

image-20240531004606587

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

distinct:从查询结果中删除重复的行,只返回唯一的值。

例如,在表中再插入一个张三

image-20240531004937639

此时返回的还是5

image-20240531004733199

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

Group & Having

rows, erro := db.Table("users").Select("date(created_at) as date, sum(age) as total").Group("date(created_at)").Rows()
if erro != nil {
    // 处理错误
    panic(erro)
}
for rows.Next() {
    var date string
    var total float64

    err = rows.Scan(&date, &total)
    if err != nil {
        // 处理错误
        panic(err)
    }

    // 处理每一行的数据
    fmt.Printf("Date: %s, Total: %f\n", date, total)
}

image-20240531010421563

// 使用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)

image-20240531011330704

rows, erro := db.Table("users").Select("date(created_at) as date, sum(age) as total").Group("date(created_at)").Having("sum(age) > ?", 20).Rows()
if erro != nil {
    panic(erro)
}
for rows.Next() {
    var Date string
    var Total int64
    err = rows.Scan(&Date, &Total)
    if err != nil {
        panic(err)
    }
    fmt.Println(Date)
    fmt.Println("------------------------------")
    fmt.Println(Total)
}

image-20240531011755902

type Result struct {
  Date  time.Time
  Total int64
}
db.Table("orders").Select("date(created_at) as date, sum(amount) as total").Group("date(created_at)").Having("sum(amount) > ?", 100).Scan(&results)

image-20240531012355929

连接

首先建表

type Emails struct {
	gorm.Model
	Email string `gorm:"email"`
}
e1 := Emails{Email: "12345@163.com"}
e2 := Emails{Email: "789@qq.com"}
e3 := Emails{Email: "10jqk@xxx.com"}
e4 := Emails{Email: sql.NullString{String: "abc@163.com", Valid: true}}
e5 := Emails{Email: sql.NullString{String: "efg@qq.com", Valid: true}}
e6 := Emails{Email: sql.NullString{String: "xxx@xxx.com", Valid: true}}
db.Create(&e1)
db.Create(&e2)
db.Create(&e3)
db.Create(&e4)
db.Create(&e5)
db.Create(&e6)

image-20240531014832911

Joins,指定连接条件

rows, erro := db.Table("users").Select("users.name, emails.email").Joins("left join emails on emails.id = users.id").Rows()
if erro != nil {
    panic(erro)
}
for rows.Next() {
    var name, email string
    erro = rows.Scan(&name, &email)
    if erro != nil {
        panic(erro)
    }
    fmt.Println(name)
    fmt.Println("--------------------")
    fmt.Println(email)
}

image-20240531014735167

type Result struct {
    Name  string
    Email string
}
var results []Result
db.Table("users").Select("users.name, emails.email").Joins("left join emails on emails.id = users.id").Scan(&results)
for _, ret := range results {
    fmt.Println(ret.Name, "-----", ret.Email)
}

image-20240531015445779

// 多连接及参数
db.Joins("JOIN emails ON emails.id = users.id AND emails.email = ?", "789@qq.com").Joins("JOIN credit_cards ON credit_cards.id = users.id").Where("credit_cards.number = ?", "88888888").Find(&user)

建表

type CreditCard struct {
	ID     int64
	Number string
}
c1 := CreditCard{ID: 2, Number: "123456"}
c2 := CreditCard{ID: 777, Number: "88888888"}
c3 := CreditCard{ID: 888, Number: "abcde"}
db.Create(&c1)
db.Create(&c2)
db.Create(&c3)

image-20240531020155734

执行结果:

image-20240531020108577

(10)Pluck

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

image-20240531020412570

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

image-20240531020458310

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

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

image-20240531020554691

(11)扫描

Scan,扫描结果至一个 struct.

type Result struct {
  Name string
  Age  int
}

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

image-20240531020800584


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

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

image-20240531020853305

链式操作相关

1.链式操作

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


// 创建一个查询
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语句,借助这个特性你可以创建一个函数来处理一些通用逻辑。

例如:

var users []User
	tx := db.Where("name = ?", "张三")
	someCondition := true
	// 添加更多条件
	if someCondition {
		tx = tx.Where("age = ?", 18)
	} else {
		tx = tx.Where("age = ?", 30)
	}
	yetAnotherCondition := true
	if yetAnotherCondition {
		tx = tx.Where("id = ?", 1)
	}
	err = tx.Find(&users).Error
	if err != nil {
		panic(err)
	}
	for _, user := range users {
		fmt.Println(user.ID, user.Name, user.Age)
	}

image-20240531021451138

2.立即执行方法

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

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

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

tx.Find(&user)

生成的SQL语句如下:

SELECT * FROM users where name = '张三' AND age = 18 AND id = 1;

3.范围

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

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

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 且已付款或者已发货的订单

4.多个立即执行方法

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

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

生成的 Sql

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

SELECT count(*) FROM users WHERE name LIKE 'jinzhu%'
更新记录
更新所有字段

Save()默认会更新该对象的所有字段,即使你没有赋值。

更新前:

image-20240602223813972

更新后:

type User struct {
	gorm.Model
	Name   string
	Gender string
	Age    int64
}
func main() {
	// 使用 GORM 连接到 MySQL 数据库
    db, err := gorm.Open("mysql", "usr1:12345@tcp(***:3306)/db1?charset=utf8mb4&parseTime=True&loc=Local")
	if err != nil {
		panic(err.Error())
	}
	// 关闭数据库连接
	defer db.Close()
	db.AutoMigrate(&User{})
	//u1 := User{Name: "张三", Gender: "男", Age: 18}
	//u2 := User{Name: "李四", Gender: "女", Age: 20}
	//db.Create(&u1)
	//db.Create(&u2)
	//查询
	var user User
	db.First(&user)
	//更新
	user.Name = "李四"
	user.Age = 28
	db.Debug().Save(&user)
}

image-20240602224150737

image-20240602224704139

更新修改字段

如果你只希望更新指定字段,可以使用Update或者Updates

// 更新单个属性,如果它有变化
db.Model(&user).Update("name", "老6")
 UPDATE users SET name='老6', updated_at='2013-11-17 21:34:10' WHERE id=1;

image-20240602225011674

image-20240602224935264

// 根据给定的条件更新单个属性
db.Model(&user).Where("age = ?", 28).Update("name", "李四")
 UPDATE users SET name='李四', updated_at='2013-11-17 21:34:10' WHERE id=1 AND age=28;

image-20240602225300751

image-20240602225250194

// 使用 map 更新多个属性,只会更新其中有变化的属性
db.Debug().Model(&user).Updates(map[string]interface{}{"name": "王五", "age": 18, "gender": "女"})
 UPDATE users SET name='王五', age=18, gender=女, updated_at='2013-11-17 21:34:10' WHERE id=1;

image-20240602225554994

image-20240602225458397

// 使用 struct 更新多个属性,只会更新其中有变化且为非零值的字段
db.Model(&user).Updates(User{Name: "张三", Age: 18})
 UPDATE users SET name='张三', age=17, updated_at = '2013-11-17 21:34:10' WHERE id = 1;

image-20240602225712989

image-20240602225706093

// 警告:当使用 struct 更新时,GORM只会更新那些非零值的字段
// 对于下面的操作,不会发生任何更新,"", 0, false 都是其类型的零值
db.Model(&user).Updates(User{Name: "", Age: 0})

image-20240602225827400

image-20240602225844152

更新选定字段
db.Model(&user).Select("name").Updates(map[string]interface{}{"name": "王五", "age": 18})
 UPDATE users SET name='王五', updated_at='2013-11-17 21:34:10' WHERE id=1;

image-20240602231026420

db.Model(&user).Omit("name").Updates(map[string]interface{}{"name": "张三", "age": 88})
 UPDATE users SET age=18, updated_at='2013-11-17 21:34:10' WHERE id=1;

image-20240602230950394

image-20240602231004715

无Hooks更新

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

// 更新单个属性,类似于 `Update`
db.Model(&user).UpdateColumn("name", "张三")
 UPDATE users SET name='张三' WHERE id = 1;

image-20240602231233545

image-20240602231241140

// 更新多个属性,类似于 `Updates`
db.Model(&user).UpdateColumns(User{Name: "hello", Age: 18})
 UPDATE users SET name='hello', age=18 WHERE id = 1;

image-20240602231325149

image-20240602231331739

批量更新

批量更新时Hooks(钩子函数)不会运行。

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

image-20240602231704909

image-20240602231719702

// 使用 struct 更新时,只会更新非零值字段,若想更新所有字段,请使用map[string]interface{}
db.Debug().Model(User{}).Updates(User{Name: "李四", Age: 18, Gender: "男"})
 UPDATE users SET name='李四', age=18, gender='男';

image-20240602231909791

image-20240602231939307

// 使用 `RowsAffected` 获取更新记录总数
rowsAffected := db.Debug().Model(User{}).Updates(User{Name: "张三", Age: 18}).RowsAffected
fmt.Printf("Rows affected: %d\n", rowsAffected)

image-20240602232312613

image-20240602232333859

使用SQL表达式更新

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

var user User
db.First(&user)
db.Model(&user).Update("age", gorm.Expr("age * ? + ?", 2, 100))
//如果改整体(&user) 改为 (&User{})
 UPDATE `users` SET `age` = age + 2, `updated_at` = '2020-02-16 13:10:20'  WHERE `users`.`id` = 1;

image-20240602233441939

image-20240602233458004

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

image-20240602233614653

image-20240602233604399

db.Model(&User{}).UpdateColumn("age", gorm.Expr("age / ?", 2))
 UPDATE "users" SET "age" = age / 2 WHERE "id" = '1';

image-20240602233730329

image-20240602233737823

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

image-20240602233838611

image-20240602233828845

修改Hooks中的值

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

在 GORM 中,BeforeSave 是一个钩子(hook)方法,它在保存(插入或更新)记录之前被调用。我们可以在此方法中执行一些自定义的逻辑,例如对密码进行加密、验证数据的完整性等。

BeforeSave 方法用于在保存用户记录之前对用户的密码进行加密。这是一个常见的安全实践,因为存储明文密码可能会导致安全风险。通过使用 bcrypt 加密算法对密码进行加密,可以确保即使数据库被泄露,攻击者也无法直接获取用户的原始密码。

func (user *User) BeforeSave(scope *gorm.Scope) (err error) {
	if pw, err := bcrypt.GenerateFromPassword(user.Password, 0); err == nil {
		scope.SetColumn("EncryptedPassword", pw)
	}
}
// Player 是一个简单的用户模型
type Player struct {
	ID                uint
	Name              string
	Password          string
	EncryptedPassword string
}

// BeforeSave 是一个 GORM 钩子方法,在保存用户记录之前被调用
func (p *Player) BeforeSave(scope *gorm.Scope) (err error) {
	if pw, err := bcrypt.GenerateFromPassword([]byte(p.Password), 0); err == nil {
		scope.SetColumn("EncryptedPassword", pw)
	} else {
		return err
	}
	return nil
}

func main() {
	// 使用 GORM 连接到 MySQL 数据库
	db, err := gorm.Open("mysql", "usr1:12345@tcp(114.132.68.147:3306)/db1?charset=utf8mb4&parseTime=True&loc=Local")
	if err != nil {
		panic(err.Error())
	}
	// 关闭数据库连接
	defer db.Close()
	db.AutoMigrate(&Player{})

	// 创建一个新用户
	p := Player{Name: "张三", Password: "123456"}
	db.Create(&p)

	// 查询并打印创建的用户
	var createdUser Player
	db.Where("name = ?", "张三").First(&createdUser)
	fmt.Printf("Created user: %+v\n", createdUser)
}

image-20240602235004838

image-20240602235138355

其它更新选项
// 为 update SQL 添加其它的 SQL
db.Model(&user).Set("gorm:update_option", "OPTION (OPTIMIZE FOR UNKNOWN)").Update("name", "王五")
 UPDATE users SET name='王五', updated_at = '2013-11-17 21:34:10' WHERE id=1 OPTION (OPTIMIZE FOR UNKNOWN);
删除记录
删除记录

警告 删除记录时,请确保主键字段有值,GORM 会通过主键去删除记录,如果主键为空,GORM 会删除该 model 的所有记录。

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

image-20240602235843768

image-20240602235833162

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

插入些记录

image-20240603000331308

删除全部匹配的记录

db.Where("name LIKE ?", "%李四%").Delete(user{})
 DELETE from emails where email LIKE "%李四%";

image-20240603000420772

image-20240603000443166

db.Debug().Delete(User{}, "name LIKE ?", "%张三%")
 DELETE from users where name LIKE "%张三%";

image-20240603000630810

image-20240603000648173

软删除

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

db.Delete(&user)
 UPDATE users SET deleted_at="2013-10-29 10:23" WHERE id = 1;
// 批量删除
db.Where("age = ?", 20).Delete(&User{})
 UPDATE users SET deleted_at="2013-10-29 10:23" WHERE age = 20;

演示过了…

// 查询记录时会忽略被软删除的记录
db.Where("age = 18").Find(&user)
 SELECT * FROM users WHERE age = 18 AND deleted_at IS NULL;

image-20240603000925341

// Unscoped 方法可以查询被软删除的记录
db.Unscoped().Where("age = 20").Find(&user)
 SELECT * FROM users WHERE age = 20;

image-20240603001110467

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

ps:第一次忘记写Debug了,所以这次也就是第二次的删除是``0 rows affected`

image-20240603001242341

image-20240603001201212

  • 14
    点赞
  • 20
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值