Go基于GORM 获取当前请求所执行的 SQL 信息(思路详解)

 更新时间:2021年01月18日 17:10:47   投稿:mrr  
这篇文章主要介绍了Go基于GORM 获取当前请求所执行的 SQL 信息(思路详解),本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下

前言

为了便于精准排查问题,需要将当前的请求信息与当前执行的 SQL 信息设置对应关系记录下来,记录的 SQL 信息包括:

  • 执行 SQL 的当前时间;
  • 执行 SQL 的文件地址和行号;
  • 执行 SQL 的花费时长;
  • 执行 SQL 的影响行数;
  • 执行的 SQL 语句;

数据库组件使用的是GORM

思路

1、在执行 SQL 前,设置开始执行时间(计算执行时长会用到);

2、在执行 SQL 后,第一,获取当前请求的上下文,为什么获取上下文,因为需要从上下文中获取本次请求信息,第二,获取 SQL 执行前的时间,用来计算执行时长,第三,获取执行的 SQL 信息,然后将数据设置到Trace中,Trace是项目中链路包,后面文章会对其介绍;

上面需要用到GORM两个 知识点 CallbacksContext,这两个是在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 信息内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • GoLang协程库libtask学习笔记

    GoLang协程库libtask学习笔记

    libtask一个C语言的协程库,是go语言的前身很早期的原型. 测试机器是我的mac air 安装的centos虚拟机(只有一个核), 代码没有采用任何优化,只是使用默认配置
    2022-12-12
  • Go语言映射内部实现及基础功能实战

    Go语言映射内部实现及基础功能实战

    这篇文章主要为大家介绍了Go语言映射的内部实现和基础功能实战,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪<BR>
    2022-03-03
  • Go每日一库之zap日志库的安装使用指南

    Go每日一库之zap日志库的安装使用指南

    这篇文章主要为大家介绍了Go每日一库之zap安装使用示例学习,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2023-05-05
  • GO env环境变量配置命令使用

    GO env环境变量配置命令使用

    这篇文章主要为大家介绍了GO env环境变量配置命令使用,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2023-05-05
  • 使用golang开发一个curl命令行工具

    使用golang开发一个curl命令行工具

    这篇文章主要为大家详细介绍了如何使用golang开发一个简单的curl命令行工具,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一下
    2023-11-11
  • 深入理解Golang的反射reflect示例

    深入理解Golang的反射reflect示例

    本文主要介绍了Golang的反射reflect示例,文中通过示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2022-01-01
  • 详解go mod 使用方法

    详解go mod 使用方法

    golang 提供了 go mod命令来管理包,是go的一个模块管理工具,用来代替传统的GOPATH方案,本文给大家介绍go mod 使用方法,感兴趣的朋友一起看看吧
    2022-05-05
  • Go语言中的错误处理最佳实践详解

    Go语言中的错误处理最佳实践详解

    这篇文章主要为大家详细介绍了Go语言中的错误处理的相关知识,文中的示例代码讲解详细,对我们深入了解Go语言有一定的帮助,需要的可以参考下
    2023-08-08
  • GO中的时间操作总结(time&dateparse)

    GO中的时间操作总结(time&dateparse)

    日常开发过程中,对于时间的操作可谓是无处不在,但是想实现时间自由还是不简单的,多种时间格式容易混淆,本文为大家整理了一下GO中的时间操作,有需要的可以参考下
    2023-09-09
  • go json转换实践中遇到的坑

    go json转换实践中遇到的坑

    在使用 go 语言开发过程中,经常需要使用到 json 包来进行 json 和 struct 的互相转换,这篇文章主要介绍了go json转换实践中遇到的坑,非常具有实用价值,需要的朋友可以参考下
    2018-12-12

最新评论