PageHelper

最新推荐文章于 2025-04-09 01:19:41 发布
最新推荐文章于 2025-04-09 01:19:41 发布
阅读量384 收藏 1
点赞数
分类专栏： java学习笔记 SpringBoot
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.youkuaiyun.com/leige07112033/article/details/106439823
版权

文章目录


PageHelper是常用的分页插件，之前只停留在用的阶段，直到…

发生了一次生产事故

所以准备把他的源码研究一下，看下原因

介绍(What)

image-20200530110229737

从这里看到，PageHelper的使用是建立在Mybatis基础之上的，具体实现后面再说。 同时支持常见的各种数据库如 Mysql、Oracle、H2等，基本都能支持。

使用(How)

重要提示

PageHelper.startPage方法重要提示:

只有紧跟在PageHelper.startPage方法后的第一个Mybatis的**查询（Select）**方法会被分页。

请不要配置多个分页插件

请不要在系统中配置多个分页插件(使用Spring时,mybatis-config.xml和Spring<bean>配置方式，请选择其中一种，不要同时配置多个分页插件)！

分页插件不支持带有for update语句的分页

对于带有for update的sql，会抛出运行时异常，对于这样的sql建议手动分页，毕竟这样的sql需要重视。

分页插件不支持嵌套结果映射

由于嵌套结果方式会导致结果集折叠，因此分页查询的结果折叠后总数会减少，所以无法保证分页结果数量正确。

初步怀疑我的问题是这一步引起，因为我是联表查询

1. 引入Maven依赖

<dependency>
    <groupId>com.github.pagehelper</groupId>
    <artifactId>pagehelper</artifactId>
    <version>最新版本</version>
</dependency>

2. 配置拦截器

分页插件的使用是建立在 Mybatis拦截器上的，执行sql前会进行参数拼接

在 MyBatis 配置 xml 中配置拦截器插件

<plugins>
    <!-- com.github.pagehelper为PageHelper类所在包名 -->
    <plugin interceptor="com.github.pagehelper.PageInterceptor">
        <!-- 使用下面的方式配置参数，后面会有所有的参数介绍 -->
        <property name="param1" value="value1"/>
	</plugin>
</plugins>

3. 使用

最常见的用法

//获取第1页，10条内容，默认查询总数count
PageHelper.startPage(1, 10);
//紧跟着的第一个select方法会被分页
List<User> list = userMapper.selectIf(1);
PageInfo page = new PageInfo(list);

原理(Why)

今天就来对源码一探究竟

PageHelper

从这个类开始

PageHelper.startPage(1,10);

我们点进去看看

		/**
     * 开始分页
     *
     * @param pageNum  页码
     * @param pageSize 每页显示数量
     */
    public static <E> Page<E> startPage(int pageNum, int pageSize) {
        return startPage(pageNum, pageSize, true);
    }
    
    //多了一个是否进行count查询的参数，由上面看，默认开启
    public static <E> Page<E> startPage(int pageNum, int pageSize, boolean count) {
        return startPage(pageNum, pageSize, count, null);
    }

		//多了个 reasonable : 分页合理化
		public static <E> Page<E> startPage(int pageNum, int pageSize, boolean count, Boolean reasonable) {
        return startPage(pageNum, pageSize, count, reasonable, null);
    }

		//终于到方法体了，多了个 pageSizeZero
		//这样介绍的  你可以配置 pageSizeZero 为 true， 配置后，当 pageSize=0 或者 RowBounds.limit = 0 就会查询出全部的结果。
		public static <E> Page<E> startPage(int pageNum, int pageSize, boolean count, Boolean reasonable, Boolean pageSizeZero) {
        Page<E> page = new Page<E>(pageNum, pageSize, count);   //新建page类
        page.setReasonable(reasonable);
        page.setPageSizeZero(pageSizeZero);                    //下面这俩参数默认没有
        //当已经执行过orderBy的时候
        Page<E> oldPage = SqlUtil.getLocalPage();
        if (oldPage != null && oldPage.isOrderByOnly()) {
            page.setOrderBy(oldPage.getOrderBy());
        }
        SqlUtil.setLocalPage(page);
        return page;
    }

流程就是新建一个Page类，主要给SqlUtil设置 LocalPage(), 看下LocalPage()实现

public class SqlUtil implements Constant {
    private static final ThreadLocal<Page> LOCAL_PAGE = new ThreadLocal<Page>();
}

是一个线程私有的 ThreadLocal，这个方法到此结束。

那么，设置完这个，还不知道怎么执行分页的。我们再回到PageHelper

