这是我参与「第五届青训营」伴学笔记创作活动的第 14 天

Day14

Gorm

Gorm的约定(默认)

Gorm使用名为ID的字段作为主键

struct名的蛇形复数作为表名

Video -> videos
字段名的蛇形作为列名

PlayUrl -> play_url
CreatedAt、UpdatedAt字段作为创建、更新时间

type User struct {
  ID           uint
  Name         string
  Email        *string
  Age          uint8
  Birthday     *time.Time
  MemberNumber sql.NullString
  ActivedAt    sql.NullTime
  CreatedAt    time.Time
  UpdatedAt    time.Time
}

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

支持的数据库

GORM目前支持MySQL、SQLServer、PostgreSQL、SQLite。

查询

First的使用踩坑

使用First时，需要注意查询不到数据会返回ErrRecordNotFound。（还有Last、Take?）

使用Find查询多条数据，查询不到数据不会返回错误。
使用结构体作为查询条件

当使用结构作为条件查询时，GORM只会查询非零值字段。这意味着如果您的字段值为0、""、false或其他零值，该字段不会被用于构建查询条件，应该使用Map 来构建查询条件。

更新

使用struct 更新时，只会更新非零值。

如果需要更新零值可以使用Map更新或使用Select选择字段。

删除

GORM 提供了gorm.DeletedAt用于帮助用户实现软删除。

拥有软删除能力的Model调用 Delete时，记录不会被从数据库中真正删除。但 GORM会将DeletedAt置为当前时间，并且你不能再通过正常的查询方法找到该记录。

使用Unscoped可以查询到被软删的数据。

事务

Gorm提供了Begin、Commit、Rollback方法用于使用事务。

Gorm 提供了Tansaction方法用于自动提交事务，避免用户漏写Commit、Rollbcak。

tx := db.Begin()
if err = tx.Create(&Video).Error; err != nil {
    tx.Rollback()
    return
}
if err = tx.Create(&User).Error; err != nil {
    tx.Rollback()
    return
}
tx.Commit()

// 改进：避免遗忘
if err := db.Transaction(func(tx *gorm.DB) error {
    // 用匿名函数套起来
    if err = tx.Create(&Video).Error; err != nil {
        return err
    }
    if err = tx.Create(&User).Error; err != nil {
        return err
    }
    return nil
}); err != nil {
    return
}

Hook

GORM给struct提供了CRUD的 Hook能力。 Hook是在创建、查询、更新、删除等操作之前、之后自动调用的函数。如果任何Hook返回错误，GORM 将停止后续的操作并回滚事务。

// 创建用户前检查参数
func (u *User) BeforeCreate(tx *gorm.DB) (err error) {
    if u.Age<0 {
        return errors.New( text: "can't save invalid data")
    }
    return
}
// 创建用户后级联创建邮箱
func (u *User) AfterCreate(tx *gorm.DB) (err error) {
	return tx.Create(&Email{ID: u.ID, Email: u.Name + "@***.com"}).Error
}

性能提高

对于写操作（创建、更新、删除)，为了确保数据的完整性，GORM会将它们封装在事务内运行。但这会降低性能，可以使用gorm.Config.SkipDefaultTransaction关闭默认事务。

使用gorm.Config.PrepareStmt缓存预编译语句可以提高后续调用的速度，本机测试提高大约35%左右。

生态

GORM 拥有非常丰富的扩展生态，以下列举官方一部分常用扩展。

GORM代码生成工具：gen

GORM分片库方案：sharding

GORM手动索引：hints

GORM乐观锁：optimisticlock

GORM读写分离：dbresolver

GORM OpenTelemetry扩展：opentelemetry

Gorm CRUD事务Hook | 青训营笔记