【Go】Go Gorm 详解

1. 概念

Gorm 官网：https://gorm.io/zh_CN/docs/

Gorm：The fantastic ORM library for Golang aims to be developer friendly，这是官网的介绍，简单来说 Gorm 就是一款高性能的 Golang ORM 库，便于开发人员提高效率

那么 ORM（Object Relation Mapping） 又是什么呢？在 Golang 语言中，Object指的就是 struct 结构体对象，Relation 就是数据库当中的关系，Mapping则表示两者具有映射关系，具体表现如下：

• Go当中的结构体声明 <-> 数据库层面的表结构
• Go当中的结构体实例 <-> 数据库层面的一条表记录

2. 数据库连接

2.1 安装依赖

想要在 Go 代码中使用 gorm 我们需要先引入对应的依赖：

• gorm 库依赖：gorm.io/gorm
• 特定数据库驱动依赖：gorm.io/driver/mysql

然后使用 go mod 包管理工具加载对应的依赖：

1. go mod init first_gorm：初始化
2. go mod tidy：加载依赖

然后就可以开始编写代码了！

2.2 连接数据库

在操作数据库之前，我们还需要与指定的数据库建立连接，此处以 MySQL数据库为例：

基本语法：db, err := gorm.Open(mysql.Open(dsn语句), &gorm.Config{})

• 其中 dsn 语句为特定的连接格式，形式如下：user:pwd@tcp(127.0.0.1:3306)/dbname?charset=utf8mb4&parseTime=True&loc=Local

package mainimport ("fmt""gorm.io/driver/mysql""gorm.io/gorm"
)func main() {var dsn = "root:QWEzxc123456@tcp(127.0.0.1:3306)/gorm_test?charset=utf8mb4&parseTime=True&loc=Local"db, err := gorm.Open(mysql.Open(dsn), &gorm.Config{})if err != nil {fmt.Println("数据库连接失败!", err)}fmt.Println(db)
}

程序运行结果：

控制台打印出 db 对象，说明我们已经成功与数据库建立连接（必须保证数据库中存在指定的数据库）

3. 数据库基本操作

3.1 创建表（表关系映射）

3.1.1 基本使用

我们可以使用 gorm 提供的 API 来创建指定的表，需要关注的是 结构体声明 <=> 数据库表结构，因此我们想要创建一个表结构实则只需要定义一个结构体类型

-- 创建user表 --
create table t_user (user_id bigint primary key auto_increment,user_name varchar(32) not null,user_pwd varchar(128) not null,user_phone varchar(32) unique
) 

使用上述 SQL 语句创建表的行为等价于在 Go 语言当中定义下列结构体对象：

// User 结构体声明
type User struct {UserId    int64  `gorm:"primaryKey;autoIncrement"`UserName  string `gorm:"not null;type:varchar(32)"`UserPwd   string `gorm:"not null;type:varchar(128)"`UserPhone string `gorm:"unique;type:varchar(32)"`
}

创建表基本语法：err := db.AutoMigrate(&特定结构体{})

package mainimport ("fmt""gorm.io/driver/mysql""gorm.io/gorm"
)// User 结构体声明
type User struct {UserId    int64  `gorm:"primaryKey;autoIncrement"`UserName  string `gorm:"not null;type:varchar(32)"`UserPwd   string `gorm:"not null;type:varchar(128)"`UserPhone string `gorm:"unique;type:varchar(32)"`
}func main() {// 连接数据库var dsn = "root:QWEzxc123456@tcp(127.0.0.1:3306)/gorm_test?charset=utf8mb4&parseTime=True&loc=Local"db, err := gorm.Open(mysql.Open(dsn), &gorm.Config{})if err != nil {fmt.Println("数据库连接失败!", err)}err = db.AutoMigrate(&User{})if err != nil {fmt.Println("数据库表迁移失败!", err)}
}

程序运行结果：

3.1.2 自定义表名

