Gorm 提供了很多错误类型给我们使用,今天我们介绍较为常见的 gorm.ErrRecordNotFound,我们将用其实现较为常见的存在性判断逻辑。之所以常见,是因为我们常需要使用存在性判断,来避免使用不存在的结果的结果集或重复插入数据行。
我们知道 Gorm 的查询会返回 *gorm.DB,而 *gorm.DB 中存在的 Error 字段边携带我们需要的错误信息,我们实现的方式便是使用查询返回的 *gorm.DB 获取 Error 字段信息,然后用该信息和 gorm 的 errors.go 文件中定义的 ErrRecordNotFound 错误进行比对,来确定我们的查询是否不存在记录。
go
errors.Is(result.Error, gorm.ErrRecordNotFound)
errors 的 Is API 会比对错误,如果匹配则返回 true,否则 false。
核心知识点介绍完毕,下面是实践部分。
我们使用 sqlite 配合 gorm 的自动迁移来完成我们的实践,首先我们需要最典型的数据表 User 表:
go
type User struct {
gorm.Model
Name string
Email string `gorm:"type:varchar(100);unique_index"`
}
然后是用于核心代码 CheckExist 函数:
go
// CheckExist 使用 gorm.ErrRecordNotFound 检查符合某些条件的元组是否存在
func CheckExist(db *gorm.DB, name string) bool {
var user User
result := db.Where("Name = ?", name).First(&user)
// 使用 gorm.ErrRecordNotFound 检查是否存在记录
return !errors.Is(result.Error, gorm.ErrRecordNotFound)
}
在 CheckExist 中,我们使用 Where API 查询名字匹配的第一条记录,然后 result 会被赋予其返回值,接下来便是使用 Is 比对错误,因为我们这个函数的目的是检查记录是否存在,所以逻辑是如果错误匹配则取反返回 false 否则返回 true。
然后便是使用 sqlite 驱动建立连接,使用自动迁移建立 sqlite 表结构
go
func main() {
db, err := gorm.Open(sqlite.Open("test.db"), &gorm.Config{})
if err != nil {
panic("failed to connect database")
}
// 自动迁移以适配User模型
db.AutoMigrate(&User{})
}
因为需要比对存在数据和不存在数据两种结果,所以我们在封装一个 TestCheckExist 减少重复。
go
func TestCheckExist(db *gorm.DB, name string) {
if CheckExist(db, name) {
fmt.Println("Exist.")
} else {
fmt.Println("Not Exist")
}
}
最后便是测试 CheckExist 是否能正常工作,分别在数据库不存在对应字段和存在字段两种情况下进行测试:
go
func main() {
// ... 建立连接等
// 自动迁移以适配User模型
db.AutoMigrate(&User{})
TestCheckExist(db, "CodeSinger")
// 新增列
user := &User {
Name: "CodeSinger",
Email: "xxx.qq.com",
}
db.Create(&user)
TestCheckExist(db, "CodeSinger")
}
结果:
go
record not found
[0.051ms] [rows:0] SELECT * FROM `users` WHERE Name = "CodeSinger" AND `users`.`deleted_at` IS NULL ORDER BY `users`.`id` LIMIT 1
Not Exist
Exist.
可以看到在没有该记录的情况下输出 Not Exist,在插入记录之后输出 Exist,表明判断逻辑正确。
ps: 这里除了我们自己的输出外的内容是 Gorm 的日志信息。