mybatis插件开发-pageHelper原理

原创不易，转载请写明出处

1 目前项目分页的现状：

mapper接口定义如下：

List selectByExampleWithPaging(@Param("example")  Example example, @Param("offset") Integer offset, @Param("limit") Integer limit);

mapper.xml文件内容如下：

select

distinct

from `rider_woeq_adjustment`

order by ${orderByClause}

LIMIT #{offset}, #{limit}

如果有多个查询接口，就需要重复上面的代码，下面介绍一个优雅的分页方式

2 pageHelper 优雅分页

2.1Mybatis-PageHelper项目

2.2 使用方法 

2.2.1 maven导入

    com.github.pagehelper

              pagehelper

              ${last-version}  

目前最新的版本为 5.1.8

2.2.2.配置

   1. 在 MyBatis 配置 xml 中配置拦截器插件          

xml 配置拦截器

   2 在 Spring 配置文件中配置拦截器插件

spring 配置拦截器

2.2.3 使用方法：

PageHelper.offsetPage(PAGE_NUM, PAGE_SIZE);

List riderWoeqAdjustments =riderWoeqAdjustmentMapperExt.selectByExample(buildExample(currentDate));

如上所示，在查询语句前紧跟着一行 PageHelper.offsetPage(PAGE_NUM,  PAGE_SIZE);

之后查看打印出来的语句为：

 select id, rider_id, source_type, source_id, event_id, current_num, total_num, begin_tm, end_tm, active_flag, ins_tm, upd_tm from `rider_woeq_adjustment` WHERE ( active_flag = ? and end_tm < ? ) LIMIT ?, ?

后面已经自动添加分页的参数了，这样在项目中，配置一下，在所有需要分页的地方，这么一行代码就可以了PageHelper.offsetPage(PAGE_NUM, PAGE_SIZE);

2.3 pageHelper分页原理

    PageHelper.offsetPage(PAGE_NUM, PAGE_SIZE)实际做的事情是在 ThreadLocal中设置了分页参数，之后在查询执行的时候，获取当线程中的分页参数，执行查询的时候通过拦截器在sql语句中添加分页参数，之后实现分页查询，查询结束后在 finally 语句中清除ThreadLocal中的查询参数

最核心的逻辑在 PageInterceptor 中，PageInterceptor 是一个拦截器。

在 Mybatis中有四个地方提供了拦截的机会 

1 Executor

2 ParameterHandler

3 ResultSetHandler

4 StatementHandler

分页插件拦截的是 Executor ，也就是在sql执行的时候

总感觉图形是最好的文字，所以我就用图形描述整个原理过程

2.3.1  mybatis 插件加载及mapper初始化流程

 mybatis插件加载及mapper初始化 时序图 

初始化的的核心流程就是 读取配置文件 到 Congiguration实例，之后生成全局公用的 SqlSessionTemplate 以SqlSessionFactory实例

2.3.2 mabaits 查询流程

mybatis查询流程时序图

核心是 configuration.newExecutor()方法，会加载拦截链，也就是pageInterceptor

2.3.3 拦截器初始化流程

 拦截器初始化流程

2.3.4 设置分页参数源码

/**

* 开始分页

* @param offset 起始位置，偏移位置

* @param limit 每页显示数量

* @param count 是否进行count查询

*/

public static PageoffsetPage(int offset, int limit, boolean count) {

Page page =new Page(new int[]{offset, limit}, count);

//当已经执行过orderBy的时候

Page oldPage =getLocalPage();

if (oldPage !=null && oldPage.isOrderByOnly()) {

page.setOrderBy(oldPage.getOrderBy());

}

setLocalPage(page);

return page;

}

这段代码就是在当前线程的 ThreadLocal中添加分页参数

2.3.5 拦截器拦截流程图

拦截器拦截 流程图

3 注意事项

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

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

下面这样的代码，就是不安全的用法：

PageHelper.startPage(1,10);

Listlist;if(param1!=null){   

    list=countryMapper.selectIf(param1);

}else{ 

  // 如果程序走到这个逻辑分支，程序中当前的分页参数无法清除 

  list=newArrayList();

}

应该写成下面这个样子：

List list;

if(param1!=null){

PageHelper.startPage(1,10);   

list=countryMapper.selectIf(param1);

}else{    list=newArrayList();}