我们发现定义结构体名称为 “User” 时会创建 “users” 的表名，但是如果我就希望叫做 “t_user” 应该怎么办呢？我们可以定义一个名为 TableName的方法接收器，格式如下：

func (*User) TableName() string {return "t_user"
}

删除原先的表后再次运行，可以发现此时表名称已经指定为t_user了

3.2 新增记录

我们还可以使用 gorm 提供的 API 进行表记录的插入，这里我们需要关注** 结构体实例 <=> 表记录** 之间的映射关系，也就意味着我们可以通过创建一个结构体实例，实现插入一条记录的效果

3.2.1 单条数据插入

基本语法：db.Create(&结构体实例)

package mainimport ("fmt""gorm.io/driver/mysql""gorm.io/gorm"
)// User 结构体声明
type User struct {UserId    int64  `gorm:"primaryKey;autoIncrement"`UserName  string `gorm:"not null;type:varchar(32)"`UserPwd   string `gorm:"not null;type:varchar(128)"`UserPhone string `gorm:"unique;type:varchar(32)"`
}func (*User) TableName() string {return "t_user"
}func main() {// 连接数据库var dsn = "root:QWEzxc123456@tcp(127.0.0.1:3306)/gorm_test?charset=utf8mb4&parseTime=True&loc=Local"db, err := gorm.Open(mysql.Open(dsn), &gorm.Config{})if err != nil {fmt.Println("数据库连接失败!", err)}// 插入单条数据var user = User{UserName: "wjj", UserPwd: "123", UserPhone: "111"}db.Create(&user)// 再次打印userfmt.Println(user)
}

数据库表结果：

程序运行结果：

💡 提示：从中我们还可以发现，插入数据之后，还会将数据库表中记录回显到结构体实例当中！这也是为什么需要传递地址的原因！

3.2.2 批量插入数据

当我们需要批量插入多条数据的时候，循环调用 db.Create(&结构体实例)这个方法效率就太低了！因为数据库连接会话频繁创建销毁耗时比较高，更合适的方法就是进行批量插入

基本语法：db.Create(&结构体实例切片)，仍旧是 Create 函数，但是参数我们可以传递结构体实例切片

package mainimport ("fmt""gorm.io/driver/mysql""gorm.io/gorm"
)// User 结构体声明
type User struct {UserId    int64  `gorm:"primaryKey;autoIncrement"`UserName  string `gorm:"not null;type:varchar(32)"`UserPwd   string `gorm:"not null;type:varchar(128)"`UserPhone string `gorm:"unique;type:varchar(32)"`
}func (*User) TableName() string {return "t_user"
}func main() {// 连接数据库var dsn = "root:QWEzxc123456@tcp(127.0.0.1:3306)/gorm_test"db, _ := gorm.Open(mysql.Open(dsn), &gorm.Config{})// 批量插入多条数据var users = []User{{UserName: "th", UserPwd: "123", UserPhone: "222"},{UserName: "lhf", UserPwd: "123", UserPhone: "333"},{UserName: "zcy", UserPwd: "123", UserPhone: "444"},}db.Create(&users)// 打印结果fmt.Println(users)
}

数据库表结果：

程序运行结果：

3.3 查询记录

3.3.1 查询所有记录

基本语法：db.Find(&结构体实例切片)

package mainimport ("fmt""gorm.io/driver/mysql""gorm.io/gorm"
)// User 结构体声明
type User struct {UserId    int64  `gorm:"primaryKey;autoIncrement"`UserName  string `gorm:"not null;type:varchar(32)"`UserPwd   string `gorm:"not null;type:varchar(128)"`UserPhone string `gorm:"unique;type:varchar(32)"`
}func (*User) TableName() string {return "t_user"
}func main() {// 连接数据库var dsn = "root:QWEzxc123456@tcp(127.0.0.1:3306)/gorm_test"db, _ := gorm.Open(mysql.Open(dsn), &gorm.Config{})// 查询全部记录var users []Userdb.Find(&users)// 打印结果fmt.Println(users)
}

程序运行结果：

