在go-gorm/gen中实现全局Hook自动注入的最佳实践

背景介绍

在使用go-gorm/gen进行数据库模型生成时，开发者经常需要为所有表添加统一的Hook逻辑，比如记录操作人信息、自动更新时间戳等。传统做法需要为每个模型手动添加Hook方法，这在大型项目中会带来大量重复工作。

核心解决方案

go-gorm/gen提供了强大的模板配置功能，允许开发者在生成模型代码时自动注入Hook方法。通过合理配置生成模板，可以实现：

1. 全局Hook注入：所有生成的模型自动包含预设的Hook方法
2. 统一行为管理：确保所有表遵循相同的操作审计规范
3. 减少重复代码：避免为每个模型单独编写相似代码

实现步骤详解

1. 配置生成模板

在gen工具配置中，通过WithMethod选项指定自定义模板，模板中可以包含BeforeCreate、BeforeUpdate等Hook方法：

g.GenerateModel("users", gen.WithMethod(
    `func (m *{{.StructName}}) BeforeCreate(tx *gorm.DB) error {
        // 获取上下文中的操作人信息
        if user, ok := tx.Statement.Context.Value("operator").(string); ok {
            m.CreatedBy = user
            m.UpdatedBy = user
        }
        return nil
    }`,
))

2. 上下文数据传递

确保在数据库操作时传递包含必要信息的上下文：

db.WithContext(context.WithValue(ctx, "operator", "currentUser")).Create(&user)

3. 批量应用配置

对于需要统一Hook的所有表，可以通过循环或配置批量应用相同的模板：

models := []string{"users", "products", "orders"}
for _, model := range models {
    g.GenerateModel(model, gen.WithMethod(hookTemplate))
}

高级应用场景

1. 审计追踪：自动记录创建/更新时间、操作人
2. 数据校验：统一的数据有效性检查
3. 业务逻辑：自动计算衍生字段
4. 权限控制：基于上下文的访问控制

注意事项

1. 性能考量：Hook方法应保持轻量，避免复杂计算
2. 错误处理：妥善处理Hook中的错误，避免影响主流程
3. 测试覆盖：确保生成的Hook方法有充分的测试用例
4. 模板维护：将复杂模板提取为独立文件便于管理

总结

通过go-gorm/gen的模板配置功能，开发者可以优雅地实现全局Hook的自动注入，大幅提升开发效率并保证代码一致性。这种方法特别适合需要统一审计、日志或业务逻辑的中大型项目，是gorm/gen高级应用的典型场景。