深入理解 Mybatis 插件开发

素颜马尾好姑娘i 2021-08-29 00:34 447阅读 0赞

点击上方 [Java后端][Java]，选择 设为星标

优质文章，及时送达

--------------------

关于Mybatis插件，大部分人都知道，也都使用过，但很多时候，我们仅仅是停留在表面上，知道Mybatis插件可以在DAO层进行拦截，如打印执行的SQL语句日志，做一些权限控制，分页等功能；但对其内部实现机制，涉及的软件设计模式，编程思想往往没有深入的理解。

本篇案例将帮助读者对Mybatis插件的使用场景，实现机制，以及其中涉及的编程思想进行一个小结，希望对以后的编程开发工作有所帮助。

注：本案例以mybatis 3.4.7-SNAPSHOT版本为例。

PS：文章是挺久之前写的，当时花了一些心思，存到电脑的word里，今天正好看到，就是里面的源码都是图片，哈哈哈，凑合着看吧。

对了，更多实战教程可以关注微信公众号 Java后端 ，回复 666 下载。

**分页功能**

mybatis的分页默认是基于内存分页的（查出所有，再截取），数据量大的情况下效率较低，不过使用mybatis插件可以改变该行为，只需要拦截StatementHandler类的prepare方法，改变要执行的SQL语句为分页语句即可；

## **公共字段统一赋值** ##

一般业务系统都会有创建者，创建时间，修改者，修改时间四个字段，对于这四个字段的赋值，实际上可以在DAO层统一拦截处理，可以用mybatis插件拦截Executor类的update方法，对相关参数进行统一赋值即可；

## **性能监控** ##

对于SQL语句执行的性能监控，可以通过拦截Executor类的update, query等方法，用日志记录每个方法执行的时间；

## **其它** ##

其实mybatis扩展性还是很强的，基于插件机制，基本上可以控制SQL执行的各个阶段，如执行阶段，参数处理阶段，语法构建阶段，结果集处理阶段，具体可以根据项目业务来实现对应业务逻辑。

## **什么是Mybatis插件** ##

与其称为Mybatis插件，不如叫Mybatis拦截器，更加符合其功能定位，实际上它就是一个拦截器，应用代理模式，在方法级别上进行拦截。

## **支持拦截的方法** ##

*  执行器Executor（update、query、commit、rollback等方法）；
 *  参数处理器ParameterHandler（getParameterObject、setParameters方法）；
 *  结果集处理器ResultSetHandler（handleResultSets、handleOutputParameters等方法）；
 *  SQL语法构建器StatementHandler（prepare、parameterize、batch、update、query等方法）；

## **拦截阶段** ##

那么这些类上的方法都是在什么阶段被拦截的呢？为理解这个问题，我们先看段简单的代码（摘自mybatis源码中的单元测试SqlSessionTest类），来了解下典型的mybatis执行流程，如下代码所示：

![format_png][]

以上代码主要完成以下功能：

*  读取mybatis的xml配置文件信息
 *  通过SqlSessionFactoryBuilder创建SqlSessionFactory对象
 *  通过SqlSessionFactory获取SqlSession对象
 *  执行SqlSession对象的selectList方法，查询结果
 *  关闭SqlSession

如下是时序图，在整个时序图中，涉及到mybatis插件部分已标红，基本上就是体现在上文中提到的四个类上，对这些类上的方法进行拦截。

![format_png 1][]

## **插件配置信息的加载** ##

先来看下mybatis是如何加载插件配置的，对应的xml配置信息如下：

![format_png 2][]对应的解析代码如下，主要做以下工作：

1.  根据解析到的类信息创建Interceptor对象；
2.  调用setProperties方法设置属性变量；
3.  添加到Configuration的interceptorChain拦截器链中；

![format_png 3][]以上逻辑对应的时序图如下：

![format_png 4][]

## **代理对象的生成** ##

Mybatis插件的实现机制主要是基于动态代理实现的，其中最为关键的就是代理对象的生成，所以有必要来了解下这些代理对象是如何生成的。

Executor代理对象

![format_png 5][]

ParameterHandler代理对象

![format_png 6][]

ResultSetHandler代理对象

![format_png 7][]

StatementHandler代理对象

![format_png 8][]

观察源码，发现这些可拦截的类对应的对象生成都是通过InterceptorChain的pluginAll方法来创建的，进一步观察pluginAll方法，如下：

![format_png 9][]

遍历所有拦截器，调用拦截器的plugin方法生成代理对象，注意生成代理对象重新赋值给target，所以如果有多个拦截器的话，生成的代理对象会被另一个代理对象代理，从而形成一个代理链条，执行的时候，依次执行所有拦截器的拦截逻辑代码；

接下来看一下我们在编写拦截器的时候，一个典型的plugin方法实现方式，如下：

![format_png 10][]

再进一步查看wrap方法，如下：

典型的动态代理实现，调用的是Proxy.newProxyInstance方法来生成代理对象。

![format_png 11][]

以上逻辑对应的时序图如下，这里我们假设声明了两个拦截器，那么在创建target代理对象的时候，最终返回的代理对象proxy2，实际上代理了proxy1，而proxy1又代理了target，：

![format_png 12][]

## ** 拦截逻辑的执行** ##

由于真正去执行Executor、ParameterHandler、ResultSetHandler和StatementHandler类中的方法的对象是代理对象（建议将代理对象转为class文件，反编译查看其结构，帮助理解），所以在执行方法时，首先调用的是Plugin类（实现了InvocationHandler接口）的invoke方法，如下：

首先根据执行方法所属类获取拦截器中声明需要拦截的方法集合；

