当前位置：首页 > news >正文

Gorm（五）钩子实践

news 2025/10/27 9:23:22

在 Gorm 中，BeforeCreate、AfterUpdate 等钩子函数（Hooks） 用于在数据库操作的特定阶段执行自定义逻辑，例如自动填充时间、生成雪花 ID、数据校验等。这些钩子能极大简化重复逻辑，确保数据一致性。

一、钩子函数的基本概念

钩子函数是定义在模型结构体上的方法，Gorm 会在执行特定操作（如创建、更新、删除）的前后自动调用。常见的钩子包括：

钩子函数	触发时机（以 `User` 模型为例）
`BeforeCreate`	执行 `Create(&user)` 之前
`AfterCreate`	执行 `Create(&user)` 之后（记录已写入数据库）
`BeforeUpdate`	执行 `Update`/`Save` 之前（更新操作前）
`AfterUpdate`	执行 `Update`/`Save` 之后（更新操作完成）
`BeforeDelete`	执行 `Delete(&user)` 之前（删除操作前）
`AfterDelete`	执行 `Delete(&user)` 之后（删除操作完成）
`BeforeSave`	执行 `Create` 或 `Update` 之前（涵盖新增和更新）
`AfterSave`	执行 `Create` 或 `Update` 之后（涵盖新增和更新）

二、实战场景：用钩子自动填充时间、生成雪花 ID

场景1：自动填充时间（替代默认的 `CreatedAt`/`UpdatedAt`）

Gorm 的 gorm.Model 已默认通过钩子自动维护 CreatedAt 和 UpdatedAt，但如果需要自定义时间格式或逻辑，可通过钩子重写：

import ("time""gorm.io/gorm"
)type User struct {ID        uint64Name      stringCreateTime time.Time // 自定义创建时间UpdateTime time.Time // 自定义更新时间
}// BeforeCreate：创建前自动填充 CreateTime
func (u *User) BeforeCreate(tx *gorm.DB) error {u.CreateTime = time.Now() // 填充当前时间return nil // 无错误，继续执行创建操作
}// BeforeUpdate：更新前自动填充 UpdateTime
func (u *User) BeforeUpdate(tx *gorm.DB) error {u.UpdateTime = time.Now() // 填充当前时间return nil
}

说明：

钩子函数返回 error 时，Gorm 会终止后续操作（可用于数据校验失败的场景）。
若模型嵌入 gorm.Model，其默认的 CreatedAt/UpdatedAt 仍会生效，如需禁用可自定义模型不嵌入。

场景2：生成雪花 ID（替代自增主键）

雪花 ID（Snowflake ID）是分布式系统中常用的唯一 ID 生成算法，可通过 BeforeCreate 钩子在创建记录前自动生成：

import ("github.com/bwmarrin/snowflake" // 第三方雪花 ID 库"gorm.io/gorm"
)// 初始化雪花 ID 生成器（全局唯一，建议在程序启动时初始化）
var node *snowflake.Node
func init() {var err errornode, err = snowflake.NewNode(1) // 节点 ID（分布式环境需保证唯一）if err != nil {panic(err)}
}type User struct {ID       uint64 `gorm:"primaryKey"` // 雪花 ID 作为主键Name     stringEmail    string
}// BeforeCreate：创建前生成雪花 ID
func (u *User) BeforeCreate(tx *gorm.DB) error {u.ID = uint64(node.Generate()) // 生成雪花 ID 并赋值给主键return nil
}

使用：

user := User{Name: "Alice", Email: "alice@example.com"}
db.Create(&user) // 自动触发 BeforeCreate，ID 被设置为雪花 ID

三、钩子函数的注意事项

函数签名固定
钩子函数必须是模型的方法，且签名为 func (t *T) HookName(tx *gorm.DB) error（T 为模型类型），否则 Gorm 无法识别。
事务上下文
钩子函数接收的 *gorm.DB（tx）是当前操作的事务上下文，可在钩子中执行额外的数据库操作（如关联数据处理），且会与主操作在同一事务中。

示例：创建用户时自动创建关联的默认角色：
```
func (u *User) AfterCreate(tx *gorm.DB) error {// 在同一事务中创建默认角色关联return tx.Create(&UserRole{UserID: u.ID, RoleID: 1}).Error
}
```
避免循环调用
钩子中不要再次调用会触发自身的方法（如 tx.Create(u)），否则会导致无限循环。
优先级
若模型嵌入了其他结构体（如 gorm.Model），钩子函数会优先执行当前模型的方法，再执行嵌入结构体的钩子。
性能影响
钩子会增加操作的额外逻辑，复杂逻辑可能影响性能，需合理设计。