怎么生效的

回到PageHelper后，我们看到 pageHelper 实现了 mybatis的拦截器

public class PageHelper implements Interceptor {

}

//该接口如下
package org.apache.ibatis.plugin;

import java.util.Properties;
public interface Interceptor {
    Object intercept(Invocation var1) throws Throwable;

    Object plugin(Object var1);

    void setProperties(Properties var1);
}

那么可以断言，在Mybatis执行的时候，PageHelper通过拦截器做了些工作，我们来看 pageHelper中的intercept方法

/**
     * Mybatis拦截器方法
     *
     * @param invocation 拦截器入参
     * @return 返回执行结果
     * @throws Throwable 抛出异常
     */
    public Object intercept(Invocation invocation) throws Throwable {
        if (autoRuntimeDialect) {      //自动检测 数据库类型
            SqlUtil sqlUtil = getSqlUtil(invocation);
            return sqlUtil.processPage(invocation);
        } else {
            if (autoDialect) {
                initSqlUtil(invocation);
            }
            return sqlUtil.processPage(invocation);
        }
    }

注释非常清晰，核心是 sqlUtil.processPage 方法，继续看

/**
     * Mybatis拦截器方法，这一步嵌套为了在出现异常时也可以清空Threadlocal
     *
     * @param invocation 拦截器入参
     * @return 返回执行结果
     * @throws Throwable 抛出异常
     */
    public Object processPage(Invocation invocation) throws Throwable {
        try {
            Object result = _processPage(invocation);
            return result;
        } finally {
            clearLocalPage();
        }
    }

继续看 _processPage()

image-20200530120547485

图中1是指：

supportMethodsArguments：支持通过 Mapper 接口参数来传递分页参数，默认值false，分页插件会从查询方法的参数值中，自动根据上面 params 配置的字段中取值，查找到合适的值时就会自动分页。

2是真正处理的方法，我们放他出来, 比较长，但是耐心看看。

/**
     * Mybatis拦截器方法
     *
     * @param invocation 拦截器入参
     * @return 返回执行结果
     * @throws Throwable 抛出异常
     */
    private Page doProcessPage(Invocation invocation, Page page, Object[] args) throws Throwable {
        //保存RowBounds状态
        RowBounds rowBounds = (RowBounds) args[2];
        //获取原始的ms，   这里即  包名 + 方法名定位的sql语句
        MappedStatement ms = (MappedStatement) args[0];
        //判断并处理为PageSqlSource
        if (!isPageSqlSource(ms)) {
            processMappedStatement(ms);
        }
        //设置当前的parser，后面每次使用前都会set，ThreadLocal的值不会产生不良影响
        ((PageSqlSource)ms.getSqlSource()).setParser(parser);
        try {
            //忽略RowBounds-否则会进行Mybatis自带的内存分页
            args[2] = RowBounds.DEFAULT;
            //如果只进行排序 或 pageSizeZero的判断
            if (isQueryOnly(page)) {
                return doQueryOnly(page, invocation);
            }

            //简单的通过total的值来判断是否进行count查询
            if (page.isCount()) {
                page.setCountSignal(Boolean.TRUE);
                //替换MS
                args[0] = msCountMap.get(ms.getId());
                //查询总数
                Object result = invocation.proceed();
                //还原ms
                args[0] = ms;
                //设置总数
                page.setTotal((Integer) ((List) result).get(0));
                if (page.getTotal() == 0) {
                    return page;
                }
            } else {
                page.setTotal(-1l);
            }
            //pageSize>0的时候执行分页查询，pageSize<=0的时候不执行相当于可能只返回了一个count
            if (page.getPageSize() > 0 &&
                    ((rowBounds == RowBounds.DEFAULT && page.getPageNum() > 0)
                            || rowBounds != RowBounds.DEFAULT)) {
                //将参数中的MappedStatement替换为新的qs
                page.setCountSignal(null);
                BoundSql boundSql = ms.getBoundSql(args[1]);
  //注意这里，是获取 pageStartRow 和  pageSize
                args[1] = parser.setPageParameter(ms, args[1], boundSql, page); 
              
  //之前已经执行过count()查询
                page.setCountSignal(Boolean.FALSE);
                //执行分页查询
                Object result = invocation.proceed();
                //得到处理结果
                page.addAll((List) result);
            }
        } finally {
            ((PageSqlSource)ms.getSqlSource()).removeParser();
        }

        //返回结果
        return page;
    }
  1. 先查判断是否查总数，具体是通过page.isCount(), 这个参数我们在前面默认设置为true，
  2. 最后将执行的结果放进Page，page也是 ArrayList

