Mybatis基于MySql分页插件PageHelper的使用

一、 Mybatis 框架的分页插件 PageHelper 是目前我用过的最简单的分页插件了，该插件 目前支持 Oracle ， Mysql ， MariaDB ， SQLite ， Hsqldb ， PostgreSQL 六种数据库分页。

他的使用非常简单， 简要步骤如下：

第一步：添加jar包到工程中

<dependency>
 <groupId>com.github.pagehelper</groupId>
 <artifactId>pagehelper</artifactId>
 <version>4.0.0</version>
</dependency>

第二步：在 SqlMapConfig.xml ，配置一个 plugin ， 如下

<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="false"/>
        <!-- 3.5.0版本可用 - 为了支持startPage(Object params)方法 -->
        <!-- 增加了一个`params`参数来配置参数映射，用于从Map或ServletRequest中取值 -->
        <!-- 可以配置pageNum,pageSize,count,pageSizeZero,reasonable,不配置映射的用默认值 -->
        <!-- 不理解该含义的前提下，不要随便复制该配置 -->
        <property name="params" value="pageNum=start;pageSize=limit;"/>
        <!-- always总是返回PageInfo类型,check检查返回类型是否为PageInfo,none返回Page -->
        <property name="returnPageInfo" value="check"/>
    </plugin>
</plugins>

第三步：在 sql 语句执行之前，添加一个 PageHelper.startPage(page,rows)

pageNo = pageNo == null?1:pageNo;
pageSize = pageSize == null?10:pageSize;
PageHelper.startPage(pageNo, pageSize);//关键步骤
List<OrderListDto> list =  orderListlDao.queryOrderList(map);

第四步： 取分页结果 。创建一个 PageInfo 对象， 需要的参数 : 查询结果返回的 list 。从 PageInfo 中取出分页结果

 //用PageInfo对结果进行包装
 PageInfo<OrderListDto> page = new PageInfo<OrderListDto>(list);

好了，就是这么简单