3.3.2 按照条件查询

我们可以使用 Where 指定查询条件进行过滤

基本语法：db.Where("user_id > ?", 2).Find()表示想要查询 user_id > 2 的所有记录

package mainimport ("fmt""gorm.io/driver/mysql""gorm.io/gorm"
)// User 结构体声明
type User struct {UserId    int64  `gorm:"primaryKey;autoIncrement"`UserName  string `gorm:"not null;type:varchar(32)"`UserPwd   string `gorm:"not null;type:varchar(128)"`UserPhone string `gorm:"unique;type:varchar(32)"`
}func (*User) TableName() string {return "t_user"
}func main() {// 连接数据库var dsn = "root:QWEzxc123456@tcp(127.0.0.1:3306)/gorm_test"db, _ := gorm.Open(mysql.Open(dsn), &gorm.Config{})// 按照条件查询var users []Userdb.Where("user_id > ?", 2).Find(&users)// 打印fmt.Println(users)
}

程序运行结果：

3.3.3 查询单条记录

查询单条记录有以下两种情况：

• 查询第一条记录：db.First(&结构体实例)
• 查询最后一条记录：db.Last(&结构体实例)

package mainimport ("fmt""gorm.io/driver/mysql""gorm.io/gorm"
)// User 结构体声明
type User struct {UserId    int64  `gorm:"primaryKey;autoIncrement"`UserName  string `gorm:"not null;type:varchar(32)"`UserPwd   string `gorm:"not null;type:varchar(128)"`UserPhone string `gorm:"unique;type:varchar(32)"`
}func (*User) TableName() string {return "t_user"
}
func main() {// 连接数据库var dsn = "root:QWEzxc123456@tcp(127.0.0.1:3306)/gorm_test"db, _ := gorm.Open(mysql.Open(dsn), &gorm.Config{})// 查询第一条记录var firstUser Userdb.First(&firstUser)// 查询最后一条记录var lastUser Userdb.Last(&lastUser)fmt.Println(firstUser, lastUser)
}

程序运行结果：

3.3.4 查询记录总数

基本语法：db.Find(&结构体实例切片).Count(&整型变量)

package mainimport ("fmt""gorm.io/driver/mysql""gorm.io/gorm"
)// User 结构体声明
type User struct {UserId    int64  `gorm:"primaryKey;autoIncrement"`UserName  string `gorm:"not null;type:varchar(32)"`UserPwd   string `gorm:"not null;type:varchar(128)"`UserPhone string `gorm:"unique;type:varchar(32)"`
}func (*User) TableName() string {return "t_user"
}func main() {// 连接数据库var dsn = "root:QWEzxc123456@tcp(127.0.0.1:3306)/gorm_test"db, _ := gorm.Open(mysql.Open(dsn), &gorm.Config{})// 查询总数var users []Uservar totalSize int64db.Find(&users).Count(&totalSize)fmt.Println("记录总数:", totalSize)
}

程序运行结果：

3.4 修改记录

3.4.1 按照默认主键修改

基本语法：db.Save(&结构体实例)会按照结构体实例当中的主键字段找到对应数据库记录进行修改

package mainimport ("gorm.io/driver/mysql""gorm.io/gorm"
)// User 结构体声明
type User struct {UserId    int64  `gorm:"primaryKey;autoIncrement"`UserName  string `gorm:"not null;type:varchar(32)"`UserPwd   string `gorm:"not null;type:varchar(128)"`UserPhone string `gorm:"unique;type:varchar(32)"`
}func (*User) TableName() string {return "t_user"
}func main() {// 连接数据库var dsn = "root:QWEzxc123456@tcp(127.0.0.1:3306)/gorm_test"db, _ := gorm.Open(mysql.Open(dsn), &gorm.Config{})// 查询user_id为1的记录var stu Userdb.Where("user_id = ?", 1).Find(&stu)// 修改stu姓名为wjj1stu.UserName = "wjj1"// 修改(按照主键修改)db.Save(&stu)
}

