Mybatis 数据库物理分页插件 PageHelper
以前使用ibatis/mybatis，都是自己手写sql语句进行物理分页，虽然稍微有点麻烦，但是都习惯了。最近试用了下mybatis的分页插件 PageHelper,感觉还不错吧。记录下其使用方法。
1. 引入依赖jar包：
<dependency>
<groupId>com.github.pagehelper</groupId>
<artifactId>pagehelper</artifactId>
<version>3.7.5</version>
</dependency>
2. 配置分页拦截器
PageHelper的原理是基于拦截器实现的。拦截器的配置有两种方法，一种是在mybatis的配置文件中配置，一种是直接在spring的配置文件中进行：
1）在mybatis-config.xml文件中配置：
<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"/>
<!-- 设置为true时，如果pageSize=0或者RowBounds.limit = 0就会查询出全部的结果 -->
<!-- （相当于没有执行分页查询，但是返回结果仍然是Page类型）
<property name="pageSizeZero" value="true"/>-->
<!-- 3.3.0版本可用 - 分页参数合理化，默认false禁用 -->
<!-- 启用合理化时，如果pageNum<1会查询第一页，如果pageNum>pages会查询最后一页 -->
<!-- 禁用合理化时，如果pageNum<1或pageNum>pages会返回空数据 -->
<property name="reasonable" value="true"/>
<!-- 3.5.0版本可用 - 为了支持startPage(Object params)方法 -->
<!-- 增加了一个`params`参数来配置参数映射，用于从Map或ServletRequest中取值 -->
<!-- 可以配置pageNum,pageSize,count,pageSizeZero,reasonable,不配置映射的用默认值 -->
<!-- 不理解该含义的前提下，不要随便复制该配置
<property name="params" value="pageNum=start;pageSize=limit;"/> -->
</plugin>
</plugins>
这里要注意 <plugins> 在mybatis-config.xml文件中的位置，必须要符合 http://mybatis.org/dtd/mybatis-3-config.dtd 中指定的顺序：
<!ELEMENT configuration (properties?, settings?, typeAliases?, typeHandlers?,
objectFactory?, objectWrapperFactory?, plugins?, environments?, databaseIdProvider?, mappers?)>
不然会报错。
当然mybatis-config.xml的位置，我们需要在spring的配置文件中进行指定：
<bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
<property name="dataSource" ref="dataSource" />
<property name="configLocation" value="classpath:config/mybatis-config.xml" />
<property name="mapperLocations" value="classpath*:config/mappers/**/*.xml" />
</bean>
2）如果mybatis没有mybatis-config.xml文件，那么就只能直接在spring的配置文件中配置了：
<bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
<property name="dataSource" ref="dataSource"/>
<property name="mapperLocations">
<array>
<value>classpath:config/mapper/*.xml</value>
</array>
</property>
<property name="typeAliasesPackage" value="com.test.pojo"/>
<property name="plugins">
<array>
<bean class="com.github.pagehelper.PageHelper">
<property name="properties">
<value>
dialect=mysql
</value>
</property>
</bean>
</array>
</property>
</bean>
到这里PageHelper所需要的配置已经完成，下面还需要在serviceImpl类中加入分页参数的代码：
3. 向拦截器传递分页参数
我们首先看下不分页的serviceImpl代码：
@Override
public List<User> getUserByNoAndEmail(String no, String email) {
Map<String, Object> map = new HashMap<>();
map.put("no", no);
map.put("email", email);
return this.userMapper.getUserByNoAndEmail(map);
}
然后我们将它改造成使用PageHelper分页：
1）首先我们根据自己项目的情况，定义一个PageBean，来保存分页之后的结果，需要哪些属性，就加入哪些属性，具体可以参考源代码中的PageInfo类的定义，其实PageInfo是插件作者给我们自己定义自己的PageBean，提供的一个参考例子。PageInfo代码如下：
PageInfo.java因为PageInfo.java只是一个示例，所以他定义得有点重量级，属性有点多，我们可以参考它，定义适合我们自己的PageBean, 比如如下定义：
PageBean.java因为分页查询结果返回的是一个 Page 对象，而 Page 对象继承自ArrayList，但是如果我们直接返回ArrayList的话，在一些场景下回遇到问题，比如在JSON处理Page类型的结果时，会被当成List来JSON格式化，会丢弃 Page 对象的所有扩展属性，所以这里我们要将分页的结果 Page 类型转换成我们自己定义的 PageBean. 我们自己定义的PageBean没有继承ArrayList，而是包含一个List属性来保存分页结果。所以避免前面的问题。
2）修改 serviceImpl中的代码：
@Override
public PageBean<User> getUserByNoAndEmail(String no, String email) {
Map<String, Object> map = new HashMap<>();
map.put("no", no);
map.put("email", email);
PageHelper.startPage(PaginationContext.getPageNum(), PaginationContext.getPageSize());
List<User> list = this.userMapper.getUserByNoAndEmail(map);
return new PageBean<User>(list);
}
我们只需要使用 PageHelper.startPage(pageNum, pageSize); 函数来指定 pageNum(第几页) 和 pageSize(每页显示几条记录) 两个参数。然后调用原来的查询，就进行了分页。最后将返回的List，转换成 PageBean类型的结果即可。前台页面就可以根据PageBean中包括的属性来进行分页显示了。
上面的 PaginationContext 是基于 ThreadLocal 来传递分页参数的一个工具类，其实现如下：
PaginationContext.java实现了前台页面向ServiceImpl中传递分页参数： pageNum 和 pageSize.
当然从请求中获取分页参数pageNum和pageSize需要用到filter:
PageFilter.javaPageFilter在web.xml中的配置：
<!-- pagination filter -->
<filter>
<filter-name>PageFilter</filter-name>
<filter-class>com.ems.filter.PageFilter</filter-class>
</filter>
<filter-mapping>
<filter-name>PageFilter</filter-name>
<url-pattern>/*</url-pattern>
</filter-mapping>
OK，到此，PageHelper的使用方法，基本结束。
PageHelper 项目地址：http://git.oschina.net/free/Mybatis_PageHelper
文档地址：http://git.oschina.net/free/Mybatis_PageHelper/blob/master/wikis/HowToUse.markdown
