Java 中 MyBatis 怎么编写自定义的 Interceptor 插件以拦截 Executor 阶段并自动植入分页逻辑

老墨君_9363

老墨君_9363

2026-07-24

795人浏览

原创

mybatis interceptor 通过拦截 executor.query() 实现自动分页,核心是基于 threadlocal 管理分页参数、重写 boundsql 注入方言化分页 sql(如 mysql 的 limit/offset、oracle 的 rownum 包裹),并清理上下文防止脏数据。

java 中 mybatis 怎么编写自定义的 interceptor 插件以拦截 executor 阶段并自动植入分页逻辑

MyBatis 的 Interceptor 可以在 Executor 执行 SQL 前后进行拦截,是实现自动分页(如 PageHelper 风格)的核心机制。关键在于:不修改原始 SQL,而是通过重写 BoundSql、替换 RowBounds、并动态拼接 LIMIT/OFFSET 或使用数据库特有分页语法(如 MySQL 的 LIMIT、Oracle 的 ROWNUM 包裹)。

明确拦截目标与签名

要拦截 Executor 的查询流程,需拦截 Executor.query() 方法。该方法有多个重载,最常用的是:

<e> List<e> query(MappedStatement ms, Object parameter, RowBounds rowBounds, ResultHandler resultHandler)
</e></e>

Interceptor 的 plugin 方法中需按此签名匹配,避免误拦其他方法(如 update 或带 Cursor 的重载)。

判断是否需要分页并提取分页参数

不能对所有查询都分页,需约定触发条件,常见方式有:

  • 检查参数对象是否含 Page / PageRequest 类型字段(推荐,类型安全)
  • 检查 RowBounds 是否为默认值(RowBounds.DEFAULT 表示未手动分页),再结合 ThreadLocal 存储的分页上下文(如 PageHelper.startPage(1, 10))
  • 扫描 MappedStatement 的 SQL 注解或 XML 中是否含 @SelectPage 等自定义注解(更灵活但需额外解析)

建议用 ThreadLocal + 静态工具类管理当前分页信息,例如:

OpenJDK 24
OpenJDK 24

OpenJDK 24 Windows x64 官方参考实现(24+36),适合 Windows 环境进行 Java 开发、编译、运行和版本兼容性验证。

下载
private static final ThreadLocal<pageinfo> PAGE_CONTEXT = ThreadLocal.withInitial(() -> null);
public static void startPage(int pageNum, int pageSize) {
    PAGE_CONTEXT.set(new PageInfo(pageNum, pageSize));
}
</pageinfo>

重写 BoundSql 并注入分页 SQL

在 intercept 方法中获取原始 BoundSql,解析其 SQL 字符串,根据数据库方言生成分页包裹语句:

  • MySQL:在原 SQL 末尾追加 LIMIT #{pageSize} OFFSET #{offset},注意 offset = (pageNum-1) * pageSize
  • PostgreSQL:同 MySQL,支持 LIMIT ... OFFSET ...
  • Oracle:需将原 SQL 包裹为 SELECT * FROM (SELECT ROWNUM rn, t.* FROM (原SQL) t WHERE ROWNUM ?
  • 使用 MetaObject 替换 BoundSql 的 sql 和 parameterMappings,同时更新 parameterObject 添加 pageSize、offset 等参数

注意:不要直接修改原始 BoundSql,应创建新 BoundSql 实例(通过 new BoundSql(...) 或 copyFrom 工具方法),否则影响缓存和复用。

清理上下文与兼容性处理

分页逻辑执行完必须清空 ThreadLocal,防止线程复用导致脏数据:

try {
    return invocation.proceed();
} finally {
    PAGE_CONTEXT.remove(); // 必须放 finally
}

还需考虑:

  • 跳过 selectKey 查询(ms.getSqlCommandType() == SqlCommandType.SELECT && !ms.isSelectKeyStatement())
  • 跳过已含 LIMIT / TOP 等关键词的手写分页 SQL(简单正则检测,避免重复分页)
  • 支持 count 查询自动补全:拦截时若发现是分页查询,可额外触发一次 SELECT COUNT(*) FROM (原SQL) 获取总记录数(PageHelper 即采用此模式)

Java免费学习笔记:立即使用
解锁 Java 大师之旅:从入门到精通的终极指南

相关专题

更多
java
java

Java是一个通用术语,用于表示Java软件及其组件,包括“Java运行时环境 (JRE)”、“Java虚拟机 (JVM)”以及“插件”。php中文网还为大家带了Java相关下载资源、相关课程以及相关文章等内容,供大家免费下载使用。

2023.06.15

10437

6

java正则表达式语法
java正则表达式语法

java正则表达式语法是一种模式匹配工具,它非常有用,可以在处理文本和字符串时快速地查找、替换、验证和提取特定的模式和数据。本专题提供java正则表达式语法的相关文章、下载和专题,供大家免费下载体验。

2023.07.05

7562

9

java自学难吗
java自学难吗

Java自学并不难。Java语言相对于其他一些编程语言而言,有着较为简洁和易读的语法,本专题为大家提供java自学难吗相关的文章,大家可以免费体验。

2023.07.31

6612

8

java配置jdk环境变量
java配置jdk环境变量

Java是一种广泛使用的高级编程语言,用于开发各种类型的应用程序。为了能够在计算机上正确运行和编译Java代码,需要正确配置Java Development Kit(JDK)环境变量。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.08.01

1144

3

java保留两位小数
java保留两位小数

Java是一种广泛应用于编程领域的高级编程语言。在Java中,保留两位小数是指在进行数值计算或输出时,限制小数部分只有两位有效数字,并将多余的位数进行四舍五入或截取。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.08.02

928

3

java基本数据类型
java基本数据类型

java基本数据类型有:1、byte;2、short;3、int;4、long;5、float;6、double;7、char;8、boolean。本专题为大家提供java基本数据类型的相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.02

1376

5

java有什么用
java有什么用

java可以开发应用程序、移动应用、Web应用、企业级应用、嵌入式系统等方面。本专题为大家提供java有什么用的相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.02

2749

5

java在线网站
java在线网站

Java在线网站是指提供Java编程学习、实践和交流平台的网络服务。近年来,随着Java语言在软件开发领域的广泛应用,越来越多的人对Java编程感兴趣,并希望能够通过在线网站来学习和提高自己的Java编程技能。php中文网给大家带来了相关的视频、教程以及文章,欢迎大家前来学习阅读和下载。

2023.08.03

20071

3

配置java环境变量
配置java环境变量

配置Java环境变量是为了让操作系统能够识别和使用Java的相关命令和功能。本专题为大家提供配置java环境变量相关文章,帮助大家解决问题。

2023.08.03

1215

8

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
dev.java 官方:Learn Java
dev.java 官方:Learn Java

共0课时 | 0人学习

Java JDBC数据库连接官方教程
Java JDBC数据库连接官方教程

共0课时 | 0人学习