PageHelper托管到IoC容器中后，执行sql前会先执行PageHelper的intercept方法。
PageHelper拦截到调用后，首先 判断是否运行时自动获取dialect（autoRuntimeDialect默认false，通过PageHelper.setProperties可配置），autoRuntimeDialect=true 或 autoRuntimeDialect=false且autoDialect=true时，会根据datasource创建对应的sqlUtil，否则使用dialect指定的sqlUtil；然后 调用sqlUtil的processPage方法处理分页。
这里sqlUtil的supportMethodsArguments（是否支持接口参数来传递分页参数，默认false），同样可以通过PageHelper的setProperties方法进行配置。这里源码注释标明：支持方法参数时，如果page == null就说明没有分页条件，不需要分页查询；当不支持分页参数时，判断LocalPage和RowBounds判断是否需要分页。因此，当不需要分页时，在401行处执行并直接返回调用结果，到此调用结束；当需要分页而分页参数page=null时，需要先从ThreadLocal中获取业务代码中此前设置的分页参数。
处理完分页后processPage方法会清空Threadlocal中的分页信息。
获取到分页信息后，将进一步调用sqlUtil的doProcessPage方法。在doProcessPage方法中，首先获 取原始的MappedStatement，然后判断原始MappedStatement的sqlSource是否继承自PageSqlSource，第一次执行该调用时发现MappedStatement的sqlSource并非继承PageSqlSource 会对sqlSource进行修改（1.将sqlSource包装为PageSqlSource 类型；2.创建一个count查询的ms）。MappedStatement的sqlSource处理为PageSqlSource 后，会将sqlSource的parser设置为当前的parser（由配置的方言类型决定，若未配置则取决于数据链接的类型）。在执行调用前 为避免进行Mybatis自带分页需要忽略RowBounds（args[2]=RowBounds.DEFAULT）；此外，还需要处理只做查询（分页参数orderByOnly=true或者pageSize=0）的情况，当只需要做查询操作时，执行正常不分页查询，得到处理结果后封装为分页对象后直接返回，到此调用结束。
若非只做查询，则需要根据分页参数的isCount来判断是否需要在执行列表查询前增加一次计数查询。若需要计数，则在执行列表查询前需要将MappedStatement先替换成此前为count自定义的ms并获取count结果。获取count结果后，将原ms替换回去并执行列表查询。最后封装为page对象并返回。
下面进一步探索pagehelper是如何构建count查询语句的。
将ms替换为自定义ms后执行调用，首先来到ibatis插件Invocation类的proceed方法；
第二步 调用ibatis中CachingExecutor的query方法；
第三步 调用ibatis中MappedStatement的getBoundSql方法；
第四步 调用pagehelper中PageSqlSource的getBoundSql方法；这里getCount会根据ThreadLocal中是否有分页信息的CountSignal判断当前是否为count查询。
接下来会进入pagehelper中PageDynamicSqlSource中的getCountBoundSql方法。可以看到，在78行处构建StaticSqlSource对象时，第二个参数（String sql）是通过本地parser获取count对应的sql。
进一步f7可以看到先来到了pagehelper的AbstractParser，然后调用pagehelper中SqlParser的getSmartCountSql方法获取count语句。在getSmartCountSql方法中，首先会检查原始sql中是否包含"for update"字样，如果包含则抛出异常提示用户分页插件不支持包含for update的sql。若sql通过检查，则先判断缓存（CACHE为SqlParser的私有成员变量，类型为ConcurrentHashMap）中是否有当前sql对应的count语句，如果有则直接返回，如果没有则开始构建count语句并缓存。
构建count语句，首先需要解析原始sql，如果原始sql无法解析，则使用一版方法获取普通的count-sql缓存后并返回。下图可以看到，使用普通方法获取count-sql，实际是将原始sql作为子查询 在外面直接套了一层count。
如果原始sql语句解析成功，则首先去除原始语句中的order by子句，然后通过setSelectItems方法将select子句的内容替换为count(0)，从而完成构建count语句。
至此，count语句执行结束。
下面开始分析pagehelper是如何实现分页列表数据查询sql构建的。
完成查询总数操作还原ms后，将准备开始查询分页列表数据。
首先，重置分页对象中的CountSignal为null；
然后，将参数中的MappedStatement替换为新的qs；
接着，将分页对象中的CountSignal设置为false，准备进行分页查询；
获得分页列表查询语句后，将交由ibatis插件执行sql，获得查询结果后由pagehelper的sqlUtil封装为分页对象返回。
至此，分页操作完成，最终得到封装了total和list等信息的分页对象。
简单总结pagehelper实现分页的原理与流程如下：
1.实现ibatis拦截器接口Interceptor；
2.实现ibatis的SqlSource接口，构建PageSqlSource抽象类；
3.在Page对象中存储CountSignal标记属性，实现获取原始sql语句、count语句、分页语句的分支逻辑；
4.实现抽象类PageSqlSource，构建满足不同需求的PageXxxSqlSource；
5.构建不同数据库的方言解释器，获取实际执行的count和list语句；
6.通过替换MappedStatement对象的方法，实现执行计数count语句。
网友评论