xorm框架通过调用 engine.setlogger() 方法并传入实现了 xorm.logger 接口的对象来开启sql日志打印。默认情况下,xorm不会输出任何sql语句,开发者只需实例化一个内置的 xorm.stdlogger 或自定义日志器,并将其设置到引擎中,即可在控制台看到完整的sql执行过程、参数绑定及耗时信息。

如何配置标准日志输出级别?
要查看详细的调试信息,需要配置日志的输出级别。XORM提供了多种日志级别,包括 LOG_DEBUG(显示所有SQL)、LOG_INFO(仅显示慢SQL)和 LOG_ERR(仅显示错误)。通过修改 StdLogger 的 ShowSQL 布尔值以及 LogLevel 整数属性,可以精确控制输出的内容。例如,将 ShowSQL 设为 true 且 LogLevel 设为 3 时,会打印所有执行的SQL语句及其参数。

package main
import (
"fmt"
"log"
"os"
"xorm.io/xorm"
"xorm.io/xorm/log"
)
type User struct {
Id int64
Name string
}
func main() {
// 创建引擎
engine, err := xorm.NewEngine("mysql", "root:root@tcp(127.0.0.1:3306)/test?charset=utf8")
if err != nil {
log.Fatal(err)
}
// 1. 初始化标准日志器
logger := &xorm.StdLogger{}
// 2. 设置日志级别:3 代表 DEBUG,显示所有SQL
logger.ShowLevel = true
logger.LogLevel = 3
// 3. 关键步骤:将日志器设置到引擎中
engine.SetLogger(logger)
// 开启SQL打印开关
engine.ShowSQL(true)
// 同步表结构
err = engine.Sync2(new(User))
if err != nil {
log.Fatal(err)
}
// 执行插入操作,此时控制台会打印SQL
_, err = engine.Insert(&User{Name: "debug_user"})
if err != nil {
log.Fatal(err)
}
fmt.Println("SQL logging enabled.")
}
运行上述代码后,控制台将输出类似以下的日志:[xorm] [info] 2023/10/27 10:00:00.123 INSERT INTO `user` (`name`) VALUES (?) [debug_user] - elapsed: 1.2ms
如何自定义日志格式与输出目标?
如果默认的日志格式无法满足需求,或者需要将日志写入文件而非控制台,可以实现自定义的 xorm.Logger 接口。该接口包含 Debug、Info、Warn 和 Error 四个方法。通过实现这些方法,可以将SQL日志重定向到 logrus、zap 等第三方日志库,或者追加到特定的日志文件中。这种方式适用于生产环境中的精细化日志管理。

package main
import (
"fmt"
"log"
"os"
"xorm.io/xorm"
"xorm.io/xorm/core"
)
// 自定义日志器结构体
type CustomLogger struct {
file *os.File
}
// 实现 xorm.Logger 接口
func (l *CustomLogger) Debug(v ...interface{}) error {
return l.writeLog("DEBUG", v...)
}
func (l *CustomLogger) Info(v ...interface{}) error {
return l.writeLog("INFO", v...)
}
func (l *CustomLogger) Warn(v ...interface{}) error {
return l.writeLog("WARN", v...)
}
func (l *CustomLogger) Error(v ...interface{}) error {
return l.writeLog("ERROR", v...)
}
func (l *CustomLogger) writeLog(level string, v ...interface{}) error {
// 简单拼接日志内容
msg := fmt.Sprintf("[%s] %v\n", level, v)
_, err := l.file.WriteString(msg)
return err
}
func main() {
engine, err := xorm.NewEngine("sqlite3", "test.db")
if err != nil {
log.Fatal(err)
}
// 打开日志文件
f, err := os.OpenFile("xorm.log", os.O_CREATE|os.O_WRONLY|os.O_APPEND, 0644)
if err != nil {
log.Fatal(err)
}
defer f.Close()
// 设置自定义日志器
engine.SetLogger(&CustomLogger{file: f})
engine.ShowSQL(true)
// 执行操作触发日志写入
type Item struct { ID int64; Name string }
engine.Sync2(new(Item))
engine.Insert(&Item{Name: "custom_log_test"})
fmt.Println("Check xorm.log for details.")
}
此段代码展示了如何将日志输出到本地文件 xorm.log。通过实现 Debug、Info 等方法,开发者完全控制了日志的存储位置和内容格式。执行后,SQL语句将不再打印到控制台,而是追加到指定文件中。
当使用事务时SQL日志如何表现?
在使用 engine.Begin() 开启事务后,所有的SQL操作都会包裹在事务上下文中。此时,日志输出会清晰地展示 BEGIN、具体的业务SQL以及最终的 COMMIT 或 ROLLBACK 语句。这对于排查事务隔离级别问题或死锁原因非常有用。日志中会明确标记出哪些语句属于同一个事务ID,帮助开发者追踪事务的生命周期。



















