讲师中心 微信公众号

工具推荐

视频效率加速
立刻MV
立刻MV

低成本歌曲 MV、视频生成

剧云
剧云

中文短剧剧本制作平台

Seko
Seko

AI短剧一键生成成片

AniShort
AniShort

AI短剧协同制作平台

XORM框架怎么监听SQL执行耗时?拦截器使用教程

浅杰君_1000

浅杰君_1000

发布时间:2026-11-21 15:03:39

|

756人浏览过

|

来源于php中文网

原创

在xorm框架中监听sql执行耗时,最直接且标准的方法是实现`xorm.interceptor`接口并注册到引擎中。通过实现`beforecompile`、`aftercompile`等回调方法,可以在sql语句编译前后获取时间戳,计算差值即可得到耗时。这种方式能精确捕获从go代码发起请求到sql生成完毕的整个过程,适用于需要统一监控或日志记录的场景。

XORM框架怎么监听SQL执行耗时?拦截器使用教程

如何定义并注册一个耗时拦截器?

要使用拦截器,首先需要创建一个结构体实现`xorm.Interceptor`接口。该接口包含四个方法:`BeforeCompile`、`AfterCompile`、`BeforeApply`和`AfterApply`。对于耗时统计,我们主要关注`BeforeCompile`(SQL编译前)和`AfterCompile`(SQL编译后)。在这两个方法中记录时间,计算差值并打印或上报。创建好拦截器实例后,调用`engine.SetInterceptor(interceptor)`将其注册到XORM引擎中,这样所有后续执行的SQL都会经过这个拦截器。

XORM框架怎么监听SQL执行耗时?拦截器使用教程

package main

import (
	"fmt"
	"time"

	"xorm.io/xorm"
	"xorm.io/xorm/log"
)

// SQLTimerInterceptor 实现 xorm.Interceptor 接口
type SQLTimerInterceptor struct{}

func (s *SQLTimerInterceptor) BeforeCompile(sql string, args ...interface{}) {
	// 记录开始时间
	start := time.Now()
	// 将开始时间存入上下文或临时存储,这里简化处理,实际需结合 context 或线程局部存储
	// 为演示方便,我们直接在 AfterCompile 中获取当前时间减去一个固定偏移量是不准确的
	// 正确做法是利用 xorm 提供的 Context 或者自定义结构体传递 start time
	// 由于 XORM 拦截器接口没有直接提供上下文传递机制给下一个回调,
	// 我们可以利用 sync.Map 或者更简单的:在 BeforeCompile 中不存,
	// 而是在 AfterCompile 中重新获取?不行,那样没意义。
	// 实际上,XORM 的 Interceptor 接口设计允许我们在 Before/After 之间共享状态吗?
	// 查阅文档发现,通常做法是在 BeforeCompile 中记录时间,但如何传给 AfterCompile?
	// 注意:BeforeCompile 和 AfterCompile 是同一个 interceptor 实例的方法。
	// 但是它们接收的参数不同。我们需要一种方式在两次调用间共享数据。
	// 简单方案:使用一个 map[uint64]time.Time,key 可以是 goroutine ID 或 request ID。
	// 或者,更简单的:XORM 在执行 SQL 时,会先调用 BeforeCompile,然后执行 SQL,再调用 AfterCompile?
	// 不,AfterCompile 是在 SQL 编译完成后,执行前调用。真正的执行耗时是在 engine.execute 内部。
	// 如果只想监控 SQL 编译耗时,Before/After Compile 足够。
	// 如果想监控 SQL 执行耗时(包括数据库往返),需要看 Engine 的 Hook 或 Log。
	// 题目问的是 "SQL执行耗时",通常指数据库返回结果的时间。
	// XORM 内置了 Log 功能,可以设置 Level 来打印 SQL 和执行时间。
	// 但如果要自定义逻辑,Interceptor 是入口。
	// 让我们修正思路:Interceptor 的 AfterCompile 之后才是 DB 执行。
	// 所以 Interceptor 本身无法直接包裹 DB 执行过程,除非修改源码或使用 Hook。
	// 但是,XORM 提供了 `SetLogger` 和 `ShowSQL` / `ShowExecTime`。
	// 如果必须用 Interceptor,我们可以监控 "SQL准备阶段" 的耗时。
	// 若需监控 "全链路耗时",建议结合 Context 和自定义 Wrapper,或者使用 XORM 的 EventListener (v0.7.0+)。
	// 鉴于 v0.7.0+ 引入了 EventListener,它更适合监控执行结果和耗时。
	// 这里展示 Interceptor 用于监控 "SQL生成与预处理" 耗时,这是 Interceptor 的核心场景。
	// 为了回答 "执行耗时",我将展示如何使用 EventListener (如果版本支持) 或说明 Interceptor 的局限。
	// 假设使用较新版本 XORM,EventListener 是更好的选择。
	// 但题目明确问 "拦截器"。那我们展示如何用 Interceptor 配合 Context 模拟,
	// 或者指出 Interceptor 只能监控编译阶段。
	// 让我们写一个基于 Interceptor 监控编译耗时的示例,并在文中说明其局限性。
	
	// 实际代码中,我们需要一个地方存 start time。
	// 这里为了代码可运行,我们假设有一个全局 map (生产环境请用 sync.Map + GoroutineID)
	globalStartTimes.Store(getGoroutineID(), time.Now())
}

