mybatis分页插件之PageHelper使用

山羊夫子

已于 2022-04-29 14:09:10 修改

阅读量319

点赞数

分类专栏：开发组件文章标签： java

于 2022-04-29 13:51:10 首次发布

本文链接：https://blog.csdn.net/qq_24948625/article/details/124491976

版权

开发组件专栏收录该内容

3 篇文章 0 订阅

订阅专栏

一、简介
PageHelper是国内非常优秀的一款开源的mybatis分页插件，它支持基本主流与常用的数据库，例
如mysql、oracle、mariaDB、DB2、SQLite、Hsqldb等。
本项目在 github 的项目地址：https://github.com/pagehelper/Mybatis-PageHelper
本项目在 gitosc 的项目地址：http://git.oschina.net/free/Mybatis_PageHelper

二、依赖导入
2.1引入 Jar 包
你可以从下面的地址中下载最新版本的 jar 包
https://oss.sonatype.org/content/repositories/releases/com/github/pagehelper/pagehelper/ http://repo1.maven.org/maven2/com/github/pagehelper/pagehelper/
由于使用了sql 解析工具，你还需要下载 jsqlparser.jar：
http://repo1.maven.org/maven2/com/github/jsqlparser/jsqlparser/0.9.5/
2.2. 使用 Maven
在 pom.xml 中添加如下依赖：

<dependency>
	<groupId>com.github.pagehelper</groupId>
	<artifactId>pagehelper</artifactId>
	<version>5.1.4</version>
</dependency>

2.3springboot整合pagehelper

<dependency>
    <groupId>com.github.pagehelper</groupId>
    <artifactId>pagehelper-spring-boot-starter</artifactId>
    <version>1.2.13</version>
</dependency>

三、插件配置
3.1. 方式一：在 MyBatis 配置 xml 中配置拦截器插件

<!-- 
    plugins在配置文件中的位置必须符合要求，否则会报错，顺序如下:     properties?, settings?,     typeAliases?, typeHandlers?,  objectFactory?,objectWrapperFactory?, plugins?,  environments?, databaseIdProvider?, mappers?
-->
<plugins>
    <!-- com.github.pagehelper为PageHelper类所在包名 -->
    <plugin interceptor="com.github.pagehelper.PageInterceptor">
        <!-- 使用下面的方式配置参数，后面会有所有的参数介绍 -->
        <property name="param1" value="value1"/>
    </plugin>
</plugins>

3.2. 方式二：在 Spring 配置文件中配置拦截器插件
使用 spring 的属性配置方式，可以使用 plugins 属性像下面这样配置：

<bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
  <!-- 注意其他配置 -->
  <property name="plugins">
    <array>
      <bean class="com.github.pagehelper.PageInterceptor">
        <property name="properties">
          <!--使用下面的方式配置参数，一行配置一个 -->
          <value>             params=value1
          </value>
        </property>
      </bean>     </array>
  </property>
</bean>

3.3 方式三：零配置方案配置拦截器

@Bean
public SqlSessionFactoryBean getSqlSessionFactoryBean(DataSource da) {
    SqlSessionFactoryBean sqlSessionFactoryBean = new SqlSessionFactoryBean();
    sqlSessionFactoryBean.setDataSource(da);

    //设置分页的拦截器
    PageInterceptor pageInterceptor = new PageInterceptor();
    //创建插件需要的参数集合
    Properties properties = new Properties();
    //配置数据库方言 为oracle
    properties.setProperty("helperDialect", "oracle");
    //配置分页的合理化数据
    properties.setProperty("reasonable", "true");
    pageInterceptor.setProperties(properties);
    //将拦截器设置到sqlSessionFactroy中
    sqlSessionFactoryBean.setPlugins(new Interceptor[] {pageInterceptor});

    return sqlSessionFactoryBean;
}

3.4 案例：
在这里插入图片描述

四分页插件参数介绍
　　1. helperDialect ：分页插件会自动检测当前的数据库链接，自动选择合适的分页方式。你可以配置 helperDialect 属性来指定分页插件使用哪种方言。配置时，可以使用下面的缩写值：
　　oracle , mysql , mariadb , sqlite , hsqldb , postgresql , db2 , sqlserver , informix , h2 , sqlserver2012 , derby
　　特别注意：使用 SqlServer2012 数据库时，需要手动指定为 sqlserver2012 ，否则会使用 SqlServer2005 的方式进行分页。你也可以实现 AbstractHelperDialect ，然后配置该属性为实现类的全限定名称即可使用自定义的实现方法。
　　
2. offsetAsPageNum ：默认值为 false ，该参数对使用 RowBounds 作为分页参数时有效。当该参数设置为 true 时，会将 RowBounds 中的 offset 参数当成 pageNum 使用，可以用页码和页面大小两个参数进行分页。

