基于Mybatis分页插件PageHelper

1.分页插件使用

1、POM依赖

PageHelper的依赖如下。需要新的版本可以去maven上自行选择

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

2、Mybatis对PageHelper的配置

打开Mybatis配置文件，一般在Resource路径下mybatis-config.xml。

<configuration>
   <settings>
        
          <setting name="mapUnderscoreToCamelCase" value="true" />
     </settings>
     <objectWrapperFactory type="com.maomao.xwz.mybatis.handle.MapWrapperFactory"/>
    <plugins>
        
        <plugin interceptor="com.github.pagehelper.PageHelper">
            
            <property name="dialect" value="mysql"/>
            
            
            
            <property name="offsetAsPageNum" value="true"/>
            
            
            <property name="rowBoundsWithCount" value="true"/>
            
            
            <property name="pageSizeZero" value="true"/>
            
            
            
            <property name="reasonable" value="false"/>
            
            
            
            
            <property name="params" value="pageNum=start;pageSize=limit;"/>
            
            <property name="supportMethodsArguments" value="true"/>
            
            <property name="returnPageInfo" value="check"/>
        </plugin>
    </plugins>
</configuration>

3、PageHelper分页使用

1）只统计查询总数量count

public PageInfo selectByExample() {
    PageHelper.startPage(1, -1);
    List list = this.baseMapper.selectByExample(new BsFeedbackExample());
    PageInfo pageInfo = new PageInfo(list);
    log.info(JSONObject.toJSONString(pageInfo));
    return pageInfo;
}

执行sql日志：

2）正常分页

public PageInfo selectByExample1() {
    PageHelper.startPage(1, 1);
    List list = this.baseMapper.selectByExample(new BsFeedbackExample());
    PageInfo pageInfo = new PageInfo(list);
    log.info(JSONObject.toJSONString(pageInfo));
    return pageInfo;
}

执行sql日志：

3）分页统计总数

public PageInfo selectByExample2() {
    PageHelper.startPage(1, 1, true);
    List list = this.baseMapper.selectByExample(new BsFeedbackExample());
    PageInfo pageInfo = new PageInfo(list);
    log.info(JSONObject.toJSONString(pageInfo));
    return pageInfo;
}

执行sql日志：

4) 分页不统计总数

public PageInfo selectByExample3() {
    PageHelper.startPage(1, 1, false);
    List list = this.baseMapper.selectByExample(new BsFeedbackExample());
    PageInfo pageInfo = new PageInfo(list);
    log.info(JSONObject.toJSONString(pageInfo));
    return pageInfo;
}

执行sql日志：

5) 查询全部数据

public PageInfo selectByExample3() {
    PageHelper.startPage(1, 0);
    List list = this.baseMapper.selectByExample(new BsFeedbackExample());
    PageInfo pageInfo = new PageInfo(list);
    log.info(JSONObject.toJSONString(pageInfo));
    return pageInfo;
}

执行sql日志：

6) 分页排序orderBy

public PageInfo selectByExample5() {
    String orderBy = "id desc";
    PageHelper.startPage(1, 2, orderBy);
    List list = this.baseMapper.selectByExample(new BsFeedbackExample());
    PageInfo pageInfo = new PageInfo(list);
    log.info(JSONObject.toJSONString(pageInfo));
    return pageInfo;
}

执行sql日志：

7) 直接传入分页参数RowBounds

public PageInfo selectByExample6() {
    List list = this.baseMapper.selectByExample(new BsFeedbackExample(), new RowBounds(2, 1));
    PageInfo pageInfo = new PageInfo(list);
    log.info(JSONObject.toJSONString(pageInfo));
    return pageInfo;
}

执行sql日志：

4、PageHelper如何确保安全性

PageHelper 方法使用了静态的 ThreadLocal 参数，分页参数和线程是绑定的。

只要你可以保证在 PageHelper 方法调用后紧跟 MyBatis 查询方法，这就是安全的。因为 PageHelper 在 finally 代码段中自动清除了 ThreadLocal 存储的对象。

如果代码在进入 Executor 前发生异常，就会导致线程不可用，这属于人为的 Bug（例如接口方法和 XML 中的不匹配，导致找不到 MappedStatement 时），这种情况由于线程不可用，也不会导致 ThreadLocal 参数被错误的使用。

有一个安全性问题，需要注意一下，不然可能导致分页错乱。

不安全的用法：

PageHelper.startPage(1, 10);

List<Country> list;

if(param1 != null){

list = countryMapper.selectIf(param1);

} else {

list = new ArrayList<Country>();

}

这种情况下由于 param1 存在 null 的情况，就会导致 PageHelper 生产了一个分页参数，但是没有被消费，这个参数就会一直保留在这个线程上。当这个线程再次被使用时，就可能导致不该分页的方法去消费这个分页参数，这就产生了莫名其妙的分页。

安全的用法：

List<Country> list;

