文章目录
PageHelper
1. PageHelper介绍
PageHelper 是国内非常优秀的一款开源的mybatis分页插件,它支持基恩主流与常用的数据库,例如mysql、oracle、mariaDB、DB2、SQLite、Hsqldb等。
本项目在gitosc的项目地址:https://gitee.com/free/Mybatis_PageHelper
本片博主所使用的例子:https://github.com/Atk-9527/myabtisPagehelper
2. PageHelper的使用
2.1 集成
引入分页插件有以下两种方式,推荐使用Maven方式:
2.1.1 引入jar包
从下列地址下载最新的PageHelper jar包:
https://mvnrepository.com/artifact/com.github.pagehelper/pagehelper
由于还使用了sql解析工具,你还需要下载jsqlparser.jar:
https://mvnrepository.com/artifact/com.github.jsqlparser/jsqlparser
2.1.2 在pom中引入依赖:
<!-- https://mvnrepository.com/artifact/com.github.pagehelper/pagehelper -->
<dependency>
<groupId>com.github.pagehelper</groupId>
<artifactId>pagehelper</artifactId>
<version>5.1.10</version>
</dependency>
2.2 配置
特别注意,新版拦截器是com.github.pagehelper.PageInterceptor
.com.github.pagehelper.PageHelper
现在是一个特殊的实现类,是分页插件的默认实现类,提供了和以前相同的用法。
2.2.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>
2.2.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>
2.2.3 分页插件参数介绍:
-
helperDialect
:分页插件会自动检测当前的数据库连接,自动选择合适的分页方式。你可配置helperDialect
属性来制定分页插件使用哪种语言。配置时,可以使用下面的缩写值:oracle
,mysql
,mariadb
,sqlite
,hsqldb
,postgresql
,oracle
,oracle
,db2
,sqlserver
,informix
,h2
,sqlserver2012
,derby
。**特别注意:**使用SQLserver2012数据时,需要手动设置为:
sqlserver2012
,否则会使用sqlserver2005的方式进行分页。你也可以实现
AbstractHelperDialect
,然后配置该属性为实现类的全限定名称即可使用自定义的实现方法。 -
offsetAsPageNum
:默认值为false
,该参数对使用RowBounds
作为分页参数时有效。 当该参数设置为true
时,会将RowBounds
中的offset
参数当成pageNum
使用,可以用页码和页面大小两个参数进行分页。 -
rowBoundsWithCount
:默认值为false
,该参数对使用RowBounds
作为分页参数时有效。 当该参数设置为true
时,使用RowBounds
分页会进行count
查询。 -
pageSizeZero
:默认值为false
,当该参数设置为true
时,如果 pageSize=0 或者RowBounds.limit = 0
就会查询出全部的结果(相当于没有执行分页查询,但是返回结果仍然是Page
类型)。 -
reasonable
:分页合理化参数,默认值为false
。当该参数设置为true
时,pageNum<=0
时会查询第一页,pageNumpages
(超过总数时),会查询最后一页。默认false
时,直接根据参数进行查询。 -
params
:为了支持startPage(Object params)
方法,增加了该参数来配置参数映射,用于从对象中根据属性名取值, 可以配置pageNum,pageSize,count,pageSizeZero,reasonable
,不配置映射的用默认值, 默认值为pageNum=pageNum;pageSize=pageSize;count=countSql;reasonable=reasonable;pageSizeZero=pageSizeZero
。 -
supportMethodsArguments
:支持通过Mapper
接口参数来传递分页参数,默认值false
,分页插件会从查询方法的参数值中,自动根据上面params
配置的字段中取值,查找到合适的值时就会自动分页。 使用方法可以参考测试代码中的com.github.pagehelper.test.basic
包下的ArgumentsMapTest
和ArgumentsObjTest
。 -
autoRuntimeDialect
:默认值为false
。设置为true
时,允许在运行时根据多数据源自动识别对应语言的分页 (不支持自动选择 sqlserver2012 ,只能使用 sqlserver ),用法和注意事项参考下面的场景五。 -
closeConn
:默认值为true
。当使用运行时动态数据源或没有设置helperDialect
属性自动获取数据库类型时,会自动获取一个数据库连接, 通过该属性来设置是否关闭获取的这个连接,默认true
关闭,设置为false
后,不会关闭获取的连接,这个参数的设置要根据自己选择的数据源来决定。
2.3 基本使用
PageHelper的基本使用有6种,请参考文档,最常用的有两种
2.3.1 RowBounds方式的调用(了解)
List<Country> list = sqlSession.selectList("x.y.selectIf", null, new RowBounds(1, 10));
使用这种调用方式时,你可以使用RowBounds参数进行分页,这种方式入侵性最小,我们可以看到,通过RowBounds方式调用只是使用了这个参数,并没有增加其他任何内容。
分页插件检测到使用了RowBounds参数时,就会对该查询进行物理分页。
关于这种方式的调用,有两个特殊的参数是针对 RowBounds
的,你可以参看上面的分页插件介绍。
注:不只有命名方式可以用RowBounds,使用接口的时候也可以增加RowBounds参数,例如:
//这种情况下也会进行物理分页查询
List<Country> selectAll(RowBounds rowBounds);
注意:由于默认情况下RowBounds
无法获取查询总数,分页插件提供了一个继承自RowBounds
的PageRowBounds
,这个对象中增加了total
属性,执行分页查询后,可以从该属性得到查询的总数。
2.3.2 PageHelper.startPage静态方法调用(重点)
这种方式是我们要掌握的。在你需要进行分页的Mybatis查询方法前调用PageHelper.startPage静态方法即可,紧跟在这个方法后的第一个Mybatis查询方法会被进行分页。
//获取第1页,10条内容,默认查询总数
countPageHelper.startPage(1, 10)
//紧跟着的第一个select方法会被分页
List<Country> list = countryMapper.selectIf(1);