编写插件

Callbacks

GORM 自身也是基于 Callbacks 的,包括 CreateQueryUpdateDeleteRowRaw。此外,您也完全可以根据自己的意愿自定义 GORM

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

注册 Callback

注册 callback 至 callbacks

func cropImage(db *gorm.DB) {
if db.Statement.Schema != nil {
// 裁剪图片字段并上传到CDN,dummy code
for _, field := range db.Statement.Schema.Fields {
switch db.Statement.ReflectValue.Kind() {
case reflect.Slice, reflect.Array:
for i := 0; i < db.Statement.ReflectValue.Len(); i++ {
// 从字段中获取数值
if fieldValue, isZero := field.ValueOf(db.Statement.ReflectValue.Index(i)); !isZero {
if crop, ok := fieldValue.(CropInterface); ok {
crop.Crop()
}
}
}
case reflect.Struct:
// 从字段中获取数值
if fieldValue, isZero := field.ValueOf(db.Statement.ReflectValue); !isZero {
if crop, ok := fieldValue.(CropInterface); ok {
crop.Crop()
}
}

// 将值设置给字段
err := field.Set(db.Statement.ReflectValue, "newValue")
}
}

// 当前实体的所有字段
db.Statement.Schema.Fields

// 当前实体的所有主键字段
db.Statement.Schema.PrimaryFields

// 优先主键字段:带有数据库名称`id`或第一个定义的主键的字段。
db.Statement.Schema.PrioritizedPrimaryField

// 当前模型的所有关系
db.Statement.Schema.Relationships

// 使用字段名或数据库名查找字段
field := db.Statement.Schema.LookUpField("Name")

// processing
}
}

db.Callback().Create().Register("crop_image", cropImage)
// 为Create注册一个回调

删除 Callback

从 callbacks 中删除回调

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

替换 Callback

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

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

注册带顺序的 Callback

注册带顺序的 Callback

// gorm:create 之前
db.Callback().Create().Before("gorm:create").Register("update_created_at", updateCreated)

// gorm:create 之后
db.Callback().Create().After("gorm:create").Register("update_created_at", updateCreated)

// gorm:query 之后
db.Callback().Query().After("gorm:query").Register("my_plugin:after_query", afterQuery)

// gorm:delete 之后
db.Callback().Delete().After("gorm:delete").Register("my_plugin:after_delete", afterDelete)

// gorm:update 之前
db.Callback().Update().Before("gorm:update").Register("my_plugin:before_update", beforeUpdate)

// 位于 gorm:before_create 之后 gorm:create 之前
db.Callback().Create().Before("gorm:create").After("gorm:before_create").Register("my_plugin:before_create", beforeCreate)

// 所有其它 callback 之前
db.Callback().Create().Before("*").Register("update_created_at", updateCreated)

// 所有其它 callback 之后
db.Callback().Create().After("*").Register("update_created_at", updateCreated)

预定义 Callback

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

插件

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

type Plugin interface {
Name() string
Initialize(*gorm.DB) error
}

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

db.Config.Plugins[pluginName]

查看 Prometheus 的例子

Platinum Sponsors

Become a Sponsor!

Platinum Sponsors

Become a Sponsor!

OpenCollective Sponsors