Java MyBatis 怎么通过插件机制(Interceptor)实现分页拦截

舞夢輝影

舞夢輝影

2026-08-03

994人浏览

原创

mybatis分页拦截本质是通过自定义interceptor拦截statementhandler.prepare()方法,在sql执行前动态重写sql添加limit/offset并处理count查询。

java mybatis 怎么通过插件机制(interceptor)实现分页拦截

MyBatis 的分页拦截本质是通过自定义 Interceptor 拦截 StatementHandler 的执行过程,在 SQL 执行前动态重写 SQL,添加 LIMIT/OFFSET(或数据库特定的分页语法),同时拦截查询总数逻辑,实现物理分页。

理解拦截目标和时机

MyBatis 插件只能拦截四大核心接口:Executor、ParameterHandler、ResultSetHandler 和 StatementHandler。分页必须在 SQL 生成并准备执行前介入,因此最合适的拦截点是 StatementHandlerprepare() 方法 —— 此时 SQL 已经完成动态解析(#{xxx} 替换),但尚未编译为 PreparedStatement。

注意:不能拦截 Executor 的 query(),因为此时 SQL 已固定,且分页参数未注入;也不能只改 BoundSql 而不处理参数绑定,否则 OFFSET/LIMIT 值无法正确设置。

编写分页拦截器(PaginationInterceptor)

实现 Interceptor 接口,用 @Intercepts 指定拦截 StatementHandler.prepare(Connection, Integer) 方法:

Java JDK 25
Java JDK 25

Java JDK 25 来自 OpenJDK 官方归档,版本为 JDK 25,本条下载地址已指向官方 Windows x64 zip 安装包直链,适合调试旧项目或兼容旧版 Java 运行环境。

下载
  • intercept() 中获取原始 BoundSql,提取原始 SQL 和参数
  • 判断是否需要分页(例如检查参数中是否存在 Page 对象或 pageNo/pageSize
  • 使用数据库方言(如 MySQL、Oracle、PostgreSQL)生成带分页的 SQL,例如 MySQL 改为 SELECT * FROM t_user LIMIT #{pageSize} OFFSET #{offset}
  • 构造新的 BoundSql,并确保分页参数(pageSizeoffset)被加入到参数映射中
  • 用新 BoundSql 替换原 StatementHandler 的内部 boundSql

支持 count 查询自动补全

真实分页需总记录数,常见做法是在同一次请求中自动执行一条 COUNT 查询。可在拦截器中识别分页请求后:

  • 解析原始 SQL,剥离 ORDER BY,包装为 SELECT COUNT(*) FROM (original_sql) tmp_count
  • 复用原 SQL 的参数映射,创建独立的 count BoundSql
  • 通过 Executor.query(..., countBoundSql, ...) 手动触发一次 count 查询,并将结果存入 ThreadLocal 或 Page 对象
  • 避免重复拦截 count 查询(加标记位或跳过已含 COUNT 的 SQL)

注册插件并配置分页参数

在 MyBatis 配置文件(mybatis-config.xml)或 Java Config 中注册插件:


  
    
  

业务层调用时,只需传入封装了 pageNumpageSize 的对象(如 PageHelper 的 PageHelper.startPage(1, 10)),或直接在 Mapper 参数中传 Page<user></user> 实例,拦截器会自动识别并生效。

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

相关专题

更多
java
java

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

2023.06.15

3792

6

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

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

2023.07.05

2796

9

java自学难吗
java自学难吗

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

2023.07.31

2824

8

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

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

2023.08.01

637

3

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

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

2023.08.02

602

3

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

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

2023.08.02

705

5

java有什么用
java有什么用

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

2023.08.02

1290

5

java在线网站
java在线网站

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

2023.08.03

18844

3

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

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

2023.08.03

646

8

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Java JDBC数据库连接官方教程
Java JDBC数据库连接官方教程

共0课时 | 0人学习

Java 26官方文档
Java 26官方文档

共0课时 | 0人学习