Gin實踐 連載十 定製 GORM Callbacks

GORM itself is powered by Callbacks, so you could fully customize GORM as you want

原文地址：定製 GORM Callbacks
項目地址：https://github.com/EDDYCJY/go...

GORM 自己是由回調驅動的，因此咱們能夠根據須要徹底定製 GORM，以此達到咱們的目的

• 註冊一個新的回調
• 刪除現有的回調
• 替換現有的回調
• 註冊回調的順序

在 GORM 中包含以上四類 Callbacks，咱們結合項目選用 「替換現有的回調」 來解決一個小痛點

問題

在 models 目錄下，咱們包含 tag.go 和 article.go 兩個文件，他們有一個問題，就是 BeforeCreate、BeforeUpdate 重複出現了，那難道 100 個文件，就要寫一百次嗎？

一、tag.go

二、article.go

顯然這是不可能的，若是先前你已經意識到這個問題，那挺OK，但沒有的話，如今開始就要改

解決

在這裏咱們經過 Callbacks 來實現功能，不須要一個個文件去編寫

實現Callbacks

打開 models 目錄下的 models.go 文件，實現如下兩個方法：

一、updateTimeStampForCreateCallback

// updateTimeStampForCreateCallback will set `CreatedOn`, `ModifiedOn` when creating
func updateTimeStampForCreateCallback(scope *gorm.Scope) {
    if !scope.HasError() {
        nowTime := time.Now().Unix()
        if createTimeField, ok := scope.FieldByName("CreatedOn"); ok {
            if createTimeField.IsBlank {
                createTimeField.Set(nowTime)
            }
        }

        if modifyTimeField, ok := scope.FieldByName("ModifiedOn"); ok {
            if modifyTimeField.IsBlank {
                modifyTimeField.Set(nowTime)
            }
        }
    }
}

在這段方法中，會完成如下功能

• 檢查是否有含有錯誤（db.Error）
• scope.FieldByName 經過 scope.Fields() 獲取全部字段，判斷當前是否包含所需字段

for _, field := range scope.Fields() {
    if field.Name == name || field.DBName == name {
        return field, true
    }
    if field.DBName == dbName {
        mostMatchedField = field
    }
}

• field.IsBlank 可判斷該字段的值是否爲空

func isBlank(value reflect.Value) bool {
    switch value.Kind() {
    case reflect.String:
        return value.Len() == 0
    case reflect.Bool:
        return !value.Bool()
    case reflect.Int, reflect.Int8, reflect.Int16, reflect.Int32, reflect.Int64:
        return value.Int() == 0
    case reflect.Uint, reflect.Uint8, reflect.Uint16, reflect.Uint32, reflect.Uint64, reflect.Uintptr:
        return value.Uint() == 0
    case reflect.Float32, reflect.Float64:
        return value.Float() == 0
    case reflect.Interface, reflect.Ptr:
        return value.IsNil()
    }

    return reflect.DeepEqual(value.Interface(), reflect.Zero(value.Type()).Interface())
}

• 若爲空則 field.Set 用於給該字段設置值，參數爲 interface{}

二、updateTimeStampForUpdateCallback

// updateTimeStampForUpdateCallback will set `ModifyTime` when updating
func updateTimeStampForUpdateCallback(scope *gorm.Scope) {
    if _, ok := scope.Get("gorm:update_column"); !ok {
        scope.SetColumn("ModifiedOn", time.Now().Unix())
    }
}

• scope.Get(...) 根據入參獲取設置了字面值的參數，例如本文中是 gorm:update_column ，它會去查找含這個字面值的字段屬性
• scope.SetColumn(...) 假設沒有指定 update_column 的字段，咱們默認在更新回調設置 ModifiedOn 的值

註冊Callbacks

在上面小節我已經把回調方法編寫好了，接下來須要將其註冊進 GORM 的鉤子裏，但其自己自帶 Create 和 Update 回調，所以調用替換便可

在 models.go 的 init 函數中，增長如下語句

db.Callback().Create().Replace("gorm:update_time_stamp", updateTimeStampForCreateCallback)
db.Callback().Update().Replace("gorm:update_time_stamp", updateTimeStampForUpdateCallback)

驗證

訪問 AddTag 接口，成功後檢查數據庫，可發現 created_on 和 modified_on 字段都爲當前執行時間

訪問 EditTag 接口，可發現 modified_on 爲最後一次執行更新的時間

拓展

咱們想到，在實際項目中硬刪除是較少存在的，那麼是否能夠經過 Callbacks 來完成這個功能呢？

答案是能夠的，咱們在先前 Model struct 增長 DeletedOn 變量

