Go基于GORM 獲取當(dāng)前請(qǐng)求所執(zhí)行的 SQL 信息(思路詳解)

更新時(shí)間：2021年01月18日 17:10:47 投稿：mrr

這篇文章主要介紹了Go基于GORM 獲取當(dāng)前請(qǐng)求所執(zhí)行的 SQL 信息(思路詳解),本文給大家介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或工作具有一定的參考借鑒價(jià)值，需要的朋友可以參考下

前言

為了便于精準(zhǔn)排查問題，需要將當(dāng)前的請(qǐng)求信息與當(dāng)前執(zhí)行的 SQL 信息設(shè)置對(duì)應(yīng)關(guān)系記錄下來(lái)，記錄的 SQL 信息包括：

執(zhí)行 SQL 的當(dāng)前時(shí)間；
執(zhí)行 SQL 的文件地址和行號(hào)；
執(zhí)行 SQL 的花費(fèi)時(shí)長(zhǎng)；
執(zhí)行 SQL 的影響行數(shù)；
執(zhí)行的 SQL 語(yǔ)句；

數(shù)據(jù)庫(kù)組件使用的是GORM。

思路

1、在執(zhí)行 SQL 前，設(shè)置開始執(zhí)行時(shí)間（計(jì)算執(zhí)行時(shí)長(zhǎng)會(huì)用到）；

2、在執(zhí)行 SQL 后，第一，獲取當(dāng)前請(qǐng)求的上下文，為什么獲取上下文，因?yàn)樾枰獜纳舷挛闹蝎@取本次請(qǐng)求信息，第二，獲取 SQL 執(zhí)行前的時(shí)間，用來(lái)計(jì)算執(zhí)行時(shí)長(zhǎng)，第三，獲取執(zhí)行的 SQL 信息，然后將數(shù)據(jù)設(shè)置到Trace中，Trace是項(xiàng)目中鏈路包，后面文章會(huì)對(duì)其介紹；

上面需要用到GORM兩個(gè) 知識(shí)點(diǎn) Callbacks和Context，這兩個(gè)是在GORM V2才有的，需要 import 的包為gorm.io/gorm。

演示代碼

Context的傳遞需要使用GORM V2提供的WithContext()方法。

func (u *userRepo) getUserByID(ctx core.Context, id uint) (*user_model.UserDemo, error) {
 data := new(user_model.UserDemo)
 err := u.db.GetDbR().WithContext(ctx).First(data, id).Error
 if err != nil {
 return nil, errors.Wrap(err, "[user_demo] get user data err")
 }
 return data, nil
}

編寫CallBacks插件代碼，GORM 的 Plugin 接口的編寫非常簡(jiǎn)單，只需要實(shí)現(xiàn)兩個(gè)方法即可。

// Plugin GORM plugin interface
type Plugin interface {
 Name() string
 Initialize(*DB) error
}

下面是我寫的插件代碼：

type TracePlugin struct{}

func (op *TracePlugin) Name() string {
 return "tracePlugin"
}

func (op *TracePlugin) Initialize(db *gorm.DB) (err error) {
 // 開始前
 _ = db.Callback().Create().Before("gorm:before_create").Register(callBackBeforeName, before)
 _ = db.Callback().Query().Before("gorm:query").Register(callBackBeforeName, before)
 _ = db.Callback().Delete().Before("gorm:before_delete").Register(callBackBeforeName, before)
 _ = db.Callback().Update().Before("gorm:setup_reflect_value").Register(callBackBeforeName, before)
 _ = db.Callback().Row().Before("gorm:row").Register(callBackBeforeName, before)
 _ = db.Callback().Raw().Before("gorm:raw").Register(callBackBeforeName, before)

 // 結(jié)束后
 _ = db.Callback().Create().After("gorm:after_create").Register(callBackAfterName, after)
 _ = db.Callback().Query().After("gorm:after_query").Register(callBackAfterName, after)
 _ = db.Callback().Delete().After("gorm:after_delete").Register(callBackAfterName, after)
 _ = db.Callback().Update().After("gorm:after_update").Register(callBackAfterName, after)
 _ = db.Callback().Row().After("gorm:row").Register(callBackAfterName, after)
 _ = db.Callback().Raw().After("gorm:raw").Register(callBackAfterName, after)
 return
}

var _ gorm.Plugin = &TracePlugin{}

func before(db *gorm.DB) {
 db.InstanceSet(startTime, time.Now())
 return
}

func after(db *gorm.DB) {
 _ctx := db.Statement.Context
 ctx, ok := _ctx.(core.Context)
 if !ok {
 return
 }

 _ts, isExist := db.InstanceGet(startTime)
 if !isExist {
 return
 }

 ts, ok := _ts.(time.Time)
 if !ok {
 return
 }

 sql := db.Dialector.Explain(db.Statement.SQL.String(), db.Statement.Vars...)

 sqlInfo := new(trace.SQL)
 sqlInfo.Timestamp = time_parse.CSTLayoutString()
 sqlInfo.SQL = sql
 sqlInfo.Stack = utils.FileWithLineNum()
 sqlInfo.Rows = db.Statement.RowsAffected
 sqlInfo.CostSeconds = time.Since(ts).Seconds()
 ctx.Trace().AppendSQL(sqlInfo)

 return
}

最后，在 db 連接的時(shí)候使用這個(gè)插件：

// 使用插件
db.Use(&TracePlugin{})

效果

小結(jié)

這是編寫的trace包的一部分，這個(gè)包可以記錄這些信息（JSON 格式）：

支持設(shè)置 trace_id
支持設(shè)置 request 信息
支持設(shè)置 response 信息
支持設(shè)置 third_party_requests 三方請(qǐng)求信息
支持設(shè)置 debugs 打印調(diào)試信息
支持設(shè)置 sqls 執(zhí)行 SQL 信息
可記錄 cost_seconds 執(zhí)行時(shí)長(zhǎng)

以上代碼在 go-gin-api 項(xiàng)目中，地址：

github.com/xinliangnote/go-gin-api

到此這篇關(guān)于Go基于GORM 獲取當(dāng)前請(qǐng)求所執(zhí)行的 SQL 信息的文章就介紹到這了,更多相關(guān)Go 獲取當(dāng)前請(qǐng)求所執(zhí)行的 SQL 信息內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: