Mybatis(十) - 插件
本章我们介绍的是 MyBatis 的插件体系,说是插件,其实用拦截器更为合理,MyBatis 的源码中也称其为拦截器。那我们就从最基础的说起,先了解一下 MyBatis 设计的这个插件是什么。
1. 插件概述
官方文档中并没有说明 MyBatis 插件的具体定义,不过借助拦截器的思路,我们还是很容易理解的:MyBatis 的插件就是一些能拦截某些 MyBatis 核心组件方法,增强功能的拦截器。MyBatis 允许我们在 SQL 语句执行过程中的某些点进行拦截增强,官方文档中列出了四种可供增强的切入点:
Executor( update, query, flushStatements, commit, rollback, getTransaction, close, isClosed )ParameterHandler( getParameterObject, setParameters )ResultSetHandler( handleResultSets, handleOutputParameters )StatementHandler( prepare, parameterize, batch, update, query )
这些东西看上去不是很眼熟,没有关系,我们可以先来简单的解释一下它们的作用,以及拦截它们的目的。
Executor: 我们上一章也提过了,它是执行 statement 的核心组件,它负责整体的执行把控拦截
Executor,则意味着要干扰 / 增强底层执行的 CRUD 等动作
ParameterHandler: 处理 SQL 注入参数的处理器拦截
ParameterHandler,则意味着要干扰 / 增强 SQL 参数注入 / 读取的动作
ResultSetHandler:处理原生 jdbc 的ResultSet的处理器拦截
ResultSetHandler,则意味着要干扰 / 增强封装结果集的动作
StatementHandler:处理原生 jdbc 的 Statement的处理器拦截
StatementHandler,则意味着要干扰 / 增强Statement的创建和执行的动作
下面的几个 Handler 相对来讲都不是那么难理解吧,它们都可以理解为是原生 jdbc 的一层包装,MyBatis 的底层执行流程中不需要单独对原生 jdbc 的 API 进行操纵,只需要运用这几个 Handler 就可以。**Executor** 是重中之重,我们生命周期部分的第一个环节就要讲它,各位稍安勿躁。
下面我们先来编写一个简单的插件,初步体会一下 MyBatis 中的插件。
2. 插件快速体验
我们再创建一个新的工程 mybatis-07-extra 吧,准备工作跟前面准备缓存、事务的步骤一样,小册不再赘述。我们直接开始编码。
2.1 编写插件
我们直接创建一个 plugin 包,并新建一个 CustomInterceptor ,让它实现 org.apache.ibatis.plugin.Interceptor 接口:
之后,还需要在类上标注一个 @Intercepts 注解,用于声明要拦截哪个组件的哪个方法(或者哪些组件的哪些方法):
按照上面的写法,就意味着,我们这个 **CustomInterceptor** 要在 **Executor** 的 **update** 方法执行之前拦截。
拦截之后具体都干什么呢?我们要在 intercept 方法中编写,既然是简单体验,那我们就只是打印一行日志吧:
编写好拦截器后,不要忘记将这个拦截器配置到 MyBatis 全局配置文件中:
OK ,这样就一切就绪了。
2.2 测试运行
既然是拦截 update 方法,那我们就需要执行一个写操作,这样吧,我们直接把 MyBatisApplication6 中的测试逻辑抄过来,直接在这个基础上修改:
最后的 departmentMapper.update 动作,就会触发 Executor 的 update 方法,也就可以触发拦截器的逻辑了。
运行 main 方法,控制台中可以成功打印拦截器执行的逻辑:
2.3 拦截query方法
上面我们介绍了拦截 update 方法,其他的套路也是一样的,我们再演示一个 query 方法的拦截方式:
随后直接重新运行 InterceptorApplication 的 main 方法,控制台就可以打印出查询的相关信息了:
OK ,了解了基本的使用方法之后,下面我们来实战编写一个简单的插件:性能分析插件。
3. 实战:性能分析插件
先说一下需求吧,我们在执行 SQL 时难免会碰到慢 SQL ,这种情况下如果有一个比较好的机制,能帮我们把执行较慢的 SQL 都筛出来,那自然是极好的。所以我们来试着做一下这个性能分析的插件。
3.1 拦截哪些方法呢
首先我们考虑一下,哪些方法需要被拦截呢?只有查询吗?
貌似部分增删改也要添加吧,不然遇到这种 SQL 咋办:
假设后面的 values 非常长,好几万条,那这条 SQL 的执行效率肯定也是不高的,所以增删改查都需要拦截。
所以我们可以先把拦截器创建出来,并打上注解:
简单说一下为什么选择拦截 StatementHandler 的 update 和 query 方法,检查 SQL 的性能好不好,最好是不要带入 MyBatis 框架本身的执行逻辑耗时,而且 StatementHandler 的 update 和 query 方法,在底层都有一个 Statement 对象的 **execute** 方法执行,而这个 execute 就是执行 SQL 的动作,所以拦截 StatementHandler 之后监控的执行时间更具有参考意义。
3.2 怎么计算耗时呢
最简单的办法当然是取两次时间戳,然后比较一下看差值,当差值超过阈值后,打印警告日志:
但是怎么打印呢?这个难度有点大,因为通过 Invocation 取到的 Statement 是一个被 MyBatis 代理过的对象:

