Mybatis分页插件PageHelper的原理

一，概述

MyBatis的分页使用的关键字就是limit，插件分页的原理就是在sql语句中拼接limit关键字，进行数据的分页查询，所以pageHelper也不例外，底层处理的就是使用的代理对象拼接的Sql，实现的分页。其实思想都离不开原始的分页的sql语句，虽然这样的分页插件好用，但是建议初学者最好不要使用，如果要使用，也要吃透底层的原理才可以加深理解， 否则的话，可能只会使用不能明白其中的原理。

pageHelper使用的是ThreadLocal本地线程变量的特性来进行存储分页的的部分数据，使用到分页查询的参数组装，而且在使用一次后，就会被remove，但是这个是必须的，一个是防止分页数据被其他sql误用，一个是防止内存泄露。使用的是mybatis的实现Interceptor接口，使用jdk动态代理的模式，增强Executor对象，实现的代理对象，组装count和limit分页数据的查询的sql语句，返回一个page对象，page对象其实就是继承了list对象，所以返回的List对象是父类，适应多态。

二，原理分析设置分页数据PageHelper.startPage（重写startPage）

封装分页的pageNum pageSize以及orderFiled的一些数据

public static Page startPage(int pageNum, int pageSize, String orderBy) {Page page = startPage(pageNum, pageSize);page.setOrderBy(orderBy);return page;public static Page startPage(int pageNum, int pageSize, Boolean count, Boolean reasonable, Boolean pageSizeZero) {Page page = new Page(pageNum, pageSize, count);page.setReasonable(reasonable);page.setPageSizeZero(pageSizeZero);Page oldPage = getLocalPage();if (oldPage != null && oldPage.isOrderByOnly()) {page.setOrderBy(oldPage.getOrderBy());//设置分页的数据存放在ThreadLocal里面，setLocalPage(page);return page;

以上是可以看出，分页的数据是和ThreadLocal绑定的，也是将数据存放在ThreadLocal里面，提供给后续分页的时候使用

清除ThreadLocal分页数据

以上图你可以看出，清除数据的是在com.Github.pagehelper.PageInterceptor#intercept方法中的finally中执行的，概述也说过，其实执行的原理就是利用的mybatis的intercept的进行的对象的代理

Pageinterceptor代理的源头

@Intercepts注解就是标注需要拦截代理的对象，type就是对象为Executor，方法是query，参数为两个重载的方法，PageInterceptor实现Interceptor并实现intercept和plugin方法，进行数据代理的处理，setProperties方法其实是可以设置配置参数来处理，实现接口原因是因为mybatis使用的jdk动态代理，必须是实现接口的才可以创建代理对象，下面就intercept方法进行分析分页的处理逻辑

intercept方法

this.count进行查询统计总数

就是使用原sql语句进行count查询总数

com.github.pagehelper.util.ExecutorUtil#pageQuery

dialect.getPageSql就是拼接sql语句中的limit

看到这里，可能就可以明白了，这个分页到底是怎么做的 了，其实就是sql拼接了limit，总上图就可以看出，规归根结底就是代理了Excutor对象，然后执行count和拼接limit的sql语句，实现的插件的分页

小结

以上可以看出来，其实就是一个Excutor代理对象的一系列处理，简单而言，pageHelper的分页逻辑处理，可以就这么理解,其实就是生成代理对象并代理增强，从ThreadLocal中获取到分页的参数，拼接sql和查询总数的sql并返回一个page对象

三，Excutor逻辑补充

首先写分页插件的话，需要知道mybatis的原理，执行Sql的是四大对象：Executor，StatementHandler，ParameterHandler，ResultSetHandler。

一般都会获取SqlSession，获取途径一般都是SqlSessionFactory .openSession

Executor的创建

增强对象

从上面可以看出，其实Executor创建的过程就是执行了拦截器inteceptor中的拦截器链