背景：

在做項(xiàng)目時(shí)缨该，遇到一個(gè)監(jiān)控需求偎行，就是每次執(zhí)行sql語句都要上報(bào)耗時(shí)到prometheus。首先想到的是在寫業(yè)務(wù)邏輯時(shí)每次執(zhí)行sql語句都自己上報(bào)，但這樣會侵入業(yè)務(wù)代碼蛤袒，而且有的人會忘了上報(bào)熄云，或者上報(bào)格式不規(guī)范，所以想到將上報(bào)邏輯封裝到gorm的框架里妙真。

具體原理：

gorm執(zhí)行sql語句都是通過注冊callback函數(shù)實(shí)現(xiàn)的缴允。如執(zhí)行如下語句時(shí)：

image

會依次執(zhí)行、queryCallback珍德、queryCallback练般、queryCallback，這是因?yàn)間orm初始化時(shí)注冊了這幾個(gè)函數(shù)：

image

如果我們想注冊些自己寫的函數(shù)呢锈候？而且想控制函數(shù)調(diào)用的順序薄料，比如想自己注冊一個(gè)函數(shù)func2，而且在queryCallback之后泵琳，queryCallback之前調(diào)用摄职，那改怎么辦？其實(shí)可以這樣：

image

其中after函數(shù)的參數(shù)就是注冊queryCallback時(shí)指定的名字获列，Register的第一個(gè)參數(shù)callbackName就是你要注冊的函數(shù)的名字谷市，callbackName要保持唯一性，否則后面Register的會覆蓋前面的蛛倦。

至此歌懒，調(diào)first函數(shù)時(shí)，將會依次調(diào)這幾個(gè)函數(shù)：queryCallback溯壶、func及皂、queryCallback、queryCallback

源碼分析：

callback的定義且改。上面的first語句會把callback func append到queries字段里验烧。

// Callback is a struct that contains all CRUD callbacks
//   Field `creates` contains callbacks will be call when creating object
//   Field `updates` contains callbacks will be call when updating object
//   Field `deletes` contains callbacks will be call when deleting object
//   Field `queries` contains callbacks will be call when querying object with query methods like Find, First, Related, Association...
//   Field `rowQueries` contains callbacks will be call when querying object with Row, Rows...
//   Field `processors` contains all callback processors, will be used to generate above callbacks in order
type Callback struct {
    logger     logger
    creates    []*func(scope *Scope)
    updates    []*func(scope *Scope)
    deletes    []*func(scope *Scope)
    queries    []*func(scope *Scope)
    rowQueries []*func(scope *Scope)
    processors []*CallbackProcessor
}

這個(gè)就是first的源碼，最后一行調(diào)callCallbacks時(shí)就會依次調(diào)queries的func又跛。

// First find first record that match given conditions, order by primary key
func (s *DB) First(out interface{}, where ...interface{}) *DB {
    newScope := s.NewScope(out)
    newScope.Search.Limit(1)

    return newScope.Set("gorm:order_by_primary_key", "ASC").
        inlineCondition(where...).callCallbacks(s.parent.callbacks.queries).db
}

func (scope *Scope) callCallbacks(funcs []*func(s *Scope)) *Scope {
    defer func() {
        if err := recover(); err != nil {
            if db, ok := scope.db.db.(sqlTx); ok {
                db.Rollback()
            }
            panic(err)
        }
    }()
    for _, f := range funcs {
        (*f)(scope)
        if scope.skipLeft {
            break
        }
    }
    return scope
}

參考文獻(xiàn)：

http://gorm.book.jasperxu.com/callbacks.html

https://gorm.io/docs/hooks.html

Gin實(shí)踐 連載十 定制 GORM Callbacks