gorm的一些使用注意（来自第三方文章，针对觉得重要的部分做一些记录）[来源]（https://www.topgoer.cn/docs/gorm/gormgengxin）
获取包 go get -u github.com/jinzhu/gorm
1.连接mysql数据库
import (
"github.com/jinzhu/gorm"
_ "github.com/jinzhu/gorm/dialects/mysql"
)
func main() {
// 为了正确的处理 time.Time ，你需要包含 parseTime 作为参数
db, err := gorm.Open("mysql", "user:password@/dbname?charset=utf8&parseTime=True&loc=Local")
defer db.Close()
}
2.gorm.Model 定义
type Model struct {
ID uint gorm:"primary_key"
CreatedAt time.Time
UpdatedAt time.Time
DeletedAt *time.Time
}
2.1将字段 ID, CreatedAt, UpdatedAt, DeletedAt 注入到 User 模型中
type User struct {
gorm.Model
Name string gorm:"default:'galeone'"
Age int
}
在结构体中可以很便捷的引入gorm.Model
CreatedAt：创建数据时会被更新
UpdatedAt ：修改数据时会被更新
DeletedAt ：删除数据时会被更新
3.表名设置问题
3.1 默认表名是users,如果设置禁用表名复数形式属性为 true，User 的表名将是 user
db.SingularTable(true)
3.2 自定义表名，重写TableName方法
func (User) TableName() string {
return "profiles"
}
3.3执行sql时指定表名
db.Table("deleted_users").CreateTable(&User{})
4.默认值失效
4.1创建时，语言数据类型默认值零值会被忽略
var user= User{Age: 99, Name: ""}
db.Create(&user) 等价于下面的sql,name为默认值，被忽略了
// INSERT INTO users("age") values('99');
要想改变这种情况必须传指针类型或者其他的值来
Age *int gorm:"default:18"
4.2 查询的时候会覆盖默认值
SELECT name from users WHERE ID=111; // 返回的主键是 111
// user.Name => 'galeone' Name string gorm:"default:'galeone'" 定义了
5.给SQL 语句添加额外选项
5.1检查约束
db.Set("gorm:insert_option", "ON CONFLICT").Create(&product)
// INSERT INTO products (name, code) VALUES ("name", "code") ON CONFLICT;
5.2加锁
db.Set("gorm:query_option", "FOR UPDATE").First(&user, 10)
//// SELECT * FROM users WHERE id = 10 FOR UPDATE;
6.gorm钩子
6.1如果你想在 BeforeCreate 函数中更新字段的值，应该使用 scope.SetColumn，例如：
func (user *User) BeforeCreate(scope *gorm.Scope) error {
scope.SetColumn("ID", uuid.New())
return nil
}
6.2 BeforeUpdate 和 AfterUpdate
// 开启事务
BeforeSave
BeforeUpdate
// 链表前的保存
// 更新时间戳 UpdatedAt
// 保存自身
// 链表后的保存
AfterUpdate
AfterSave
// 提交或回滚的事务
func (u *User) BeforeUpdate() (err error) {
if u.readonly() {
err = errors.New("read only user")
}
return
}
// 在事务结束后，进行更新数据
func (u *User) AfterUpdate(tx *gorm.DB) (err error) {
if u.Confirmed {
tx.Model(&Address{}).Where("user_id = ?", u.ID).Update("verfied", true)
}
return
}
7.查询
7.1 获取第一条记录，按主键排序
db.First(&user)
// SELECT * FROM users ORDER BY id LIMIT 1;
7.2 获取一条记录，不指定排序
db.Take(&user)
//// SELECT * FROM users LIMIT 1;
7.3 获取最后一条记录，按主键排序
db.Last(&user)
//// SELECT * FROM users ORDER BY id DESC LIMIT 1;
7.4 获取所有的记录
db.Find(&users)
//// SELECT * FROM users;
7.4 通过主键进行查询 (仅适用于主键是数字类型)
db.First(&user, 10)
//// SELECT * FROM users WHERE id = 10;
7.5获取所有匹配的记录,可以方便的做条件筛选
db:=db.Where("name = ?", "jinzhu")
if age>0{
db=db.Where("age=?",age)
}
db.Find(&users)
7.6 默认零值不生效
db.Where(&User{Name: "jinzhu", Age: 0}).Find(&users)
//SELECT * FROM users WHERE name = "jinzhu";
考虑适用指针类型或者 scanner/valuer 来避免这种情况。
// 使用指针类型
type User struct {
gorm.Model
Name string
Age *int
}
// 使用 scanner/valuer
type User struct {
gorm.Model
Name string
Age sql.NullInt64
}
7.7 查询单列数据集合
使用 Pluck 从模型中查询单个列作为集合
var names []string
db.Model(&User{}).Pluck("name", &names)
8.排序分页问题
8.1重新排序
如果后面Order的值设为true，前面的值会失效
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)
8.2分页问题
8.2.1用 -1 取消 LIMIT 限制条件
db.Limit(10).Find(&users1).Limit(-1).Find(&users2)
// SELECT * FROM users LIMIT 10; (users1)
// SELECT * FROM users; (users2)
8.2.1 用 -1 取消 OFFSET 限制条件
db.Offset(10).Find(&users1).Offset(-1).Find(&users2)
// SELECT * FROM users OFFSET 10; (users1)
// SELECT * FROM users; (users2)
9.查询数据总条数
9.1在查询链中使用 Count 时，必须放在最后一个位置，因为它会覆盖 SELECT 查询条件。
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)
10.更新数据
10.1 使用 map 更新多个属性，只会更新那些被更改了的字段
db.Model(&user).Updates(map[string]interface{}{"name": "hello", "age": 18, "actived": false})
// UPDATE users SET name='hello', age=18, actived=false, updated_at='2013-11-17 21:34:10' WHERE id=111;
10.2 使用 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;
10.2 忽略更新某个字段 Omit
db.Model(&user).Omit("name").Updates(map[string]interface{}{"name": "hello", "age": 18, "actived": false})
// UPDATE users SET age=18, actived=false, updated_at='2013-11-17 21:34:10' WHERE id=111;
10.3批量更新时，钩子函数不会执行
10.4带有表达式的 SQL 更新
DB.Model(&product).Update("price", gorm.Expr("price * ? + ?", 2, 100))
//// UPDATE "products" SET "price" = price * '2' + '100', "updated_at" = '2013-11-17 21:34:10' WHERE "id" = '2';
DB.Model(&product).Updates(map[string]interface{}{"price": gorm.Expr("price * ? + ?", 2, 100)})
//// UPDATE "products" SET "price" = price * '2' + '100', "updated_at" = '2013-11-17 21:34:10' WHERE "id" = '2';
DB.Model(&product).UpdateColumn("quantity", gorm.Expr("quantity - ?", 1))
//// UPDATE "products" SET "quantity" = quantity - 1 WHERE "id" = '2';
DB.Model(&product).Where("quantity > 1").UpdateColumn("quantity", gorm.Expr("quantity - ?", 1))
//// UPDATE "products" SET "quantity" = quantity - 1 WHERE "id" = '2' AND quantity > 1;
10.5钩子函数中更新值
func (user *User) BeforeSave(scope *gorm.Scope) (err error) {
if pw, err := bcrypt.GenerateFromPassword(user.Password, 0); err == nil {
scope.SetColumn("EncryptedPassword", pw)
}
}
11.删除数据
11.1软删除
如果模型中有 DeletedAt 字段，它将自动拥有软删除的能力！当执行删除操作时，数据并不会永久的从数据库中删除，而是将 DeletedAt 的值更新为当前时间。
// 批量删除
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;
// 使用 Unscoped 方法永久删除记录
db.Unscoped().Delete(&order)
// DELETE FROM orders WHERE id=10;
12.没找到错误处理
GORM 提供了一个处理 RecordNotFound 错误的快捷方式，如果发生了多个错误，它将检查每个错误，如果它们中的任何一个是RecordNotFound 错误。
//检查是否返回 RecordNotFound 错误
db.Where("name = ?", "hello world").First(&user).RecordNotFound()
if db.Model(&user).Related(&credit_card).RecordNotFound() {
// 数据没有找到
}
if err := db.Where("name = ?", "jinzhu").First(&user).Error; gorm.IsRecordNotFoundError(err) {
// 数据没有找到
}
网友评论