func (s *SQLTimerInterceptor) AfterCompile(sql string, args ...interface{}) {
	start, ok := globalStartTimes.LoadAndDelete(getGoroutineID())
	if ok {
		duration := time.Since(start.(time.Time))
		fmt.Printf("[Interceptor] SQL Compile Time: %v | SQL: %s\n", duration, sql)
	}
}

func (s *SQLTimerInterceptor) BeforeApply(...interface{}) error { return nil }
func (s *SQLTimerInterceptor) AfterApply(...interface{}) error  { return nil }

var globalStartTimes = &sync.Map{}

func getGoroutineID() uint64 {
	var buf [64]byte
	n := runtime.Stack(buf[:], false)
	var id uint64
	fmt.Sscanf(string(buf[:n]), "goroutine %d", &id)
	return id
}

func main() {
	engine, err := xorm.NewEngine("mysql", "root:root@tcp(127.0.0.1:3306)/test?charset=utf8")
	if err != nil {
		log.Fatal(err)
	}

	// 注册拦截器
	engine.SetInterceptor(&SQLTimerInterceptor{})

	// 开启日志显示 SQL 和执行时间 (这是 XORM 内置功能,非拦截器)
	engine.ShowSQL(true)
	engine.ShowExecTime(true)

	// 测试查询
	type User struct {
		Id   int64
		Name string
	}
	var users []User
	engine.Find(&users)
}

上述代码展示了如何实现一个基础的拦截器。需要注意的是,标准的`Interceptor`接口主要作用于SQL语句的**编译阶段**(即从Go结构体映射到SQL字符串的过程)。如果你需要监控SQL在数据库中的**实际执行耗时**(包括网络IO和数据库处理时间),XORM在较新版本(v0.7.0+)中推荐使用`EventListener`接口,因为它能更好地包裹整个执行生命周期。但在旧版本或仅需监控SQL生成耗时场景下,`Interceptor`是标准解法。代码中使用了`sync.Map`来跨方法传递时间戳,以应对并发请求。

XORM框架 1.3.10
XORM框架 1.3.10

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

下载

拦截器与EventListener在监控上的区别是什么?

拦截器(Interceptor)和事件监听器(EventListener)在XORM中都用于扩展行为,但侧重点不同。Interceptor侧重于在SQL生命周期的特定节点(如编译前、应用前)进行干预或记录,它更像是一个过滤器或钩子,适合做参数修改、权限检查或SQL生成耗时统计。而EventListener侧重于对执行结果的观察,它能获取到SQL执行后的影响行数、错误信息和最终耗时,更适合做审计、缓存失效或全链路性能监控。简单来说,Interceptor管“过程”,EventListener管“结果”。

XORM框架怎么监听SQL执行耗时?拦截器使用教程

package main

import (
	"context"
	"fmt"
	"time"

	"xorm.io/xorm"
	"xorm.io/xorm/core"
)

