Mybatis分页插件PageHelper实现自动分页

今天尝试向项目中添加了一项新的功能——分页查询，查询了很多资料，最后发现使用Mybatis分页插件Pagehelper来实现最为方便。

pagehelper插件实现分页查询十分方便，主要通过以下几个步骤：

1.引入分页插件

由于项目采用maven来管理jar包，所以可以在pom.xml 中添加如下依赖：<dependency>
<groupId>com.github.pagehelper</groupId>
<artifactId>pagehelper</artifactId>
<version>${mybatis-pagehelper.version}</version>
</dependency>

mybatis-pagehelper.version为该插件的最新版本号。

2.配置拦截插件

在MyBatis的xml配置文件中添加如下配置信息：

<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=pageHelperStart;pageSize=pageHelperRows;" />

<!-- 支持通过Mapper接口参数来传递分页参数 -->
<property name="supportMethodsArguments" value="false" />

<!-- always总是返回PageInfo类型,check检查返回类型是否为PageInfo,none返回Page -->
<property name="returnPageInfo" value="none" />
</plugin>
</plugins>

分页插件参数的具体介绍可见Pagehelper官方文档。

3.在代码中使用该插件

在sql执行前引入该插件，完成分页操作，即在mapper接口方法执行之前。

@RestController
public class IndexHistoryEndpoint {

@Resource
private IndexHistoryMapper indexHistoryMapper;

@ResponseBody
@RequestMapping(value = { "api/v1/indexhistory" }, method = RequestMethod.GET)
public PageInfo listIndexHistory(
@RequestParam(value = "pageNum", required = false, defaultValue = "1") Integer pageNum,
@RequestParam(value = "pageSize", required = false, defaultValue = "10") Integer pageSize) {
PageHelper.startPage(pageNum, pageSize);
List list = indexHistoryMapper.listindexHistory();
PageInfo pageInfo = new PageInfo(list);
return  pageInfo;
}
}

这样便可以完成了该插件的全部配置。

为何要用此插件？

mybatis提供的分页效率低。

Select * from user limit #{p1},#{p2}传统的分页有何不足之处？

Select * from user limit #{p1},#{p2} mybatis内部在看到jdbc的Resultset对象时，用游标定位offset的位置，只处理limit条记录。

场景：当数据库105万条数据，1万1页，我要查第一百页，那就是第1000001到条1010000条，使用这种分页查询，先是查询全部105万条，然后截取所对应页码的记录，效率不行。