Mybatis分页插件PageHelper的使用

文章目录：

最近写项目，自己手动写SQL已经很麻烦了，分页的时候还需要自己手动分页的话，就更复杂了，这里使用PageHelper这个插件来简化分页操作。
使用这个插件，在SQL中不用写分页信息，通过MyBatis拦截器来添加分页信息，再执行分页SQL。

---

Maven依赖包

在pom.xml文件中添加依赖：

<dependency>
    <groupId>com.github.pagehelper</groupId>
    <artifactId>pagehelper</artifactId>
    <version>${pagehelper.version}</version>
</dependency>

---

PageHelper插件使用

先使用PageHelper.startPage(pageNum,pageSize,countBoolean)来设置分页信息。pageNum是当前页码，pageSize是页面尺寸，countBoolean是是否统计总数。
再执行查询语句。
最后将查询结果封装到new PageInfo<>(list)里面。上面设置了countBoolean参数为true时，可以在对象PageInfo中获取到总条数total等信息。

看这个简单的例子：

public PageInfo<TmAd> selectAdOrderByCreateTime(int pageNum, int pageSize) {
        //分页计数
        PageHelper.startPage(pageNum,pageSize,true);
        //查询
        TmAdExample tmAdExample = new TmAdExample();
        tmAdExample.setOrderByClause("create_time desc");
        List<TmAd> list = tmAdMapper.selectByExample(tmAdExample);
        //封装、返回
        return new PageInfo<>(list);
    }

---

插件配置

需要在mybatis-config.xml中配置PageHelper插件：

    <?xml version="1.0" encoding="UTF-8" ?>  
    <!DOCTYPE configuration  
    PUBLIC "-//mybatis.org//DTD Config 3.0//EN"  
    "http://mybatis.org/dtd/mybatis-3-config.dtd">  
    <!-- 配置管理器 -->  
    <configuration>  
        <plugins>  
            <!-- com.github.pagehelper为PageHelper类所在包名 -->  
            <plugin interceptor="com.github.pagehelper.PageHelper">  
                <!-- 4.0.0以后版本可以不设置该参数 -->  
                <property name="dialect" value="oracle"/>  
                <!-- 该参数默认为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,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>  
    </configuration>  

再在spring.xml中配置sqlSessionFactory时引入mybatis-config.xml的配置。

---

小提示

1. PageHelper设置分页信息的时候，必须写在查询语句之前。

2. 若一个方法里面有两句查询语句的话，第一句已经写了PageHelper设置分页信息以后，第二句的分页信息需要重新写。如果第二句不需要分页，则使用PageHelper.clearPage()清除分页信息。

3. 暂时就这么多，想到再写。