Callbacks

GORM 自身也是基于 Callbacks 的，包括 Create、Query、Update、Delete、Row、Raw。此外，您也完全可以根据自己的意愿自定义 GORM

回调会注册到全局 *gorm.DB，而不是会话级别。如果您想要 *gorm.DB 具有不同的回调，您需要初始化另一个 *gorm.DB

注册 Callback

注册 callback 至 callbacks

  1. func cropImage(db *gorm.DB) {
  2.   if db.Statement.Schema != nil {
  3.     // crop image fields and upload them to CDN, dummy code
  4.     for _, field := range db.Statement.Schema.Fields {
  5.       switch db.Statement.ReflectValue.Kind() {
  6.       case reflect.Slice, reflect.Array:
  7.         for i := 0; i < db.Statement.ReflectValue.Len(); i++ {
  8.           // Get value from field
  9.           if fieldValue, isZero := field.ValueOf(db.Statement.Context, db.Statement.ReflectValue.Index(i)); !isZero {
  10.             if crop, ok := fieldValue.(CropInterface); ok {
  11.               crop.Crop()
  12.             }
  13.           }
  14.         }
  15.       case reflect.Struct:
  16.         // Get value from field
  17.         if fieldValue, isZero := field.ValueOf(db.Statement.Context, db.Statement.ReflectValue); !isZero {
  18.           if crop, ok := fieldValue.(CropInterface); ok {
  19.             crop.Crop()
  20.           }
  21.         }
  23.         // Set value to field
  24.         err := field.Set(db.Statement.Context, db.Statement.ReflectValue, "newValue")
  25.       }
  26.     }
  28.     // All fields for current model
  29.     db.Statement.Schema.Fields
  31.     // All primary key fields for current model
  32.     db.Statement.Schema.PrimaryFields
  34.     // Prioritized primary key field: field with DB name `id` or the first defined primary key
  35.     db.Statement.Schema.PrioritizedPrimaryField
  37.     // All relationships for current model
  38.     db.Statement.Schema.Relationships
  40.     // Find field with field name or db name
  41.     field := db.Statement.Schema.LookUpField("Name")
  43.     // processing
  44.   }
  45. }
  47. db.Callback().Create().Register("crop_image", cropImage)
  48. // register a callback for Create process

删除 Callback

从 callbacks 中删除回调

  1. db.Callback().Create().Remove("gorm:create")
  2. // 从 Create 的 callbacks 中删除 `gorm:create`

替换 Callback

用一个新的回调替换已有的同名回调

  1. db.Callback().Create().Replace("gorm:create", newCreateFunction)
  2. // 用新函数 `newCreateFunction` 替换 Create 流程目前的 `gorm:create`

注册带顺序的 Callback

注册带顺序的 Callback

  1. // gorm:create 之前
  2. db.Callback().Create().Before("gorm:create").Register("update_created_at", updateCreated)
  4. // gorm:create 之后
  5. db.Callback().Create().After("gorm:create").Register("update_created_at", updateCreated)
  7. // gorm:query 之后
  8. db.Callback().Query().After("gorm:query").Register("my_plugin:after_query", afterQuery)
  10. // gorm:delete 之后
  11. db.Callback().Delete().After("gorm:delete").Register("my_plugin:after_delete", afterDelete)
  13. // gorm:update 之前
  14. db.Callback().Update().Before("gorm:update").Register("my_plugin:before_update", beforeUpdate)
  16. // 位于 gorm:before_create 之后 gorm:create 之前
  17. db.Callback().Create().Before("gorm:create").After("gorm:before_create").Register("my_plugin:before_create", beforeCreate)
  19. // 所有其它 callback 之前
  20. db.Callback().Create().Before("*").Register("update_created_at", updateCreated)
  22. // 所有其它 callback 之后
  23. db.Callback().Create().After("*").Register("update_created_at", updateCreated)

预定义 Callback

GORM 已经定义了 一些 callback 来支持当前的 GORM 功能，在启动您的插件之前可以先看看这些 callback

插件

GORM 提供了 Use 方法来注册插件，插件需要实现 Plugin 接口

  1. type Plugin interface {
  2.   Name() string
  3.   Initialize(*gorm.DB) error
  4. }

当插件首次注册到 GORM 时将调用 Initialize 方法，且 GORM 会保存已注册的插件，你可以这样访问访问：

  1. db.Config.Plugins[pluginName]

查看 Prometheus 的例子