type Model struct {
    ID int `gorm:"primary_key" json:"id"`
    CreatedOn int `json:"created_on"`
    ModifiedOn int `json:"modified_on"`
    DeletedOn int `json:"deleted_on"`
}

實現Callbacks

打開 models 目錄下的 models.go 文件，實現如下方法：

func deleteCallback(scope *gorm.Scope) {
    if !scope.HasError() {
        var extraOption string
        if str, ok := scope.Get("gorm:delete_option"); ok {
            extraOption = fmt.Sprint(str)
        }

        deletedOnField, hasDeletedOnField := scope.FieldByName("DeletedOn")

        if !scope.Search.Unscoped && hasDeletedOnField {
            scope.Raw(fmt.Sprintf(
                "UPDATE %v SET %v=%v%v%v",
                scope.QuotedTableName(),
                scope.Quote(deletedOnField.DBName),
                scope.AddToVars(time.Now().Unix()),
                addExtraSpaceIfExist(scope.CombinedConditionSql()),
                addExtraSpaceIfExist(extraOption),
            )).Exec()
        } else {
            scope.Raw(fmt.Sprintf(
                "DELETE FROM %v%v%v",
                scope.QuotedTableName(),
                addExtraSpaceIfExist(scope.CombinedConditionSql()),
                addExtraSpaceIfExist(extraOption),
            )).Exec()
        }
    }
}

func addExtraSpaceIfExist(str string) string {
    if str != "" {
        return " " + str
    }
    return ""
}

• scope.Get("gorm:delete_option") 檢查是否手動指定了delete_option
• scope.FieldByName("DeletedOn") 獲取咱們約定的刪除字段，若存在則 UPDATE 軟刪除，若不存在則 DELETE 硬刪除
• scope.QuotedTableName() 返回引用的表名，這個方法 GORM 會根據自身邏輯對錶名進行一些處理
• scope.CombinedConditionSql() 返回組合好的條件SQL，看一下方法原型很明瞭

func (scope *Scope) CombinedConditionSql() string {
    joinSQL := scope.joinsSQL()
    whereSQL := scope.whereSQL()
    if scope.Search.raw {
        whereSQL = strings.TrimSuffix(strings.TrimPrefix(whereSQL, "WHERE ("), ")")
    }
    return joinSQL + whereSQL + scope.groupSQL() +
        scope.havingSQL() + scope.orderSQL() + scope.limitAndOffsetSQL()
}

• scope.AddToVars 該方法能夠添加值做爲SQL的參數，也可用於防範SQL注入

func (scope *Scope) AddToVars(value interface{}) string {
    _, skipBindVar := scope.InstanceGet("skip_bindvar")

    if expr, ok := value.(*expr); ok {
        exp := expr.expr
        for _, arg := range expr.args {
            if skipBindVar {
                scope.AddToVars(arg)
            } else {
                exp = strings.Replace(exp, "?", scope.AddToVars(arg), 1)
            }
        }
        return exp
    }

    scope.SQLVars = append(scope.SQLVars, value)

    if skipBindVar {
        return "?"
    }
    return scope.Dialect().BindVar(len(scope.SQLVars))
}

註冊Callbacks

在 models.go 的 init 函數中，增長如下刪除的回調

db.Callback().Delete().Replace("gorm:delete", deleteCallback)

驗證

重啓服務，訪問 DeleteTag 接口，成功後便可發現 deleted_on 字段有值

小結

在這一章節中，咱們結合 GORM 完成了新增、更新、查詢的 Callbacks，在實際項目中經常也是這麼使用

畢竟，一個鉤子的事，就沒有必要本身手寫過多沒必要要的代碼了

（注意，增長了軟刪除後，先前的代碼須要增長 deleted_on 的判斷）

參考

本系列示例代碼

• go-gin-example

本系列目錄

• 連載一 Golang介紹與環境安裝
• 連載二 搭建Blog API's（一）
• 連載三 搭建Blog API's（二）
• 連載四 搭建Blog API's（三）
• 連載五 使用JWT進行身份校驗
• 連載六 編寫一個簡單的文件日誌
• 連載七 Golang優雅重啓HTTP服務
• 連載八 爲它加上Swagger
• 連載九 將Golang應用部署到Docker
• 連載十 定製 GORM Callbacks
• 連載十一 Cron定時任務
• 連載十二 優化配置結構及實現圖片上傳
• 連載十三 優化你的應用結構和實現Redis緩存
• 連載十四 實現導出、導入 Excel
• 連載十五 生成二維碼、合併海報
• 連載十六 在圖片上繪製文字
• 連載十七 用 Nginx 部署 Go 應用
• 番外 Golang交叉編譯
• 番外 請入門 Makefile

文檔

• gorm