为了便于精准排查问题,需要将当前的请求信息与当前执行的 SQL 信息设置对应关系记录下来,记录的 SQL 信息包括:
数据库组件使用的是 GORM
。
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).Errorif err != nil {return nil, errors.Wrap(err, "[user_demo] get user data err")}return data, nil}
编写 CallBacks
插件代码,GORM 的 Plugin 接口的编写非常简单,只需要实现两个方法即可。
// Plugin GORM plugin interfacetype Plugin interface {Name() stringInitialize(*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.Contextctx, 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 = sqlsqlInfo.Stack = utils.FileWithLineNum()sqlInfo.Rows = db.Statement.RowsAffectedsqlInfo.CostSeconds = time.Since(ts).Seconds()ctx.Trace().AppendSQL(sqlInfo)return}
最后,在 db 连接的时候使用这个插件:
// 使用插件db.Use(&TracePlugin{})
这是编写的 trace
包的一部分,这个包可以记录这些信息:
以上代码在 go-gin-api 项目中,地址:https://github.com/xinliangnote/go-gin-api
联系客服