3.rowBoundsWithCount ：默认值为 false ，该参数对使用 RowBounds 作为分页参数时有效。当该参数设置为 true 时，使用 RowBounds 分页会进行 count 查询。
　　　
4. pageSizeZero ：默认值为 false ，当该参数设置为 true 时，如果 pageSize=0 或者 RowBounds.limit = 0 就会查询出全部的结果（相当于没有执行分页查询，但是返回结果仍然是 Page 类型）。
　　　
5. reasonable ：分页合理化参数，默认值为 false 。当该参数设置为 true 时， pageNum<=0 时会查询第一页， pageNum>pages （超过总数时），会查询最后一页。默认 false 时，直接根据参数进行查询。
　　
6. params ：为了支持 startPage(Object params) 方法，增加了该参数来配置参数映射，用于从对象中根据属性名取值，可以配置 pageNum,pageSize,count,pageSizeZero,reasonable ，不配置映射的用默认值，默认值为 pageNum=pageNum;pageSize=pageSize;count=countSql;reasonable=reasonable;pageSizeZero= pageSizeZero 。
　　
7. supportMethodsArguments ：支持通过 Mapper 接口参数来传递分页参数，默认值 false ，分页插件会从查询方法的参数值中，自动根据上面 params 配置的字段中取值，查找到合适的
值时就会自动分页。使用方法可以参考测试代码中的 com.github.pagehelper.test.basic 包
下的 ArgumentsMapTest 和 ArgumentsObjTest
。
8. autoRuntimeDialect ：默认值为 false 。设置为 true 时，允许在运行时根据多数据源自动识别对应方言的分页（不支持自动选择 sqlserver2012 ，只能使用 sqlserver ），用法和注意事项参考下面的场景五。
　　　
9. closeConn ：默认值为 true 。当使用运行时动态数据源或没有设置 helperDialect 属性自动获取数据库类型时，会自动获取一个数据库连接，通过该属性来设置是否关闭获取的这个连接，默认 true 关闭，设置为 false 后，不会关闭获取的连接，这个参数的设置要根据自己选择的数据源来决定。

五、.基本使用
PageHelper的基本使用有6种，大家可以查看文档，最常用的有两种
５.1. RowBounds方式的调用（了解）
　　　List list = sqlSession.selectList(“x.y.selectIf”, null, new RowBounds(1, 10));
使用这种调用方式时，你可以使用RowBounds参数进行分页，这种方式侵入性最小，我们可以看到，通过RowBounds方式调用只是使用了这个参数，并没有增加其他任何内容。分页插件检测到使用了RowBounds参数时，就会对该查询进行物理分页。
关于这种方式的调用，有两个特殊的参数是针对 RowBounds 的，你可以参看上面的分页插件参数介绍
注：不只有命名空间方式可以用RowBounds，使用接口的时候也可以增加RowBounds参数，例如：

//这种情况下也会进行物理分页查询
List selectAll(RowBounds rowBounds);

注意：由于默认情况下的 RowBounds 无法获取查询总数，分页插件提供了一个继承自
RowBounds 的 PageRowBounds ，这个对象中增加了 total 属性，执行分页查询后，可以从该属
性得到查询总数。

５.2. PageHelper.startPage 静态方法调用（重点）
　　这种方式是我们要掌握的在你需要进行分页的 MyBatis 查询方法前调用PageHelper.startPage 静态方法即可，紧跟在这个方法后的第一个MyBatis 查询方法会被进行分页。

//在调用dao前的业务层方法使用
public PageInfo findAllProduct(Integer pageNum,Integer pageSize){
//获取第pageNum页，pageSize条内容，默认查询总数count
PageHelper.startPage(pageNum, pageSize);
//紧跟着的第一个select方法会被分页
List products = productDao.findAllProduct();
PageInfo pageInfo = new PageInfo(products);
return pageInfo;
};

5.3 参数方法调用（当supportMethodsArguments配置为true）（重点）
//存在以下 Mapper 接口方法，你不需要在 xml 处理后两个参数
public interface CountryMapper {undefined
List selectByPageNumSize(
@Param(“user”) User user,
@Param(“pageNum”) int pageNum,
@Param(“pageSize”) int pageSize);
}
//配置supportMethodsArguments=true
//在代码中直接调用：
List list = countryMapper.selectByPageNumSize(user, 1, 10);

5.4 参数对象（重点）
//如果 pageNum 和 pageSize 存在于 User 对象中，只要参数有值，也会被分页
//有如下 User 对象
public class User {undefined
//其他fields
//下面两个参数名和 params 配置的名字一致
private Integer pageNum;
private Integer pageSize;
}
//存在以下 Mapper 接口方法，你不需要在 xml 处理后两个参数
public interface CountryMapper {undefined
List selectByPageNumSize(User user);
}
//当 user 中的 pageNum!= null && pageSize!= null 时，会自动分页
List list = countryMapper.selectByPageNumSize(user);

案例：
在这里插入图片描述