判断当前方法需不需要执行拦截逻辑，需要的话，执行拦截逻辑方法（即Interceptor接口的intercept方法实现），不需要则直接执行原方法。

![format_png 13][]

可以关注下Interceptor接口的intercept方法实现，一般需要用户自定义实现逻辑，其中有一个重要参数，即Invocation类，通过改参数我们可以获取执行对象，执行方法，以及执行方法上的参数，从而进行各种业务逻辑实现，一般在该方法的最后一句代码都是invocation.proceed()（内部执行method.invoke方法），否则将无法执行下一个拦截器的intercept方法。

以上逻辑对应的时序图如下，这里我们以执行executor对象的query方法为例，且假设有两个拦截器存在：

![format_png 14][]

这里以分页插件为例，来了解下一般mybatis插件的编写规则，如下所示：

主要需要实现三个方法

1.  intercept:在此实现自己的拦截逻辑，可从Invocation参数中拿到执行方法的对象，方法，方法参数，从而实现各种业务逻辑, 如下代码所示，从invocation中获取的statementHandler对象即为被代理对象，基于该对象，我们获取到了执行的原始SQL语句，以及prepare方法上的分页参数，并更改SQL语句为新的分页语句，最后调用invocation.proceed()返回结果。
2.  plugin：生成代理对象；
3.  setProperties：设置一些属性变量；

![format_png 15][]

简单的说，mybatis插件就是对ParameterHandler、ResultSetHandler、StatementHandler、Executor这四个接口上的方法进行拦截，利用JDK动态代理机制，为这些接口的实现类创建代理对象，在执行方法时，先去执行代理对象的方法，从而执行自己编写的拦截逻辑，所以真正要用好mybatis插件，主要还是要熟悉这四个接口的方法以及这些方法上的参数的含义；

另外，如果配置了多个拦截器的话，会出现层层代理的情况，即代理对象代理了另外一个代理对象，形成一个代理链条，执行的时候，也是层层执行；

关于mybatis插件涉及到的设计模式和软件思想如下：

1.  设计模式：代理模式、责任链模式；
2.  软件思想：AOP编程思想，降低模块间的耦合度，使业务模块更加独立；

一些注意事项：

1.  不要定义过多的插件，代理嵌套过多，执行方法的时候，比较耗性能；
2.  拦截器实现类的intercept方法里最后不要忘了执行invocation.proceed()方法，否则多个拦截器情况下，执行链条会断掉；

作者：风一样的码农

链接：http://www.cnblogs.com/chenpi/

--------------------

\-END-

如果看到这里，说明你喜欢这篇文章，请**转发****、点赞**。同时标星（置顶）本公众号可以第一时间接受到博文推送。

**推****荐****阅****读**

***1. ***[雷军 1994 年写的代码，不服不行！][1994]

***2. ***[干掉 try catch ！][try catch]

***3.*** [Spring Boot + Vue.js 前端分离][Spring Boot _ Vue.js]

***4. ***[去掉烦人的 !=null][_null]

![format_png 16][]

[Java]: https://blog.csdn.net/qq_37217713/article/details/101445094
[format_png]: /images/20210730/71241f30d6684801af2d48d0bda6b43d.png
[format_png 1]: /images/20210730/61f5c16ac42a4e35a971235b10c1f063.png
[format_png 2]: /images/20210730/6b83dec6468c45838e7558b7ab2649df.png
[format_png 3]: /images/20210730/19a13c15b0284d69a670c2b146eaf7fa.png
[format_png 4]: /images/20210730/576ec66e25674254b1f90c9c376220fc.png
[format_png 5]: /images/20210730/d6b35a8eda064422999816a93ef367e1.png
[format_png 6]: /images/20210730/34c8f32cfc6248bab633acbcf38d9234.png
[format_png 7]: /images/20210730/b1b61e0f0660405aae30579586a8eeec.png
[format_png 8]: /images/20210730/74449f2d5b824c52bf3d3e3b832225b1.png
[format_png 9]: /images/20210730/5689f7e891624914803591c294e6fee2.png
[format_png 10]: /images/20210730/3dbc27fd8fb3431cafc6d400334e29dc.png
[format_png 11]: /images/20210730/dac57d6974634cce8da002a6ec721e7d.png
[format_png 12]: /images/20210730/bef27b1856334f7491c0d27d3e0c6932.png
[format_png 13]: /images/20210730/bf5ebcc1a96242349d5e39285823814c.png
[format_png 14]: /images/20210730/9d340717de0446648fd1ca13a123d7d7.png
[format_png 15]: /images/20210730/e35fe764750f40b7b8355c4728db1f0b.png
[1994]: http://mp.weixin.qq.com/s?__biz=Mzg2MjEwMjI1Mg%3D%3D&chksm=ce0e511cf979d80a20f2273dd108fdcdaef334274212a60c0476eaf20c4ece359c400b502096&idx=1&mid=2247493279&scene=21&sn=1294e31f6a10d4873d364cab35bd3140#wechat_redirect
[try catch]: https://blog.csdn.net/qq_37217713/article/details/105852454
[Spring Boot _ Vue.js]: http://mp.weixin.qq.com/s?__biz=Mzg2MjEwMjI1Mg%3D%3D&chksm=ce0e51f4f979d8e25ca2292afa2ef90eab2c052ee10a178167c6d5fcd1c972c1d1af1f91e759&idx=1&mid=2247493239&scene=21&sn=7835adf5f0cfa509f3dd7baf922c5fd3#wechat_redirect
[_null]: https://blog.csdn.net/qq_37217713/article/details/105781184
[format_png 16]: /images/20210730/b191e2a0a22a4c26a3c27b543a2ac392.png