讲师中心 微信公众号

工具推荐

视频效率加速
Laper
Laper

剧本策划到成片协作

Seko
Seko

AI短剧一键生成成片

AniShort
AniShort

AI短剧协同制作平台

立刻MV
立刻MV

低成本歌曲 MV、视频生成

Java MyBatis 怎么自定义一个分页插件实现物理分页

阿杰同学_2554

阿杰同学_2554

发布时间:2026-09-08 06:51:47

|

392人浏览过

|

来源于php中文网

原创

MyBatis 通过自定义 Interceptor 拦截 StatementHandler 的 prepare() 方法实现物理分页,核心是解析 SELECT SQL、按方言重写并绑定 offset/limit 参数,推荐使用 JSQLParser 解析及 ThreadLocal 传递分页上下文。

java mybatis 怎么自定义一个分页插件实现物理分页

MyBatis 本身不内置物理分页功能,但可通过 Interceptor(拦截器) 拦截 SQL 执行过程,动态重写 SQL 实现数据库层的物理分页(如 MySQL 的 LIMIT offset, size)。这是最常用、最可控的自定义分页插件方式。

一、实现 MyBatis 分页拦截器的核心逻辑

需实现 org.apache.ibatis.plugin.Interceptor 接口,重点拦截 StatementHandler 的 prepare() 方法,在 SQL 准备阶段修改 SQL 和参数:

  • 识别带 RowBounds 或自定义分页参数(如 PageHelper.startPage() 风格)的查询
  • 解析原始 SQL,区分 SELECT 语句(跳过 INSERT/UPDATE/DELETE)
  • 根据方言(MySQL / Oracle / PostgreSQL 等)生成对应分页 SQL 片段
  • 将计算出的 offset 和 limit 绑定为 PreparedStatement 参数

二、关键步骤与代码示例(以 MySQL 为例)

1. 编写分页拦截器类:

Java Development Man
Java Development Man

Java开发手册规约集合,基于阿里巴巴Java开发手册(嵩山版)。 涵盖7大维度:编程规约、异常日志、单元测试、安全规约、MySQL数据库、工程结构、设计规约。

下载
@Intercepts({
    @Signature(type = StatementHandler.class, method = "prepare", args = {Connection.class, Integer.class})
})
public class PaginationInterceptor implements Interceptor {
    private String dialect = "mysql"; // 可扩展为多数据库支持

    @Override
    public Object intercept(Invocation invocation) throws Throwable {
        StatementHandler statementHandler = (StatementHandler) invocation.getTarget();
        MetaObject metaObject = SystemMetaObject.forObject(statementHandler);
        BoundSql boundSql = (BoundSql) metaObject.getValue("delegate.boundSql");
        Object parameterObject = boundSql.getParameterObject();

        // 判断是否需要分页(例如:参数中含 Page 对象,或 ThreadLocal 存了分页上下文)
        Page page = getPageFromParam(parameterObject);
        if (page == null || page.getSize() <= 0) {
            return invocation.proceed();
        }

        String originalSql = boundSql.getSql();
        String paginatedSql = buildMysqlPagedSql(originalSql, page.getOffset(), page.getSize());
        metaObject.setValue("delegate.boundSql.sql", paginatedSql);

        // 替换 ParameterHandler(可选:若需改参数列表,需反射替换)
        return invocation.proceed();
    }

    private String buildMysqlPagedSql(String sql, long offset, int size) {
        return sql + " LIMIT " + offset + ", " + size;
    }

    private Page getPageFromParam(Object param) {
        if (param instanceof Page) return (Page) param;
        if (param instanceof Map) {
            for (Object v : ((Map) param).values()) {
                if (v instanceof Page) return (Page) v;
            }
        }
        return null;
    }

    @Override
    public Object plugin(Object target) {
        return Plugin.wrap(target, this);
    }
}

三、注册拦截器到 SqlSessionFactory

在 Spring Boot 中(mybatis-spring-boot-starter),通过配置类注入:

立即学习“Java免费学习笔记(深入)”;

@Configuration
public class MyBatisConfig {
    @Bean
    public ConfigurationCustomizer configurationCustomizer() {
        return configuration -> configuration.addInterceptor(new PaginationInterceptor());
    }
}

或在传统 Spring XML 中配置:<bean class="org.mybatis.spring.SqlSessionFactoryBean"></bean> 内设置 plugins 属性。

四、使用建议与注意事项

  • 避免直接修改原 SQL 字符串(如用正则替换 SELECT),推荐用 SQL 解析库(如 JSQLParser)提升健壮性
  • 务必处理 count 查询 —— 分页通常需总条数,可拦截后自动补一个 SELECT COUNT(*) FROM (...) t 的统计 SQL
  • 线程安全:分页参数建议通过 ThreadLocal<page></page> 传递,避免参数对象被多个查询误用
  • 兼容性:MyBatis 3.4+ 推荐用 Plugin.wrap();低版本注意 ParameterHandler 和 ResultSetHandler 的联动

热门AI工具

更多
SkildArt
SkildArt Hot

SkildArt是一款AI文本写作工具,一站式 AI 视觉创作平台。

VibeKnow
VibeKnow Hot

一款AI视频创作工具,主要用于全球首个AI知识视频创作平台,文档、文章、网页,一键生成视频,适合需要提升相关任务效率的用户。

函子Zion

一款支持AI搭建、可视化编辑和多端发布的全栈无代码开发平台。

音述AI
音述AI Hot

一款AI音频处理工具,主要用于音述AI是一个以“用声音述说故事”为核心的 AI 音乐创作与声音分享社区,适合需要提升相关任务效率的用户。

WorkBuddy

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

蛙蛙写作

一款AI论文写作工具,主要用于超级AI智能写作助手,适合需要提升相关任务效率的用户。

花生AI
花生AI Hot

一款AI视频创作工具,主要用于B站推出的AI视频创作工具,适合需要提升相关任务效率的用户。

DeepSeek

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

豆包大模型

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

相关专题

更多
java
java

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

12697

2023.06.15

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

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

9782

2023.07.05

java自学难吗
java自学难吗

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

8312

2023.07.31

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

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

1324

2023.08.01

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

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

1068

2023.08.02

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

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

1596

2023.08.02

java有什么用
java有什么用

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

3329

2023.08.02

java在线网站
java在线网站

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

20551

2023.08.03

Go-Zero API开发使用教程
Go-Zero API开发使用教程

本专题聚焦Go-Zero的API开发,拆解.api描述文件的语法结构、路由与分组定义、参数绑定与校验规则,说明统一响应体、JWT鉴权、跨域与接口文档生成的落地方式,并给出网关聚合与接口测试的实践建议。

100

2026.11.12

热门下载

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

精品课程

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

共0课时 | 0人学习

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

共0课时 | 0人学习

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

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