XORM框架SQL日志打印的配置方式

夏浩君_8632

夏浩君_8632

2026-11-22

180人浏览

原创

在xorm框架中,开启sql日志打印需要调用引擎的 setlogger 方法并传入一个实现了 xorm.logger 接口的对象。默认情况下,xorm使用内置的简单日志器,但为了查看具体的sql语句、参数及执行耗时,通常建议替换为功能更完善的第三方日志库(如 logrus)或自定义实现。配置完成后,所有通过该引擎执行的增删改查操作都会自动记录到日志中。

XORM框架SQL日志打印的配置方式

如何集成Logrus进行结构化日志输出?

将XORM与 logrus 结合是生产环境中最常见的做法,它能提供JSON格式的结构化日志,便于ELK等系统采集。核心步骤是引入 xorm-log/logrus 包,实例化 logrusxorm 适配器,并通过 SetLogger 挂载到引擎上。这样配置后,SQL日志会包含时间戳、级别、SQL语句、参数列表以及执行耗时,且支持按级别过滤。

XORM框架SQL日志打印的配置方式

package main

import (
    "fmt"
    "github.com/go-xorm/xorm"
    logrusxorm "github.com/xormplus/logrus"
    "github.com/sirupsen/logrus"
)

func main() {
    // 1. 创建标准的 Logrus Logger
    logger := logrus.New()
    logger.SetLevel(logrus.DebugLevel) // 设置日志级别为 Debug
    logger.SetFormatter(&logrus.JSONFormatter{})

    // 2. 创建 XORM Engine
    engine, err := xorm.NewEngine("mysql", "root:root@tcp(127.0.0.1:3306)/test?charset=utf8")
    if err != nil {
        panic(err)
    }

    // 3. 关键步骤:设置 Logger
    // 使用 logrusxorm 适配器将 logrus 转换为 xorm.Logger 接口
    engine.SetLogger(logrusxorm.New(logger))

    // 4. 测试查询
    var users []User
    err = engine.Find(&users)
    if err != nil {
        fmt.Println("Error:", err)
    }
}

// 假设的 User 结构体
type User struct {
    Id   int64
    Name string
}

上述代码展示了完整的集成流程。首先初始化 logrus 实例并配置格式,接着创建 xorm.Engine,最后调用 engine.SetLogger() 传入适配器。当执行 engine.Find() 时,控制台或日志文件会输出类似以下的JSON内容,其中 sql 字段包含完整SQL,args 包含参数,cost 为耗时毫秒数。

如何实现自定义简易SQL日志?

如果项目依赖轻量级,不想引入第三方日志库,可以实现一个极简的 xorm.Logger 结构体。只需定义一个结构体并实现 Debug、Info、Warn、Error 四个方法即可。这种方法适合快速调试或嵌入到简单的命令行工具中,虽然缺乏结构化能力,但能清晰看到SQL执行细节。

XORM框架 1.3.10
XORM框架 1.3.10

XORM框架 1.3.10版本源码包下载,包含 PostgreSQL 字段同步、GBase8s 与 libSQL 驱动、Oracle 日期和 MSSQL 分页修复。

下载

XORM框架SQL日志打印的配置方式

package main

import (
    "fmt"
    "time"
    "github.com/go-xorm/xorm"
)

// 1. 定义自定义 Logger 结构体
type SimpleLogger struct {
    Level int
}

// 2. 实现 xorm.Logger 接口
func (l *SimpleLogger) Debug(v ...interface{}) {
    if l.Level >= 0 {
        fmt.Printf("[DEBUG] %v\n", v)
    }
}

func (l *SimpleLogger) Info(v ...interface{}) {
    if l.Level >= 1 {
        fmt.Printf("[INFO] %v\n", v)
    }
}

func (l *SimpleLogger) Warn(v ...interface{}) {
    if l.Level >= 2 {
        fmt.Printf("[WARN] %v\n", v)
    }
}

func (l *SimpleLogger) Error(v ...interface{}) {
    if l.Level >= 3 {
        fmt.Printf("[ERROR] %v\n", v)
    }
}

func (l *SimpleLogger) SetLevel(level int) {
    l.Level = level
}

func (l *SimpleLogger) IsPrepare() bool {
    return false
}

func (l *SimpleLogger) ShowExecTime() bool {
    return true // 显示执行耗时
}

func (l *SimpleLogger) ShowSQL() bool {
    return true // 显示SQL语句
}

func main() {
    engine, _ := xorm.NewEngine("sqlite3", "test.db")
    
    // 3. 挂载自定义 Logger
    customLogger := &SimpleLogger{Level: 0}
    engine.SetLogger(customLogger)

    // 执行操作触发日志
    engine.Exec("SELECT 1")
}