我们需要取它内部的 target ,也就是那个 "h" ,所以这里面实现起来有一点点的别扭:
简单解释一下为什么要这么写,要取代理对象内部的 target ,最简单的办法是使用反射获取,获取到的 target 是一个 PreparedStatementLogger ,它本来是一个装饰者,我们要获取到内部的 delegate ,也就是真正的 PreparedStatement ,这个 Statement 中就有要执行的 SQL ,直接 toString 一下就可以看到了。
这里可能有小伙伴进一步提出疑惑,既然上面 Debug 的时候都看到了,PreparedStatement 中有个 originalSql 属性存放着 SQL ,为什么不把它拿出来呢?是这样的,上面我们看到的 JDBC42PreparedStatement 是 MySQL 驱动包下的,如果回头我们换成 Oracle 或者 PostgreSQL 等其他数据库,那对应的驱动中 SQL 的属性叫什么,我们也不敢确定,总不能因为获取一个 SQL 而考虑适配所有数据库吧,这貌似划不来,所以我们直接 toString 一下就可以了。
OK ,编写完毕之后,不要忘记把插件注册到 MyBatis 全局配置文件中:
一切准备就绪,下面我们准备测试。
3.3 测试效果
我们可以直接重新运行上面的 InterceptorApplication ,里面有一个 findById 的方法,就可以触发这个拦截器的逻辑了。
OK ,我们直接运行 main 方法,观察控制台的打印:
可见拦截器确实运行了,但这条 SQL 的执行效率远没有那么慢,所以下面的慢 SQL 打印逻辑也就没出来。我们可以改一下慢 SQL 的时间阈值为 10ms ,这样几乎所有的 SQL 都会打印了:
重新运行 main 方法,控制台这次可以打印出 SQL 了:
到这里我们的性能分析插件其实就算编写完了,但这里面有几个细节可以优化一下。
3.4 优化细节
3.4.1 打印的内容
首先我们观察一下打印的内容:
很明显我们只想要最后面的 SQL 吧,前面那一堆东西我们根本不需要,所以我们可以就 PreparedStatement 转成 String 后再处理一下,处理的思路就是把前面的这些鬼东西去掉。
注意这里不能直接莽撞着去截字符串,因为不同的 jdbc 数据库驱动,toString 后的内容是不一样的,比方说 PostgreSQL 中的 PreparedStatement 打印之后的内容是没有那些乱七八糟的,直接就是 SQL :
所以我们要换一种思路:要么,直接把 SQL 截出来吧,管他前面有啥呢,我都不管。
OK ,有了上面的分析,下面我们可以试着截一下 SQL ,那截取 SQL 的思路有很多了,可以用 indexOf 的方式,也可以用正则表达式直接提取,这里小册演示一下用正则表达式取 SQL :
之后改一下打印的内容,调用一下 getSql 方法即可:
OK ,下面我们再运行一下 main 方法,观察控制台的打印:
可以发现这次打印的 SQL 是干干净净的了,非常符合我们预期!
3.4.2 硬编码参数
再回过头来看一下我们设定的慢 SQL 时间阈值:
这个 10 很明显被写死了,我们可以充分利用 MyBatis 给我们提供的外部化配置的特性,将这个 10 写到 MyBatis 全局配置文件中:
之后我们回到拦截器中,相应的定义一个同名的成员属性:
有了这个属性之后,MyBatis 并不会那么智能的帮我们赋属性值,而是在 Interceptor 接口中预留了一个 default 的 setProperties 方法供我们手动赋属性值,所以我们可以重写这个方法,自己赋值:
这样就不会写死了,最后改一下 intercept 中写死的值,换为这个变量:
OK ,改好之后我们重新运行 main 方法,可以发现一切正常,所以通过这种外部化配置方式,就解决了参数硬编码的问题。
到此为止,我们就自己实现了一个性能分析插件。
4. 插件生效机制
首先我们先来看看插件是如何加载到 MyBatis 全局的。
4.1 插件的加载
在 MyBatis 全局配置文件的加载中,我们看到了 <plugins> 标签的处理位置是在这里:
本身这个逻辑不复杂,不过当时我们看源码的时候没有进入最后一句,这个 configuration.addInterceptor(interceptorInstance); 可有点讲究。我们进入 addInterceptor 方法:
注意看,它将创建好的插件放入了一个 InterceptorChain 中!很明显这是一个拦截器链,它是怎么设计的呢?
4.2 InterceptorChain的设计
这个 InterceptorChain 的设计本身并不很复杂,它的内部就是组合了一个 Interceptor 的集合,配合几个方法而已:
其中这个 pluginAll 方法的使用,我们之前见过几次,可能小伙伴们没有留意,我们可以回顾一下。
MyBatis 的插件可以对四种组件进行增强:
Executor( update, query, flushStatements, commit, rollback, getTransaction, close, isClosed )ParameterHandler( getParameterObject, setParameters )ResultSetHandler( handleResultSets, handleOutputParameters )StatementHandler( prepare, parameterize, batch, update, query )
所以在创建这四种组件的时候,肯定不是普通的 new 出来,而是 Configuration 统一创建:(以其中两个为例)
可以看到,全局 Configuration 对象创建这些核心组件的时候,都是先创建出原始的目标对象,然后用哪个 InterceptorChain 去包装(代理),从而得到代理对象。所以 InterceptorChain 的 pluginAll 方法是我们要着重去看的。
4.3 pluginAll
这个 pluginAll 方法本身并不难,本身是调用每一个插件的 plugin 方法:
而每个 Interceptor 的 plugin 方法,都是会来到 Plugin.wrap 方法,这个逻辑有一点点小复杂,我们对其中比较关键的两步拆解开。
4.3.1 获取所有要增强的方法
代理之前,肯定要先看看这个插件(拦截器)能增强哪些方法,所以这里他会收集 Interceptor 上的 @Intercepts 注解,并得到其中的 Signature 注解数组,逐个解析其中的方法。源码本身并不复杂,各位对照着注释看一下就可以。
先回顾下上面的例子:
4.3.2 创建Plugin对象
最后,它会在 Proxy.newProxyInstance 时创建代理对象,请注意,这里传入了一个 Plugin 对象,也就是当前我们正在看的这个类,对,它本身实现了 InvocationHandler :
留意一下这个 Plugin 中组合的属性,它里面把接下来插件运行期需要使用的信息都包含了,所以后面在调用代理对象的方法时,这里就可以予以执行了。
OK ,正好我们把整个插件生效的流程都看完了,下面我们就来看 MyBatis 在实际运行期间,插件是如何运行的。
5. 插件运行机制
承接上一小节,Plugin 本身是一个 InvocationHandler ,所以每次代理对象执行的时候,首先会触发它的 invoke 方法:
看到中间的 interceptor.intercept(new Invocation(target, method, args)); 是不是非常有感觉了!对了,它就是我们写的那些 Interceptor 要实现的核心 intercept 方法啊,传入的参数就是我们在重写 intercept 方法中拿到的那个 Invocation 对象。所以 MyBatis 的插件运行并没有什么特殊的,就是这么简单。
另外我们可以看看 Invocation 的结构,它本身也很简单,并且它的 proceed 方法就是继续放行原方法的执行:
到此为止,MyBatis 的插件机制原理,我们也就全部了解完毕了。
最后更新于
这有帮助吗?