MyBatis中使插件在PageHelper前运行

概要

前情提要：

我们有两个项目A与B，两个项目单独开发，但实际上A是B中的一个功能，两者使用了相同的数据库结构。

需求：

我们需要将B和A项目进行对接，使用B项目替换A项目中的相同功能。

问题：

B的所有表名与A的表名存在映射关系，且各不相同，例如在A中的user表对应了B中的student表。

方案：

在B中通过MyBatis插件的方式，将SQL中需要映射的表名改为A项目库的表名。

问题

本来方案构想是挺好的，但是因为在B项目中使用了PageHelper插件，我们自定义的SQL处理插件运行于PageHelper之后，而在PageInterceptor.intercept方法中，并没有使用invocation.proceed()，这导致SQL执行的流程中，PageInterceptor执行后就不执行自定义插件的方法了。

解决

目前最简单的办法就是让自定义插件在PageHelper之前运行。

那么已知插件运行顺序是栈式的，后加载的插件先运行，所以我们就需要将自定义插件的加载顺序滞后。

所以我们就需要手动控制加载顺序了。

网上的解决方案

在网上翻了半天，都是些没法用的方法，而且十个有九个都是抄来抄去的，垃圾。

另外就是网上的很多文章都提到了PageHelperAutoConfiguration，但是B项目中并没有找到相关文件，这里应该是依赖或是版本不同导致的。

直到我翻到知乎的一个回答，里面贴了一个掘金的链接，里面的标题是：基于拦截器处理mybatis模糊查询中的‘%’、‘_’、‘\’特殊字符问题，我说咋搜不到呢。

最终的方案就是通过ApplicationListener的方式，将自定义拦截器置于插件队列尾部。完整代码如下：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18

@Component
public class CustomerInterceptorRegister implements ApplicationListener<ContextRefreshedEvent> {
    @Autowired
    private List<SqlSessionFactory> sqlSessionFactoryList;
    @Autowired
    private ReplaceTableInterceptor interceptor;

    @Override
    public void onApplicationEvent(ContextRefreshedEvent event) {
        for (SqlSessionFactory sqlSessionFactory : sqlSessionFactoryList) {
            org.apache.ibatis.session.Configuration configuration = sqlSessionFactory.getConfiguration();
            // 防止多次调用时的重复添加
            if (configuration.getInterceptors().stream().noneMatch(i -> i == interceptor)) {
                configuration.addInterceptor(interceptor);
            }
        }
    }
}

这里是通过ContextRefreshedEvent事件进行触发的，这样再项目初始化完成后再加载自定义插件时，PageHelper就已经被加载了。