在这个示例中,SimpleLogger 结构体实现了 xorm.Logger 接口所需的所有方法。特别注意 ShowExecTime 和 ShowSQL 方法的返回值,设置为 true 才能确保XORM在日志中打印出SQL语句和执行时间。通过调整 Level 字段,可以控制不同级别日志的输出。这种自定义方式完全掌控了日志的输出格式,适合对日志内容有特定要求的场景。

日志中SQL参数占位符是如何处理的?

在XORM的日志输出中,SQL语句通常以预编译形式呈现,即使用 ? 作为占位符,而实际参数值会单独列在 args 数组中。这是出于安全和性能考虑,避免SQL注入风险并提高执行效率。开发者在排查问题时,需要将占位符与参数数组一一对应,而不是直接拼接成字符串。例如,日志可能显示 INSERT INTO user (name) VALUES (?),同时 args 为 ["john"],这表示实际执行的SQL是将 john 插入到 name 字段。

相关文章

全能打印神器
全能打印神器

全能打印神器是一款非常好用的打印软件,可以在电脑、手机、平板电脑等设备上使用。支持无线打印和云打印,操作非常简单,使用起来也非常方便,有需要的小伙伴快来保存下载体验吧!

下载

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
Navicat创建数据库教程
Navicat创建数据库教程

本专题整理Navicat创建数据库相关教程,介绍新建前的准备、基础设置和创建后的检查方法。内容兼顾入门学习及实际使用需求,帮助用户了解不同数据库类型下的操作差异,为后续建表、保存数据和日常管理提供参考。

2026.11.20

20

7

Navicat入门教程大全
Navicat入门教程大全

本专题整理Navicat入门教程,从认识软件界面到开展数据库操作,介绍初次使用需要了解的知识和方法。内容兼顾连接配置、数据管理及日常使用中的疑问,方便用户按学习进度查阅,为后续实践和独立操作打好基础。

2026.11.20

20

17

Navicat数据库连接配置指南
Navicat数据库连接配置指南

从确认数据库信息到建立可用连接,本专题串联Navicat连接数据库的相关知识和操作方法。既有初次配置时需要了解的基础内容,也有连接后的检查思路,方便用户按实际需求查阅教程,逐步熟悉数据库连接的设置流程。

2026.11.20

0

10

PHP8.6数组与数据处理教程
PHP8.6数组与数据处理教程

本专题汇总PHP8.6数组与数据处理教程,涵盖CSV读取和导出、引用遍历删除、array_filter回调模式、配置键名冲突、pathinfo文件名校验、GMP大整数进制转换及UTF-8正则筛选,说明升级兼容变化、输入范围和失败处理方法。

2026.11.20

60

8

PHP8.6升级迁移教程
PHP8.6升级迁移教程

本专题汇总PHP8.6升级迁移与弃用接口改造教程,涵盖反射调用、对象属性赋值、标识符更名、构造函数与__debugInfo调整,以及插件类名检查、常量导出、ArrayIterator排序、SPL和DTO查询参数转换,帮助梳理弃用提示并完成代码兼容改造。

2026.11.20

0

10

PHP8.6安装配置与FPM运维教程
PHP8.6安装配置与FPM运维教程

本专题汇总PHP8.6正式版安装部署与FPM运维教程,涵盖Linux并存安装、独立ini配置、扩展重新编译、Nginx切换与回滚、FPM状态监控和慢日志排查,以及环境变量、请求超时、OPcache刷新和预加载配置。

2026.11.20

40

10

Nginx CVE-2026-123007排查与防护指南
Nginx CVE-2026-123007排查与防护指南

Nginx HTTP/2漏洞该怎么修复?本专题围绕CVE-2026-123007,介绍安全版本升级、模块兼容检查和配置恢复方法,以及日志排查、权限设置等后续加固操作,方便你按实际部署情况查找对应教程。

2026.11.20

40

8

GoFrame框架Web开发与路由中间件
GoFrame框架Web开发与路由中间件

本专题聚焦GoFrame框架的Web开发,拆解路由注册与匹配规则、请求参数获取、参数校验与中间件执行顺序,说明统一响应、JWT鉴权、文件上传与接口文档生成的落地方式,并补充优雅重启与测试实践。

2026.11.17

80

15

GoFrame框架安装与gf命令行工具
GoFrame框架安装与gf命令行工具

本专题围绕GoFrame框架的安装与工具链配置展开,讲清Go版本要求、gf命令行的安装方式、代理镜像与依赖准备,说明项目初始化、热编译、交叉编译打包的做法,并整理安装阶段的常见报错与验证步骤。

2026.11.17

100

15

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
XORM框架事务处理手册
XORM框架事务处理手册

共0课时 | 0人学习

XORM框架官方中文文档
XORM框架官方中文文档

共0课时 | 0人学习

Go-zero与XORM网盘项目实战
Go-zero与XORM网盘项目实战

共0课时 | 0人学习