关于golang:Go-基于-GORM-获取当前请求所执行的-SQL-信息

5次阅读

共计 2765 个字符，预计需要花费 7 分钟才能阅读完成。

为了便于精准排查问题，须要将以后的申请信息与以后执行的 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 连贯的时候应用这个插件：