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 信息内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • go语言区块链实战实现简单的区块与区块链

    go语言区块链实战实现简单的区块与区块链

    这篇文章主要为大家介绍了go语言区块链的实战学习,来实现简单的区块与区块链示例过程,有需要的朋友可以借鉴参考下,希望能够有所帮助
    2021-10-10
  • 使用Golang开发一个简易版shell

    使用Golang开发一个简易版shell

    这篇文章主要为大家详细介绍了如何使用Golang开发一个简易版shell,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一下
    2024-02-02
  • Go语言中结构体的高级技巧分享

    Go语言中结构体的高级技巧分享

    这篇文章主要为大家分享一下Go语言中结构体的高级技巧,文中的示例代码讲解详细,具有一定的学习价值,感兴趣的小伙伴可以跟随小编一起了解一下
    2023-08-08
  • golang sudog指的是什么

    golang sudog指的是什么

    sudog代表在等待队列中的goroutine,比如channel发送接受,由于goroutine和同步对象的关系是多对多,因此需要sudog映射,本文重点介绍golang sudog指的是什么,感兴趣的朋友一起看看吧
    2024-02-02
  • Go1.18新特性工作区模糊测试及泛型的使用详解

    Go1.18新特性工作区模糊测试及泛型的使用详解

    这篇文章主要为大家介绍了Go 1.18新特性中的工作区 模糊测试 泛型使用进行详细讲解,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2022-07-07
  • 深度解密 Go 语言中的 sync.map

    深度解密 Go 语言中的 sync.map

    这篇文章主要介绍了深度解密 Go 语言中的 sync.map,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2020-06-06
  • Go语言基于HTTP的内存缓存服务的实现

    Go语言基于HTTP的内存缓存服务的实现

    这篇文章主要介绍了Go语言基于HTTP的内存缓存服务,本程序采用REST接口,支持设置(Set)、获取(Get)和删除(Del)这3个基本操作,同时还支持对缓存服务状态进行查询,需要的朋友可以参考下
    2022-08-08
  • Golang设计模式之适配器模式介绍和代码示例

    Golang设计模式之适配器模式介绍和代码示例

    适配器是一种结构型设计模式, 它能使不兼容的对象能够相互合作,可担任两个对象间的封装器, 它会接收对于一个对象的调用, 并将其转换为另一个对象可识别的格式和接口,本文将通过代码示例详细给大家介绍Golang的适配器模式
    2023-06-06
  • 浅析Golang中的net/http路由注册与请求处理

    浅析Golang中的net/http路由注册与请求处理

    这篇文章主要为大家详细介绍了Golang中的net/http路由注册与请求处理的相关知识,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一下
    2023-12-12
  • golang实现分页算法实例代码

    golang实现分页算法实例代码

    这篇文章主要给大家介绍了关于golang实现分页算法的相关资料,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2018-09-09

最新评论