PageHelper 补充

最新推荐文章于 2025-04-16 11:05:05 发布

原创最新推荐文章于 2025-04-16 11:05:05 发布 · 372 阅读

0 ·

CC 4.0 BY-SA版权

文章标签：

#Mybatis #PageHelper

技术同时被 2 个专栏收录

16 篇文章

订阅专栏

开发

16 篇文章

订阅专栏

本文详细介绍了PageHelper分页插件的功能和使用方法，包括如何实现分页查询、统计总数、不分页查询等操作，并提供了多个示例代码片段。此外还探讨了PageHelper在多线程环境下可能存在的安全问题及解决办法。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

内容来自各位网络大神的分享，小弟在此借鉴、总结了一下。

1、PageHelper的优点是，分页和Mapper.xml完全解耦。实现方式是以插件的形式，对Mybatis执行的流程进行了强化，添加了总数count和limit查询。属于物理分页。
2、Page page = PageHelper.startPage(pageNum, pageSize, true); - true表示需要统计总数，这样会多进行一次请求select count(0); 省略掉true参数只返回分页数据。
1)统计总数，（将SQL语句变为 select count(0) from xxx,只对简单SQL语句其效果，复杂SQL语句需要自己写）
Page page = PageHelper.startPage(1,-1);
long count = page.getTotal();
2)分页，pageNum - 第N页， pageSize - 每页M条数
A、只分页不统计(每次只执行分页语句)
PageHelper.startPage([pageNum],[pageSize]);
List pagelist = queryForList( xxx.class, “queryAll” , param);//pagelist就是分页之后的结果
B、分页并统计（每次执行2条语句，一条select count语句，一条分页语句）适用于查询分页时数据发生变动，需要将实时的变动信息反映到分
Page page = PageHelper.startPage([pageNum],[pageSize],[iscount]);
List pagelist = queryForList( xxx.class , “queryAll” , param);
long count = page.getTotal();
Or
List pagelist = page.getList();分页后的结果集
3)使用PageHelper查全部（不分页）
PageHelper.startPage(1,0);
List alllist = queryForList( xxx.class , “queryAll” , param);

4)PageHelper的其他API

    String orderBy = PageHelper.getOrderBy();    //获取orderBy语句
    Page<T> page = PageHelper.startPage(Object params);
    Page<T> page = PageHelper.startPage(int pageNum, int pageSize);
    Page<T> page = PageHelper.startPage(int pageNum, int pageSize, boolean isCount);
    Page<T> page = PageHelper.startPage(pageNum, pageSize, orderBy);
    Page<T> page = PageHelper.startPage(pageNum, pageSize, isCount, isReasonable);    //isReasonable分页合理化,null时用默认配置
    Page<T> page = PageHelper.startPage(pageNum, pageSize, isCount, isReasonable, isPageSizeZero);    //isPageSizeZero是否支持PageSize为0，true且pageSize=0时返回全部结果，false时分页,null时用默认配置

5)、默认值
//RowBounds参数offset作为PageNum使用 - 默认不使用
private boolean offsetAsPageNum = false;
//RowBounds是否进行count查询 - 默认不查询
private boolean rowBoundsWithCount = false;
//当设置为true的时候，如果pagesize设置为0（或RowBounds的limit=0），就不执行分页，返回全部结果
private boolean pageSizeZero = false;
//分页合理化
private boolean reasonable = false;
//是否支持接口参数来传递分页参数，默认false
private boolean supportMethodsArguments = false;

pageHelper什么时候会导致不安全的分页？
PageHelper 方法使用了静态的 ThreadLocal 参数，分页参数和线程是绑定的。
只要你可以保证在 PageHelper 方法调用后紧跟 MyBatis 查询方法，这就是安全的。因为 PageHelper 在 finally 代码段中自动清除了 ThreadLocal 存储的对象。
如果代码在进入 Executor 前发生异常，就会导致线程不可用，这属于人为的 Bug（例如接口方法和 XML 中的不匹配，导致找不到 MappedStatement 时），这种情况由于线程不可用，也不会导致 ThreadLocal 参数被错误的使用。
应该写成下面这个样子：

List<Country> list;
if(param1 != null){
    PageHelper.startPage(1, 10);
    list = countryMapper.selectIf(param1);
} else {
    list = new ArrayList<Country>();
}

这种写法就能保证安全。