一、Gorm打印SQL基础
Gorm是一个Go语言的ORM库,它允许我们使用Go语言语法操作数据库。
在默认情况下,Gorm不会打印与数据库相关的任何信息。Gorm提供了两种方式来打印执行的SQL。
二、使用log记录执行的SQL
log记录执行的SQL是一种简单有效的方法。我们可以设置log的级别来控制日志的数量和详细程度。例如,记录所有的SQL语句:
db.LogMode(true)
// ...
db.Table("users").Where("name = ?", "jinzhu").Find(&users)
当Gorm执行查询时,将会打印对应的SQL:
[2020-07-23 20:26:46] [rows:1] SELECT * FROM "users" WHERE (name = 'jinzhu')
此外,你还可以使用自定义的日志记录器。对于某些项目,我们可能想把SQL反馈到统一的日志管理系统,这时可以使用自定义的日志记录器。
三、使用callback记录执行的SQL
除了log的方式,Gorm还提供了callback的方式。
使用callback记录执行的SQL的方式是,在查询的时候,通过callback函数得到全部的SQL数据。callback是Gorm特有的一种机制,其作用是钩子,程序在执行到特定的位置时会自动执行钩子函数。
为了使用callback,首先要定义我们的callback函数:
func afterQueryCallback(scope *gorm.Scope) {
log.Printf("executed raw sql: %v", scope.SQL)
}
然后就可以使用callback记录执行的SQL了:
db.Callback().Query().After("gorm:query").Register("my_plugin:after_query", afterQueryCallback)
当Gorm执行查询时,回调函数将会被调用,并打印SQL:
[2020-07-23 20:26:46] [rows:1] SELECT * FROM "users" WHERE (name = 'jinzhu')
四、使用Debug函数记录执行的SQL
GORM提供了一个Debug函数,在调用它时,你可以看到生成的SQL语句和调用的参数。这个函数可以帮助你排除错误,或者理解GORM是如何操作数据库的。
使用Debug函数是非常简单的。只需传递一个GORM DB实例作为参数即可:
db.Debug().Table("users").Where("name = ?", "jinzhu").Find(&users)
当我们使用Debug函数时,会产生如下的输出:
[0.22ms] SELECT * FROM "users" WHERE (name = 'jinzhu') ORDER BY id
//此处还会输出方法调用的参数
五、总结
本文介绍了四种对Gorm打印SQL的方法:使用log记录,使用callback记录,使用Debug函数,以及自定义日志记录器。每种方法功能不同,也存在一些局限性。我们可以根据具体的应用场景和需求,来选择合适的方法。