程序运行结果：

3.4.2 修改指定字段

上述按照默认主键修改的方式修改了全部字段，如果我们只想修改特定单个字段可以使用以下方式：

基本语法：db.Model(&结构体实例).Where(条件).Update(字段, 修改值)

package mainimport ("gorm.io/driver/mysql""gorm.io/gorm"
)// User 结构体声明
type User struct {UserId    int64  `gorm:"primaryKey;autoIncrement"`UserName  string `gorm:"not null;type:varchar(32)"`UserPwd   string `gorm:"not null;type:varchar(128)"`UserPhone string `gorm:"unique;type:varchar(32)"`
}func (*User) TableName() string {return "t_user"
}func main() {// 连接数据库var dsn = "root:QWEzxc123456@tcp(127.0.0.1:3306)/gorm_test"db, _ := gorm.Open(mysql.Open(dsn), &gorm.Config{})// 修改user_id为1的记录 user_name为wjjvar stu Userdb.Model(&stu).Where("user_id = ?", 1).Update("user_name", "wjj")
}

程序运行结果：

3.4.3 修改多个字段

我们还可以指定多个字段进行修改

基本语法：db.Model(&结构体实例).Where(条件).updates(修改实例)，其中修改实例可以是结构体也可以是map对象

package mainimport ("gorm.io/driver/mysql""gorm.io/gorm"
)// User 结构体声明
type User struct {UserId    int64  `gorm:"primaryKey;autoIncrement"`UserName  string `gorm:"not null;type:varchar(32)"`UserPwd   string `gorm:"not null;type:varchar(128)"`UserPhone string `gorm:"unique;type:varchar(32)"`
}func (*User) TableName() string {return "t_user"
}func main() {// 连接数据库var dsn = "root:QWEzxc123456@tcp(127.0.0.1:3306)/gorm_test"db, _ := gorm.Open(mysql.Open(dsn), &gorm.Config{})// 修改user_id为1的记录 user_name为WJJ, user_pwd为"999"var stu Uservar fields = map[string]interface{}{"user_name": "WJJ", "user_pwd": "999"}db.Model(&stu).Where("user_id = ?", 1).Updates(fields)
}

程序运行结果：

3.5 删除记录

3.5.1 按照默认主键删除

基本语法：db.Delete(&结构体实例)会自动按照主键找到表中记录，然后删除

package mainimport ("gorm.io/driver/mysql""gorm.io/gorm"
)// User 结构体声明
type User struct {UserId    int64  `gorm:"primaryKey;autoIncrement"`UserName  string `gorm:"not null;type:varchar(32)"`UserPwd   string `gorm:"not null;type:varchar(128)"`UserPhone string `gorm:"unique;type:varchar(32)"`
}func (*User) TableName() string {return "t_user"
}func main() {// 连接数据库var dsn = "root:QWEzxc123456@tcp(127.0.0.1:3306)/gorm_test"db, _ := gorm.Open(mysql.Open(dsn), &gorm.Config{})// 按照默认主键删除var user = User{UserId: 1}db.Delete(&user)
}

程序运行结果：

3.5.2 指定条件删除

我们想更加精细化的控制删除条件就需要借助 Where 函数：

基本语法：db.Where(条件).Delete(&结构体实例)

package mainimport ("gorm.io/driver/mysql""gorm.io/gorm"
)// User 结构体声明
type User struct {UserId    int64  `gorm:"primaryKey;autoIncrement"`UserName  string `gorm:"not null;type:varchar(32)"`UserPwd   string `gorm:"not null;type:varchar(128)"`UserPhone string `gorm:"unique;type:varchar(32)"`
}func (*User) TableName() string {return "t_user"
}func main() {// 连接数据库var dsn = "root:QWEzxc123456@tcp(127.0.0.1:3306)/gorm_test"db, _ := gorm.Open(mysql.Open(dsn), &gorm.Config{})// 按照条件删除db.Where("user_id = ?", 10).Delete(&User{})
}

程序运行结果：