if(param1 != null){

PageHelper.startPage(1, 10);

list = countryMapper.selectIf(param1);

} else {

list = new ArrayList<Country>();

}

2. PageHelper源码分析

1、线程安全

PageHelper 方法使用了静态的 ThreadLocal 参数，分页参数和线程是绑定的。PageHelper.startPage方法调用后，将分页参数设置在ThreadLocal中。

/**
* 基础分页方法
*
* @author liuzh
*/
public abstract class PageMethod {
    protected static final ThreadLocal<Page> LOCAL_PAGE = new ThreadLocal<Page>();
    protected static boolean DEFAULT_COUNT = true;
    /**
     * 开始分页
     *
     * @param pageNum      页码
     * @param pageSize     每页显示数量
     * @param count        是否进行count查询
     * @param reasonable   分页合理化,null时用默认配置
     * @param pageSizeZero true且pageSize=0时返回全部结果，false时分页,null时用默认配置
     */
    public static <E> Page<E> startPage(int pageNum, int pageSize, boolean count, Boolean reasonable, Boolean pageSizeZero) {
        Page<E> page = new Page<E>(pageNum, pageSize, count);
        page.setReasonable(reasonable);
        page.setPageSizeZero(pageSizeZero);
        //当已经执行过orderBy的时候
        Page<E> oldPage = getLocalPage();
        if (oldPage != null && oldPage.isOrderByOnly()) {
            page.setOrderBy(oldPage.getOrderBy());
        }
        setLocalPage(page);
        return page;
    }

/**
     * 开始分页
     *
     * @param offset 页码
     * @param limit 每页显示数量
     */
    public static <E> Page<E> offsetPage(int offset, int limit) {
        return offsetPage(offset, limit, DEFAULT_COUNT);
    }

/**
     * 开始分页
     *
     * @param offset 页码
     * @param limit 每页显示数量
     * @param count 是否进行count查询
     */
    public static <E> Page<E> offsetPage(int offset, int limit, boolean count) {
        Page<E> page = new Page<E>(new int[]{offset, limit}, count);
        //当已经执行过orderBy的时候
        Page<E> oldPage = getLocalPage();
        if (oldPage != null && oldPage.isOrderByOnly()) {
            page.setOrderBy(oldPage.getOrderBy());
        }
        setLocalPage(page);
        return page;
    }

/**
     * 排序
     *
     * @param orderBy
     */
    public static void orderBy(String orderBy) {
        Page<?> page = getLocalPage();
        if (page != null) {
            page.setOrderBy(orderBy);
        } else {
            page = new Page();
            page.setOrderBy(orderBy);
            page.setOrderByOnly(true);
            setLocalPage(page);
        }
    }

2、Mybatis分页拦截

定义了Mybatis拦截器，在Mybatis执行sql前，进行拦截，针对sql进行分页处理；
/**
* Mybatis - 通用分页拦截器<br/>
* 项目地址 : http://git.oschina.net/free/Mybatis_PageHelper
*
* @author liuzh/abel533/isea533
* @version 5.0.0
*/
        @SuppressWarnings({"rawtypes", "unchecked"})
        @Intercepts(
                {
                        @Signature(type = Executor.class, method = "query", args = {MappedStatement.class, Object.class, RowBounds.class, ResultHandler.class}),
                        @Signature(type = Executor.class, method = "query", args = {MappedStatement.class, Object.class, RowBounds.class, ResultHandler.class, CacheKey.class, BoundSql.class}),
                }
        )
        public class PageInterceptor implements Interceptor {
            //缓存count查询的ms
            protected Cache<String, MappedStatement> msCountMap = null;
            private Dialect dialect;
            private String default_dialect_class = "com.github.pagehelper.PageHelper";
            private Field additionalParametersField;
            private String countSuffix = "_COUNT";
            @Override
            public Object intercept(Invocation invocation) throws Throwable {

3、分页参数内置查询sql

MySqlDialect中加载AbstractHelperDialect实现，从线程中取出分页参数，生成分页sql;

经常提到的count查询，其实是PageHelper帮助我们生成的一个MappedStatement内存对象，它可以免去我们在XXXMapper.xml内单独声明一个sql count查询，我们只需要写一个sql分页业务查询即可。
/**
* 针对 PageHelper 的实现
*
* @author liuzh
* @since 2016-12-04 14:32
*/
public abstract class AbstractHelperDialect extends AbstractDialect implements Constant {

/**
     * 获取分页参数
     *
     * @param <T>
     * @return
     */
    public <T> Page<T> getLocalPage() {
        return PageHelper.getLocalPage();
    }

3.PageHelper使用建议

1、明确指定dialect（mysql）。

2、当业务sql存在内部嵌套时，明确编写sql分页业务和与它对应的count查询，别图省事。

MyBatis工具 http://www.mybatis.tk

推荐使用 Mybatis 通用 Mapper3 https://github.com/abel533/Mapper

推荐使用 Mybatis 分页插件 PageHelper https://github.com/pagehelper/Mybatis-PageHelper