前言
為了便于精準排查問題，需要將當前的請求信息與當前執行的 SQL 信息設置對應關系記錄下來，記錄的 SQL 信息包括：
- 執行 SQL 的當前時間；
- 執行 SQL 的文件地址和行號；
- 執行 SQL 的花費時長；
- 執行 SQL 的影響行數；
- 執行的 SQL 語句；
數據庫組件使用的是GORM。
思路
1、在執行 SQL 前，設置開始執行時間（計算執行時長會用到）；
2、在執行 SQL 后，第一，獲取當前請求的上下文，為什么獲取上下文，因為需要從上下文中獲取本次請求信息，第二，獲取 SQL 執行前的時間，用來計算執行時長，第三，獲取執行的 SQL 信息，然后將數據設置到Trace中，Trace是項目中鏈路包，后面文章會對其介紹；
上面需要用到GORM兩個 知識點 Callbacks和Context，這兩個是在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 接口的編寫非常簡單，只需要實現兩個方法即可。
// 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)
// 結束后
_ = 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 連接的時候使用這個插件：
// 使用插件
db.Use(TracePlugin{})
效果
小結
這是編寫的trace包的一部分，這個包可以記錄這些信息（JSON 格式）：
- 支持設置 trace_id
- 支持設置 request 信息
- 支持設置 response 信息
- 支持設置 third_party_requests 三方請求信息
- 支持設置 debugs 打印調試信息
- 支持設置 sqls 執行 SQL 信息
- 可記錄 cost_seconds 執行時長
以上代碼在 go-gin-api 項目中，地址：
github.com/xinliangnote/go-gin-api
到此這篇關于Go基于GORM 獲取當前請求所執行的 SQL 信息的文章就介紹到這了,更多相關Go 獲取當前請求所執行的 SQL 信息內容請搜索腳本之家以前的文章或繼續瀏覽下面的相關文章希望大家以后多多支持腳本之家！
您可能感興趣的文章:- gorm update傳入struct對象,零值字段不更新的解決方案
- gorm操作MySql數據庫的方法
- Golang 使用gorm添加數據庫排他鎖,for update
- golang Gorm與數據庫完整性約束詳解
- golang gorm 結構體的表字段缺省值設置方式
- golang gorm 計算字段和獲取sum()值的實現
- gorm FirstOrCreate和受影響的行數實例
- 解決Go gorm踩過的坑
