源码解析PageHelper如何进行自动分页

以前刚看到PageHelper的时候，觉得有点意思，它没有通过sql的硬编码来实现分页，而是通过拦截器配置的方式拦截sql，实现sql的自动分页。

本篇将会通过使用PageHelper做一次sql查询测试，来解析PageHelper底层是如何实现自动分页的。

我们先看下mybatis-config.xml 的配置如下：

 <plugins>
        <plugin interceptor="com.github.pagehelper.PageInterceptor"/>
</plugins>

PageHelper底层是使用的mybatis的拦截器，不熟悉的同学，可以看看先这个源码解析mybatis拦截器的运行原理。

测试代码如下：

public class TestPageHelper {
    public static void main(String[] args) throws Exception {
        Map<String, Object> map=new HashMap<>();
        Page page= PageHelper.startPage(1, 5);
        DBoperate.testPageHelper(map);
        System.out.println(page);
    }
}

public static List<Map<String, Object>> testPageHelper(Map<String, Object> map) throws Exception {
        SqlSession session = null;
        List<Map<String, Object>> listMap =null;
        try {
            session = SessionFactory.getSession();
            DataDao dataDao = session.getMapper(DataDao.class);
            listMap=dataDao.testPageHelper(map);
        } catch (Exception e) {
            logger.error("查询异常:", e);
            session.rollback(true);
            throw e;
        } finally {
            session.close();
        }
        return listMap;
    }

dao.DataDao#testPageHelper 方法就是执行了一次查询而已。

现在我们直接看PageHelper.startPage 方法：

这里的 DEFAULT_COUNT 为true。

上图重点看64行的Page构造方法和72行的 setLocalPage 方法，我们先看下64行的Page的构造方法：

这里需要重点看50行的 calculateStartAndEndRow 方法：

这里就是通过页数和每页的大小计算数据的开始行 startRow 和结束行 endRow。

我们继续看setLocalPage方法：

这里其实就是将Page对象放到了 PageHelper 的父类 PageMethod的 ThreadLocal 中，其实就相当于将Page对象放到了当前的Thread中。

到这里 PageHelper.startPage 就已经执行完成。我们继续往下看 DBoperate.testPageHelper 方法中的 dataDao.testPageHelper 方法。在执行查询之前，会先去调用com.github.pagehelper.PageInterceptor 这个拦截器（不熟悉拦截器原理的同学，可以看看先这个源码解析mybatis拦截器的运行原理），我们直接看com.github.pagehelper.PageInterceptor#intercept方法：

先看 checkDialectExists 方法，这里首先会将 dialect 方言初始化为 com.github.pagehelper.PageHelper 类。

继续往下看：

红框中代码首先会计算本次查询的总数据量count，然后继续执行com.github.pagehelper.dialect.AbstractHelperDialect#afterCount方法：

可以看到会将总数据量count放进total中。

下面我们继续看  ExecutorUtil.pageQuery 方法：