PageHelper的使用

PageHelper

文章目录

PageHelper
- - - 引入依赖
    - 配置
    - 使用
    - 方法解读
    - - PageHelper.startPage
        Page
        PageInfo

引入依赖

<!-- spring-boot mybatis pagehelper -->
<dependency><groupId>com.github.pagehelper</groupId><artifactId>pagehelper-spring-boot-starter</artifactId><version>1.4.1</version>
</dependency>

引入最新的就可以，引入旧版会出现循环依赖问题

以下方法不推荐：

<!-- pageHelper -->
<dependency><groupId>com.github.pagehelper</groupId><artifactId>pagehelper</artifactId><version>5.1.10</version>
</dependency>

引入这个需要自己去手动注入

@BeanPageHelper pageHelper(){//分页插件PageHelper pageHelper = new PageHelper();Properties properties = new Properties();properties.setProperty("reasonable", "true");properties.setProperty("supportMethodsArguments", "true");properties.setProperty("returnPageInfo", "check");properties.setProperty("params", "count=countSql");pageHelper.setProperties(properties);//添加插件new SqlSessionFactoryBean().setPlugins(new Interceptor[]{pageHelper});return pageHelper;}

配置

pagehelper:helper-dialect: mysqlreasonable: truesupport-methods-arguments: true

使用

在查询操作之前调用 startPage 设置分页信息，设置页码和每页的条数

注意startPage只会对下一次SQL查询有效，如果调用两次SQL查询，则需要调用两次startPage

public Object getUsers(int pageNum, int pageSize) {Page<User> page = PageHelper.startPage(pageNum, pageSize);// 不带分页的查询List<UserEntity> list = userMapper.selectAllWithPage();// 将查询结果会自动设置到 Page 对象中System.out.println("listCnt:" + listWithPage.getTotal());// 2. 也可使用 PageInfo 来接收PageInfo<UserEntity> pageinfo = new PageInfo(list);return list;
}

方法解读

PageHelper.startPage

PageHelper.startPage(pageNum, pageSize, count, reasonable, pageSizeZero, reasonablePageSizes) 方法完整的签名如下：

javaCopy code
public static <E> Page<E> startPage(int pageNum, int pageSize, boolean count, Boolean reasonable, Boolean pageSizeZero, Boolean reasonablePageSizes);

其中，参数的含义如下：

pageNum：表示当前页码，即要查询的页数。
pageSize：表示每页显示的记录数。
count：表示是否进行总记录数的统计。如果设置为 true，PageHelper 会自动在执行分页查询前执行一次 count 查询，获取总记录数；如果设置为 false，则不会执行 count 查询。
reasonable：表示是否开启合理化设置。如果设置为 true，PageHelper 会自动根据当前页码和每页大小来调整分页参数，以保证查询结果不为空且不超出数据范围；如果设置为 false，则不开启合理化设置。
pageSizeZero：表示是否当 pageSize 参数为 0 时返回全部结果。如果设置为 true，当 pageSize 参数为 0 时，PageHelper 会执行特殊处理，返回全部结果；如果设置为 false，则按照正常逻辑处理，返回空结果。
reasonablePageSizes：表示是否在合理化设置中使用合理的每页大小。如果设置为 true，PageHelper 会根据当前页码和每页大小来调整分页参数，以确保每页大小合理；如果设置为 false，则只会根据当前页码来调整分页参数，不考虑每页大小是否合理。

PageInfo

PageInfo 类是 PageHelper 提供的用于封装分页查询结果和分页信息的类。下面是 PageInfo 类的构造方法和常用参数：

构造方法：

javaCopy codepublic PageInfo(List<T> list, int navigatePages);
public PageInfo(List<T> list, int navigatePages, int pageNum);
public PageInfo(List<T> list, int navigatePages, int pageNum, long total);