#Mybatis分页插件 - PageHelper说明
##最新版为3.2.2 版
如果你也在用Mybatis,建议尝试该分页插件,这个一定是最方便使用的分页插件。
该插件目前支持Oracle
,Mysql
,Hsqldb
三种数据库分页。
##多数据库支持
-
感谢鲁家宁增加的对
Mysql
的支持 -
增加对
Hsqldb
的支持,方便测试使用 -
欢迎各位提供其他数据库版本的分页插件
##使用方法
将本插件中的两个类Page.java
和PageHelper.java
放到项目中,如果需要使用PageInfo.java
,也可以放到项目中。
或者如果你使用Maven,你可以添加如下依赖:
<dependency>
<groupId>com.github.pagehelper</groupId>
<artifactId>pagehelper</artifactId>
<version>3.2.2</version>
</dependency>
然后在Mybatis的配置xml中配置拦截器插件:
<!--
plugins在配置文件中的位置必须符合要求,否则会报错,顺序如下:
properties?, settings?,
typeAliases?, typeHandlers?,
objectFactory?,objectWrapperFactory?,
plugins?,
environments?, databaseIdProvider?, mappers?
-->
<plugins>
<!-- com.github.pagehelper为PageHelper类所在包名 -->
<plugin interceptor="com.github.pagehelper.PageHelper">
<property name="dialect" value="mysql"/>
<!-- 该参数默认为false -->
<!-- 设置为true时,会将RowBounds第一个参数offset当成pageNum页码使用 -->
<!-- 和startPage中的pageNum效果一样-->
<property name="offsetAsPageNum" value="true"/>
<!-- 该参数默认为false -->
<!-- 设置为true时,使用RowBounds分页会进行count查询 -->
<property name="rowBoundsWithCount" value="true"/>
</plugin>
</plugins>
这里的com.github.pagehelper.PageHelper
使用完整的类路径。
其他三个参数说明:
-
增加
dialect
属性,使用时必须指定该属性,可选值为oracle
,mysql
,hsqldb
,没有默认值,必须指定该属性。 -
增加
offsetAsPageNum
属性,默认值为false
,使用默认值时不需要增加该配置,需要设为true
时,需要配置该参数。当该参数设置为true
时,使用RowBounds
分页时,会将offset
参数当成pageNum
使用,可以用页码和页面大小两个参数进行分页。 -
增加
rowBoundsWithCount
属性,默认值为false
,使用默认值时不需要增加该配置,需要设为true
时,需要配置该参数。当该参数设置为true
时,使用RowBounds
分页会进行count查询。
###不支持的情况
对于关联结果查询,使用分页得不到正常的结果,因为只有把数据全部查询出来,才能得到最终的结果,对这个结果进行分页才有效(Mybatis自带的内存分页也无法对这种情况进行正确的分页)。因而如果是这种情况,必然要先全部查询,在对结果处理,这样就体现不出分页的作用了。解决这种情况的最简单的方法就是使用关联嵌套查询。
相关内容:Mybatis关联结果查询分页方法
##Mybatis-Sample项目
这个项目是一个分页插件的测试项目,使用Maven构建,该项目目前提供了4种基本使用方式的测试用例,需要测试Mybatis分页插件的可以clone该项目。该项目使用了maven配置的该分页插件。
项目地址:http://git.oschina.net/free/Mybatis-Sample
##分页示例: ```java @Test public void testPageHelperByStartPage() throws Exception { String logip = ""; String username = "super"; String loginDate = ""; String exitDate = null; String logerr = null; //不进行count查询,第三个参数设为false PageHelper.startPage(1, 10, false); //返回结果是Page //该对象除了包含返回结果外,还包含了分页信息,可以直接按List使用 List logs = sysLoginLogMapper .findSysLoginLog(logip, username, loginDate, exitDate, logerr); Assert.assertEquals(10, logs.size());
//当第三个参数没有或者为true的时候,进行count查询
PageHelper.startPage(2, 10);
//返回结果是Page<SysLoginLog>
//该对象除了包含返回结果外,还包含了分页信息,可以直接按List使用
Page<SysLoginLog> page = (Page<SysLoginLog>) sysLoginLogMapper
.findSysLoginLog(logip, username, loginDate, exitDate, logerr);
Assert.assertEquals(10, page.getResult().size());
//进行count查询,返回结果total>0
Assert.assertTrue(page.getTotal() > 0);
}
因为新增了一个Mybatis-Sample项目,所以这里的示例只是简短的一部分,需要更丰富的示例,请查看[Mybatis-Sample][10]项目
###对于两种分页方式如何选择
1. 如果你不想在Mapper方法上增加一个带`RowBounds`参数的方法,并且你喜欢用Mapper接口形式调用,你可以使用`PageHelper.startPage`,并且该方法可以控制是否执行count方法。
2. 实际上在Mapper接口中添加一个带`RowBounds`参数的方法很容易,使用和不带`RowBounds`参数一样的xml就可以。
3. 如果你喜欢使用`sqlSession.selectList`这种命名空间方式的调用,使用`RowBounds`会更方便。
###关于MappedStatement
```java
MappedStatement qs = newMappedStatement(ms, new BoundSqlSqlSource(boundSql));
这段代码执行100万次耗时在1.5秒(测试机器:CPU酷睿双核T6600,4G内存)左右,因而不考虑对该对象进行缓存等考虑
##相关链接
Mybatis-Sample(分页插件测试项目):http://git.oschina.net/free/Mybatis-Sample
Mybatis项目:https://github.com/mybatis/mybatis-3
Mybatis文档:http://mybatis.github.io/mybatis-3/zh/index.html
Mybatis专栏:
作者博客:
##更新日志
###v3.2.2
-
简单重构优化代码。
-
新增
PageInfo
包装类,对分页结果Page进行封装,方便EL使用。 -
将
SystemMetaObject
类的fromObject
方法内置到分页插件中,方便低版本的Mybatis使用该插件。
###v3.2.1
-
新增
offsetAsPageNum
参数,用来控制RowBounds
中的offset
是否作为pageNum
使用,pageNum
和startPage
中的含义相同,pageNum
是页码。该参数默认为false
,使用默认值时,不需要配置该参数。 -
新增
rowBoundsWithCount
参数,用来控制使用RowBounds
时是否执行count
查询。该参数默认为false
,使用默认值时,不需要配置该参数。
###v3.2.0
-
增加了对
Hsqldb
的支持,主要目的是为了方便测试使用Hsqldb
-
增加了该项目的一个测试项目Mybatis-Sample,测试项目数据库使用
Hsqldb
-
增加MIT协议
###v3.1.2
- 解决count sql在
oracle
中的错误
###v3.1.1
- 统一返回值为
Page<E>
(可以直接按List
使用),方便在页面使用EL表达式,如${page.pageNum}
,${page.total}
###v3.1.0
-
解决了
RowBounds
分页的严重BUG,原先会在物理分页基础上进行内存分页导致严重错误,已修复 -
增加对MySql的支持,该支持由鲁家宁增加。
###v3.0
-
现在支持两种形式的分页,使用
PageHelper.startPage
方法或者使用RowBounds
参数 -
PageHelper.startPage
方法修改,原先的startPage(int pageNum, int pageSize)
默认求count,新增的startPage(int pageNum, int pageSize, boolean count)
设置count=false
可以不执行count查询 -
移除
endPage
方法,现在本地变量localPage
改为取出后清空本地变量。 -
修改
Page<E>
类,继承ArrayList<E>
-
关于两种形式的调用,请看示例代码
###v2.1
-
解决并发异常
-
分页sql改为直接拼sql
###v2.0
-
支持Mybatis缓存,count和分页同时支持(二者同步)
-
修改拦截器签名,拦截
Executor
-
将
Page<E>
类移到外面,方便调用
###v1.0
-
支持
<foreach>
等标签的分页查询 -
提供便捷的使用方式