导读
本套笔记是学习完Gin框架之后的下一个阶段,通过Gin框架我们可以很方便的和前端进行交互,下一步就是和数据库进行交互,这就需要使用GORM。本套笔记就是带你快速上手GORM,学习完这个之后就可以完成大项目的开发了,后续还会进行大项目的讲解开发,制作不易,喜欢的就点个关注吧。
本套课程基于GORM 指南 | GORM - The fantastic ORM library for Golang, aims to be developer friendly.进行讲解,是对这个的补充解释说明。
注意
代码详解大部分是注释的形式给出,请留意代码注释。
GORM介绍
GORM(Go Object Relational Mapping)是一个在 Go 语言中使用的优秀的 ORM(对象关系映射)库。它提供了简单且强大的 API,使开发人员能够轻松地与数据库进行交互
检索单个对象
GORM 提供了 First、Take、Last 方法,以便从数据库中检索单个对象。
假设我们有一个整数列表 [1, 2, 3, 4, 5]。这个列表包含了一些数字。而 "First"、"Take" 和 "Last" 可以用于从列表中获取部分元素。
- "First" 表示获取列表中的第一个元素。在这个例子中,使用 "First" 操作将返回数字 1。
- "Take" 表示获取列表中的前几个元素。例如,如果我们使用 "Take(3)",那么将返回列表的前三个元素,即 [1, 2, 3]。
- "Last" 表示获取列表中的最后一个元素。在这个例子中,使用 "Last" 操作将返回数字 5。
例子:
package main import ( "fmt" "gorm.io/driver/mysql" "gorm.io/gorm" ) type Email struct { ID uint Name string Email string } //Email的表 func main() { db, _ := gorm.Open(mysql.New(mysql.Config{ DSN: "root:Lycdemima1@@tcp(127.0.0.1:3306)/test?charset=utf8&parseTime=True&loc=Local", // DSN data source name DefaultStringSize: 256, // string 类型字段的默认长度 DisableDatetimePrecision: true, // 禁用 datetime 精度,MySQL 5.6 之前的数据库不支持 DontSupportRenameIndex: true, // 重命名索引时采用删除并新建的方式,MySQL 5.7 之前的数据库和 MariaDB 不支持重命名索引 DontSupportRenameColumn: true, // 用 `change` 重命名列,MySQL 8 之前的数据库和 MariaDB 不支持重命名列 SkipInitializeWithVersion: false, // 根据当前 MySQL 版本自动配置 }), &gorm.Config{}) //连接数据库 // 创建一条新的 Email 记录 email := Email{ Name: "John", Email: "john@example.com", } db.Create(&email) var firstEmail Email db.First(&firstEmail)//获得第一条数据 fmt.Println(firstEmail) //打印数据 }
运行之后,我们可以拿出第一条数据
{12 John john@example.com}
find()
如果我们使用上面的三种函数没有找到数据就会返回ErrRecordNotFound
错误
所以我们可以用find()
来解决
package main import ( "fmt" "gorm.io/driver/mysql" "gorm.io/gorm" ) type Email struct { ID uint Name string Email string } //Email的表 func main() { db, _ := gorm.Open(mysql.New(mysql.Config{ DSN: "root:Lycdemima1@@tcp(127.0.0.1:3306)/test?charset=utf8&parseTime=True&loc=Local", // DSN data source name DefaultStringSize: 256, // string 类型字段的默认长度 DisableDatetimePrecision: true, // 禁用 datetime 精度,MySQL 5.6 之前的数据库不支持 DontSupportRenameIndex: true, // 重命名索引时采用删除并新建的方式,MySQL 5.7 之前的数据库和 MariaDB 不支持重命名索引 DontSupportRenameColumn: true, // 用 `change` 重命名列,MySQL 8 之前的数据库和 MariaDB 不支持重命名列 SkipInitializeWithVersion: false, // 根据当前 MySQL 版本自动配置 }), &gorm.Config{}) //连接数据库 db.AutoMigrate(&Email{})//自动建表 emails := []Email{ {Name: "John", Email: "john@example.com"}, {Name: "Alice", Email: "alice@example.com"}, {Name: "Bob", Email: "bob@example.com"}, } db.Create(&emails) // 查询所有 Email 记录 var allEmails []Email result := db.Find(&allEmails) fmt.Println(result) // 查询满足条件的 Email 记录 var filteredEmails []Email result = db.Where("name LIKE ?", "%o%").Find(&filteredEmails) fmt.Println(result) }
运行结果
&{0xc00013c510 <nil> 3 0xc00028a000 0} &{0xc00013c510 <nil> 2 0xc00028a1c0 0}
result.RowsAffected
获得找到了多少数据,过于简单,只需要加到find后面就可以了。
条件
我们可以使用where()
来更加灵活的获取我们想要的数据
String 条件
官方提供了常用的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; // 时间 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 '上周时间' AND '今天时间';
Struct & Map 条件
我们也可以使用结构体来限定条件
// 结构体 db.Where(&User{Name: "jinzhu", Age: 20}).First(&user) // 根据结构体字段的值查询第一个满足条件的用户记录,字段名和数值必须完全匹配; // Map db.Where(map[string]interface{}{"name": "jinzhu", "age": 20}).Find(&users) // 根据Map中的键值对进行查询,键是字段名,值是字段对应的数值; // 主键切片 db.Where([]int64{20, 21, 22}).Find(&users) // 根据主键的切片进行查询,查找id为20、21或者22的用户记录;
指定结构体查询字段
// 指定结构体查询字段 db.Select("name, age").Where(&User{Name: "jinzhu", Age: 20}).First(&user) // 只查询name和age字段,并根据结构体字段的值查询第一个满足条件的用户记录; // 指定Map查询字段 db.Select("name, age").Where(map[string]interface{}{"name": "jinzhu", "age": 20}).Find(&users) // 只查询name和age字段,并根据Map中的键值对进行查询; // 指定主键切片查询字段 db.Select("name, age").Where([]int64{20, 21, 22}).Find(&user) // 只查询name和age字段,并根据主键的切片进行查询;
内联条件
db.Not("name = ?", "jinzhu").First(&user) // 查询name不等于"jinzhu"的第一条用户记录; // Not In db.Not(map[string]interface{}{"name": []string{"jinzhu", "jinzhu 2"}}).Find(&users) // 查询name不在"jinzhu"或"jinzhu 2"的用户记录; // Struct db.Not(User{Name: "jinzhu", Age: 18}).First(&user) // 查询name不等于"jinzhu"且age不等于18的第一条用户记录; // Not In slice of primary keys db.Not([]int64{1,2,3}).First(&user) // 查询id不在1、2、3之间的第一条用户记录;
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);
排序
指定从数据库中检索记录时的顺序
// 单个排序条件 db.Order("age desc, name").Find(&users) // 按照 age 降序和 name 升序排序查询 users 表中的记录; // 多个排序条件 db.Order("age desc").Order("name").Find(&users) // 先按照 age 降序排序,再按照 name 升序排序查询 users 表中的记录; // 使用 Clauses 进行自定义排序 db.Clauses(clause.OrderBy{ Expression: clause.Expr{SQL: "FIELD(id,?)", Vars: []interface{}{[]int{1, 2, 3}}, WithoutParentheses: true}, }).Find(&User{}) // 使用 Clauses 来自定义排序条件,按照 id 在 1、2、3 之间的顺序查询 users 表中的记录;
Limit & Offset
// 限制结果数量 db.Limit(3).Find(&users) // SELECT * FROM users LIMIT 3 // 查询 users 表的前 3 条记录; // 偏移量(跳过指定数量的记录) db.Offset(3).Find(&users) // 跳过 users 表的前 3 条记录,查询剩余的记录; // 限制结果数量和偏移量 db.Limit(10).Offset(5).Find(&users) // 跳过 users 表的前 5 条记录,查询接下来的 10 条记录; / 取消限制数量条件(取消 limit) db.Limit(10).Find(&users1).Limit(-1).Find(&users2) // SELECT * FROM users LIMIT 10; (users1) // SELECT * FROM users; (users2) // 首先查询 users 表的前 10 条记录,并分别存储于 users1 和 users2 变量中,然后通过设定 Limit 为 -1 取消了限制条件,查询全部记录; // 取消偏移量条件(取消 offset) db.Offset(10).Find(&users1).Offset(-1).Find(&users2) // SELECT * FROM users OFFSET 10; (users1) // SELECT * FROM users; (users2) // 首先跳过 users 表的前 10 条记录,并分别存储于 users1 和 users2 变量中,然后通过设定 Offset 为 -1 取消了偏移量条件,查询全部记录;
附加说明
查找的用法还有非常多,我们这里只将一些最常用的,进阶的知识推荐读者去翻阅官方文档GORM 指南 | GORM - The fantastic ORM library for Golang, aims to be developer friendly.