在xorm框架中,debug日志的开启依赖于底层使用的logger接口。默认情况下,xorm使用`xorm.logger`接口,通过调用`engine.setlogger()`方法并传入一个实现了该接口的自定义结构体即可实现日志分级。具体做法是定义一个结构体实现`debug`、`info`、`warn`、`error`四个方法,并在`debug`方法中将日志输出到标准输出或文件,其他级别按需处理。这样设置后,执行sql操作时,调试级别的详细sql语句和参数将被打印出来,方便排查问题。

如何配置不同级别的日志输出目标?
要实现日志分级,核心在于自定义Logger结构体的各个方法。通常的做法是将Debug日志输出到控制台以便开发时查看,而将Error日志写入文件以便生产环境记录。通过判断日志级别,可以将不同的日志重定向到不同的Writer。例如,Debug和Info级别可以共用一个控制台Writer,而Error级别则单独写入一个文件Writer。这种分离方式既保证了开发时的便利性,又满足了生产环境的审计需求。

package main
import (
"fmt"
"log"
"os"
"time"
"xorm.io/xorm"
"xorm.io/xorm/log"
)
// CustomLogger 实现 xorm.Logger 接口
type CustomLogger struct {
debugLog *log.Logger
errorLog *log.Logger
}
func NewCustomLogger() *CustomLogger {
// Debug日志输出到控制台
debugLog := log.New(os.Stdout, "[DEBUG] ", log.LstdFlags)
// Error日志输出到文件
f, err := os.OpenFile("error.log", os.O_CREATE|os.O_WRONLY|os.O_APPEND, 0644)
if err != nil {
panic(err)
}
errorLog := log.New(f, "[ERROR] ", log.LstdFlags)
return &CustomLogger{
debugLog: debugLog,
errorLog: errorLog,
}
}
func (l *CustomLogger) Debug(v interface{}) {
l.debugLog.Println(v)
}
func (l *CustomLogger) Info(v interface{}) {
// Info级别可以选择性输出,这里暂不输出
}
func (l *CustomLogger) Warn(v interface{}) {
// Warn级别可以选择性输出
}
func (l *CustomLogger) Error(v interface{}) {
l.errorLog.Println(v)
}
func main() {
// 创建引擎并设置自定义Logger
engine, err := xorm.NewEngine("mysql", "root:root@tcp(127.0.0.1:3306)/test?charset=utf8")
if err != nil {
log.Fatal(err)
}
engine.SetLogger(NewCustomLogger())
// 同步表结构
type User struct {
ID int64
Name string
}
engine.Sync2(new(User))
// 插入数据以触发Debug日志
_, err = engine.Insert(&User{Name: "test_user"})
if err != nil {
log.Fatal(err)
}
fmt.Println("Operation completed.")
}
上述代码定义了一个`CustomLogger`结构体,分别初始化了用于Debug的控制台Logger和用于Error的文件Logger。在`main`函数中,通过`engine.SetLogger()`将自定义Logger注入到XORM引擎中。当执行`Insert`操作时,由于开启了Debug日志(XORM默认在Debug模式下会打印SQL),控制台会输出详细的SQL语句,如`INSERT INTO user (name) VALUES ('test_user')`,而任何错误信息则会追加写入到`error.log`文件中。
如何验证Debug日志是否生效?
验证Debug日志是否生效的最直接方法是运行上述程序并观察控制台输出。如果配置正确,控制台应该会打印出类似`[DEBUG] [xorm] [info] 2023/10/27 10:00:00.123 SQL: INSERT INTO user (name) VALUES ('test_user')`的输出。此外,检查当前目录下是否生成了`error.log`文件,虽然本次操作没有错误,但文件应已被创建。如果控制台没有输出SQL语句,请检查是否在创建引擎后调用了`SetLogger`,以及自定义Logger的`Debug`方法是否正确实现。另外,确保数据库连接成功,因为连接失败可能会抛出异常而非普通的Debug日志。

Debug日志中SQL参数是如何绑定的?
在Debug日志输出的SQL语句中,参数绑定通常以占位符形式呈现,或者在某些驱动下直接显示转义后的值。XORM本身不直接负责SQL参数的最终转义,而是依赖底层的数据库驱动(如`go-sql-driver/mysql`)。在Debug日志中,你会看到类似`?`的占位符,这表示参数将在执行时由驱动进行安全绑定。这种机制防止了SQL注入攻击。如果你希望看到具体的参数值,可能需要修改自定义Logger的`Debug`方法,解析日志内容中的参数部分,但这通常不是推荐做法,因为会暴露敏感数据。正确的做法是通过日志中的SQL模板和后续的错误信息来推断参数绑定情况。


















