标签：
分页如果写在SQL脚本中，将会大大影响我们后续数据库的迁移难度。mybatis的分页一般是自己实现一个mybatis的拦截器，然后根据某些特定的条件开启分页，对原有SQL进行改造。
正在我对mybatis的拦截器进行研究的时候从网上找到了一个很好的分页插件，主页地址是 https://github.com/pagehelper/Mybatis-PageHelper
已经实现了拦截器/多种数据库的适配 基本上很方便的即可集成到我们的项目中。集成方式：
１．使用maven引入jar包：
<dependency> <groupId>com.github.pagehelper</groupId> <artifactId>pagehelper</artifactId> <version>4.0.3</version> </dependency>
２．在mybatis的配置文件中进行配置：
<plugins> <!-- com.github.pagehelper为PageHelper类所在包名 --> <plugin interceptor="com.github.pagehelper.PageHelper"> <!-- 4.0.0以后版本可以不设置该参数 --> <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="false"/> <!-- 3.5.0版本可用 - 为了支持startPage(Object params)方法 --> <!-- 增加了一个`params`参数来配置参数映射，用于从Map或ServletRequest中取值 --> <!-- 可以配置pageNum,pageSize,count,pageSizeZero,reasonable,orderBy,不配置映射的用默认值 --> <!-- 不理解该含义的前提下，不要随便复制该配置 --> <property name="params" value="pageNum=start;pageSize=limit;"/> <!-- 支持通过Mapper接口参数来传递分页参数 --> <property name="supportMethodsArguments" value="true"/> <!-- always总是返回PageInfo类型,check检查返回类型是否为PageInfo,none返回Page --> <property name="returnPageInfo" value="check"/> </plugin> </plugins>
方言dialect可以不设置，以免以后更换数据库忘记改这里出现问题。
3.然后就可以使用了：
下面这种方法一般情况下是逻辑分页，mybatis把所有数据查出来然后才分页，基本没用。 但是我们进行上面的处理之后，拦截器会在底层处理，下面这个方法就变成了一个物理分页，可以从打印的sql看出来：
其中 因为我们设置了 offsetAsPageNum=true 所以这个offset只需要传入pagenum就行了。
public <T>List<T> queryForPaginatedList(Object mapId, Object param, int offset,int limit) throws Exception { if (!(mapId instanceof String)) { log.info(PARAM_ERROR); return null; } List<T> result = null; try { result = getSqlSession().selectList((String) mapId, param, new RowBounds(offset, limit)); } catch (DataAccessException e) { throw new Exception(e.getMessage(), e); } return result; }
另一种使用方法，使用这个插件的PageInfo对象，我们会把他封装成我们框架自己的page对象，以免影响现有业务：
/** * 已处理的数据库物理分页 * @param mapId * @param param * @param offset pageno * @param limit pagesize * @return * @throws Exception */ public <T>Page<T> queryForPaginated(Object mapId, Object param, int offset,int limit) throws Exception { if (!(mapId instanceof String)) { log.info(PARAM_ERROR); return null; } PageInfo<T> pageInfo = null; try { List<T> result = getSqlSession().selectList((String) mapId, param, new RowBounds(offset, limit)); pageInfo = new PageInfo<>(result); } catch (DataAccessException e) { throw new Exception(e.getMessage(), e); } return new Page<T>(pageInfo.getPageNum(), pageInfo.getTotal(),pageInfo.getPageSize(),pageInfo.getList()); }
这个插件还支持一种静态方法调用：
PageHelper.startPage(1, 10);
List<Country> list = countryMapper.selectIf(1);
使用PageHelper的静态方法调用完了之后，紧跟着的第一个查询会被分页。我看了下代码，底层使用ThreadLocal方式处理的，没有线程安全问题，但是这种方法只能处理第一个查询限制比较多，而且我们的工程没有使用mapper接口的方式来做实现。
最后还有一种调用方式：
List<Country> list = sqlSession.selectList("x.y.selectIf", null, new RowBounds(1, 10));
使用这种调用方式时，你可以使用RowBounds参数进行分页，这种方式侵入性最小，我们可以看到，通过RowBounds方式调用只是使用了这个参数，并没有增加其他任何内容。分页插件检测到使用了RowBounds参数时，就会对该查询进行物理分页。
至此，基本上分页就搞定了，更换数据库类型SQL的改变也不会很多。
补充：这个插件使用了jsqlparser.jar 版本是0.9.1的 因为我们工程里原来有一个0.8的，报错了好久才找到问题，后来干掉0.8的使用插件自己依赖的0.9.1的才正常运行。
标签：
原文地址：http://www.cnblogs.com/radio/p/4979791.html