题外

这里注意下

image-20200530122930469

这个方法使用了桥接模式，抽象类实现了基本的方法

image-20200530123041111

每个数据库继承了此类，实现了自己的方法

image-20200530123219847

我们来看下 MysqlParser

image-20200530123335016

主要是设置参数，和分页查询sql。

小节

PageHelper的原理主要是 mybatis拦截器

查总数用 select count(0) from ( 自己的sql)

分页用 select ---- limit ？，？ 实现分页

后面放到 PageInfo里面去

Java Web Spring Boot 分页查询插件-PageHelper
xycxycooo的博客
07-24 682
PageHelper是MyBatis的一款功能强大、方便易用的分页插件，支持任何形式的单表、多表的分页查询。它能够自动拦截SQL查询，并在查询前添加分页参数，查询后返回分页结果。@Mapper@Service@Autowired@Override// 设置分页参数// 执行分页查询// 获取分页结果// 封装PageBean@Autowired。
PageHelper是什么
m0_58162502的博客
09-25 816
PageHelper是一款好用的开源免费的Mybatis第三方物理分页插件 我们将简单介绍PageHelper的基本使用和配置参数的含义，重点分析PageHelper作为Mybatis分页插件的实现原理。 概述 我们明确了分页查询原理,但是自己写的话还是需要很多额外的工作量的 企业开发中基本不会自己编写和计算分页的信息 因为市面上很多分页的框架或插件 PageHelper支持mybatis框架的分页插件 因为PageHelper也没有在SpringBoot中定义版本 所以我们要在父项目中..
PageHelper详解：使用方法与注意事项
最新发布
yk_dflkg的博客
04-09 1573
PageHelper是一个强大的MyBatis分页插件，通过简单的配置和调用，可以大大简化分页查询的实现。但在使用过程中需要注意各种细节和潜在问题，如线程安全、生命周期等。通过合理配置和使用最佳实践，PageHelper可以帮助开发者高效实现各种分页查询需求。希望这篇详细的PageHelper使用指南能够帮助你更好地理解和使用这个工具！
PageHelper的使用
luosuss的博客
08-30 5048
联合唯一索引最重要的作用是确保表中两个或多个列的组合值不会重复。例如，在订单表中，你可能希望确保每个客户对每个产品的订单是唯一的，这可以通过在客户ID和产品ID上创建联合唯一索引来实现。联合唯一索引（Composite Unique Index）在数据库表中的作用非常重要，它涉及两个或多个列的组合，确保这些列的组合值在整个表中是唯一的。查询时遵循最左匹配原则，如果使用where条件，使用了customer_id（在左边）就走联合唯一索引，如果只使用了product_id，就不会走联合唯一索引。
Mybatis分页框架-PageHelper
初心不忘、始终方得
09-23 6568
PageHelper物理分页插件详细介绍
pagehelper
07-02
PageHelper分页插件版本是3.4.2-fix，这个版本从中央仓库是下载不到的，这是经过修改过的版本，mybatis官方提供的分页插件在无条件分页查询的时候没问题，但是当有条件进行分页查询的时候会抛异常，因此高人做了修改...
分页插件jar包pagehelper
09-29
PageHelper是一款非常流行的MyBatis分页插件，它能够方便地实现数据库的分页查询功能。本压缩包包含了PageHelper的jar包以及其依赖的jsqlparser库。 1. **PageHelper插件**：PageHelper是针对MyBatis框架的一个辅助...
pagehelper-5.1.2-API文档-中文版.zip
07-13
赠送jar包：pagehelper-5.1.2.jar； 赠送原API文档：pagehelper-5.1.2-javadoc.jar； 赠送源代码：pagehelper-5.1.2-sources.jar； 赠送Maven依赖信息文件：pagehelper-5.1.2.pom； 包含翻译后的API文档：pagehelper...
pagehelper-5.1.10-API文档-中英对照版.zip
07-08
赠送jar包：pagehelper-5.1.10.jar； 赠送原API文档：pagehelper-5.1.10-javadoc.jar； 赠送源代码：pagehelper-5.1.10-sources.jar； 赠送Maven依赖信息文件：pagehelper-5.1.10.pom； 包含翻译后的API文档：...
Mybatis分页插件PageHelper最新版5.0.2jar包
05-31
Mybatis分页插件PageHelper最新版5.0.2jar包
pageHelper使用说明
05-10
mybatis-pageHelper使用说明.doc，mybatis-pageHelper工具说明书
PageHelper 使用详解
qq_45206201的博客
07-16 4221
pagehelper使用
分页工具--PageHelper介绍
qq_56438516的博客
09-12 992
对于某些特定的数据库和查询，可以通过自定义分页 SQL 来优化性能，例如使用 ID 范围查询或者 JOIN 查询来代替 LIMIT 分页。
分页查询实战：手把手教你用 PageHelper 实现优雅的分页功能！
Leaton的博客
03-03 2034
无论你是刚接触 MyBatis 的小白，还是有一定经验的开发者，这篇文章都能为你答疑解惑！是一个基于 MyBatis 的分页插件，它通过拦截 MyBatis 的执行器（Executor）来实现分页功能。从它的起源到现代应用，再到具体的代码实现和最佳实践，每一个环节都进行了详细的讲解。的核心思想是通过拦截 MyBatis 的 SQL 执行过程，在 SQL 执行前后动态添加分页逻辑。的不断发展，分页查询的功能会越来越强大。通过页分查询，我们可以将数据分成若干个“页面”，每次只加载当前页面的数据。
java常用的分页插件_Mybatis 分页插件 PageHelper 5.0.0 发布
weixin_36068140的博客
02-25 816
Mybatis分页插件 - PageHelperPageHelper 5.0.0 发布了。如果你也在用Mybatis，建议尝试该分页插件，这一定是最方便使用的分页插件。分页插件支持任何复杂的单表、多表分页，部分特殊情况请看重要提示。想要使用分页插件？请看如何使用分页插件。该插件目前支持以下数据库的物理分页:OracleMysqlMariaDBSQLiteHsqldbPostgreSQLDB2Sq...
Pagehelper无法处理select for update以及解决方法
rocklee的专栏
05-20 522
目录1、新的counter分析器2、新的MySqlDialect3、在适当的时机注册新的言语处理器   select for update 应该不少人会用到，用于更新前的锁定，按理来讲PageHelper只是查询分页，所以它没考虑到也是可以理解的（版本5.3.0)，具体问题： https://github.com/pagehelper/Mybatis-PageHelper/issues/671 Raw sql: select * from stock_tbl st where commodity_code
pageHelper
01-11
### PageHelper 分页插件使用教程 #### 导入依赖 为了在项目中使用PageHelper分页插件，首先需要导入相应的依赖。对于Maven项目来说，可以在`pom.xml`文件中加入如下配置来引入PageHelper： ```xml <dependency> <groupId>com.github.pagehelper</groupId> <artifactId>pagehelper</artifactId> <version>5.1.8</version> </dependency> ``` 此操作会自动下载并集成所需的库到工程环境中[^4]。 #### 插件初始化设置 接着，在Spring Boot应用程序或其他基于Spring框架的应用程序里，可以通过Java配置类或者XML形式注册该插件。通常推荐采用更简洁的Java Config方式来进行全局配置： ```java @Configuration public class MyBatisConfig { @Bean public PageHelper pageHelper() { PageHelper pageHelper = new PageHelper(); Properties p = new Properties(); p.setProperty("offsetAsPageNum", "true"); p.setProperty("rowBoundsWithCount", "true"); p.setProperty("reasonable", "true"); pageHelper.setProperties(p); return pageHelper; } } ``` 上述代码片段展示了如何创建一个自定义配置实例，并设置了几个常用的属性选项以优化性能表现和用户体验[^2]。 #### 实现基本分页逻辑 当完成了前期准备工作之后，便可以着手编写具体的业务处理函数了。下面给出了一段典型的DAO层接口实现示例，用于执行带有限制条件的数据检索请求： ```java // 假设有一个名为UserMapper.java 的 Mapper 接口 @Select("SELECT * FROM users WHERE status=#{status}") List<User> selectUsersByStatus(@Param("status") Integer status); // 对应的服务端控制器方法内调用 mapper 方法前加上分页语句即可轻松达成目的 int pageNum = 1; // 当前页面编号，默认第一页 int pageSize = 10; // 每页显示记录数 PageHelper.startPage(pageNum, pageSize); List<User> userList = userMapper.selectUsersByStatus(1); // 正常查询列表数据 System.out.println(new PageInfo<>(userList).getTotal()); // 输出总条目数量 ``` 这里的关键在于调用了静态工具类 `PageHelper.startPage()` 来指定当前要展示哪一部分的内容范围；随后正常发起SQL指令读取目标表中的信息集合；最后借助于辅助对象 `PageInfo<T>` 可方便地获取有关本次查询的一些统计指标，比如总数、是否有下一页等附加元数据[^1]。 ---
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值