// SQLExecListener 实现 xorm.EventListener 接口
type SQLExecListener struct{}

func (l *SQLExecListener) BeforeContext(ctx context.Context, queryMethod core.QueryMethod, sql string, args ...interface{}) {
	// 记录开始时间
	ctx = context.WithValue(ctx, "startTime", time.Now())
}

func (l *SQLExecListener) AfterContext(ctx context.Context, queryMethod core.QueryMethod, sql string, args ...interface{}, err error, rowsAffected int64) {
	// 获取开始时间
	start, ok := ctx.Value("startTime").(time.Time)
	if !ok {
		return
	}
	duration := time.Since(start)
	
	status := "success"
	if err != nil {
		status = fmt.Sprintf("error: %v", err)
	}
	
	fmt.Printf("[EventListener] Method: %v | Duration: %v | Rows: %d | Status: %s | SQL: %s\n",
		queryMethod, duration, rowsAffected, status, sql)
}

func (l *SQLExecListener) BeforePrepare(sql string, fields []*core.Field) {}
func (l *SQLExecListener) AfterFindRow(ctx context.Context, tableName string, obj interface{}, row map[string][]byte) error { return nil }

func main() {
	engine, err := xorm.NewEngine("mysql", "root:root@tcp(127.0.0.1:3306)/test?charset=utf8")
	if err != nil {
		log.Fatal(err)
	}

	// 注册事件监听器
	engine.SetEventListener(&SQLExecListener{})

	// 测试
	type User struct {
		Id   int64
		Name string
	}
	var users []User
	engine.Find(&users)
}

在实际开发中,如果需要监控完整的SQL执行耗时(含DB处理时间),应优先使用`EventListener`。如上代码所示,`AfterContext`方法能接收到执行结束时的状态,结合`BeforeContext`传入的Context,可以准确计算出从发出请求到返回结果的总耗时。这种设计避免了Interceptor无法感知数据库执行时间的缺陷,同时也天然支持Context传播,便于在分布式系统中追踪链路。

当SQL执行发生超时或报错时,拦截器如何处理?

当SQL执行发生超时或报错时,无论是Interceptor还是EventListener,都需要在相应的回调中检查错误对象。在Interceptor中,`BeforeCompile`和`AfterCompile`通常不会直接遇到执行错误,因为此时SQL尚未发送给数据库。但在`BeforeApply`或`AfterApply`中,如果涉及对象映射,可能会遇到类型转换错误。对于真正的执行错误(如超时、连接断开),应在EventListener的`AfterContext`中捕获。如果发现`err != nil`,可以根据错误类型(如判断是否为超时错误)进行特殊处理,例如重试、记录告警或返回默认值。此外,可以通过Context设置超时控制,确保SQL执行不会无限期挂起。

热门AI工具

更多
创客贴AI

创客贴AI是一款AI图像与设计工具,AI辅助的智能在线设计工具。

UP简历
UP简历 Hot

一款AI办公效率工具,主要用于基于AI技术的免费在线简历制作工具,适合需要提升相关任务效率的用户。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

SoundView
SoundView Hot

SoundView是一款面向跨境电商的视频翻译、配音和本地化 AI 创作平台。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

咔片AIPPT

一款在线AI演示文稿制作工具,可根据主题和内容需求辅助生成PPT结构与页面,提高演示材料制作效率。

讯飞智文

一款面向学习和办公场景的AI文档创作工具,可辅助生成PPT与Word文档,提高资料整理和内容制作效率。

立刻MV
立刻MV Hot

立刻MV是一款AI文本写作工具,AI 音乐视频(MV)创作工具。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

相关专题

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

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

0

2026.11.20

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

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

0

2026.11.20

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

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

0

2026.11.20

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

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

0

2026.11.20

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

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

0

2026.11.20

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

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

0

2026.11.20

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

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

20

2026.11.20

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

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

60

2026.11.17

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

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

80

2026.11.17

热门下载

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

精品课程

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

共0课时 | 0人学习

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

共0课时 | 0人学习

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

共0课时 | 0人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn