天天看点

建议收藏,mybatis插件原理详解

上次发文说到了如何集成分页插件MyBatis插件原理分析,看完感觉自己better了,今天我们接着来聊mybatis插件的原理。

mybatis插件涉及到的几个类:

建议收藏,mybatis插件原理详解

我将以 Executor 为例,分析 MyBatis 是如何为 Executor 实例植入插件的。Executor 实例是在开启 SqlSession 时被创建的,因此,我们从源头进行分析。先来看一下 SqlSession 开启的过程。

Executor 的创建过程封装在 Configuration 中,我们跟进去看看看。

如上,newExecutor 方法在创建好 Executor 实例后,紧接着通过拦截器链 interceptorChain 为 Executor 实例植入代理逻辑。那下面我们看一下 InterceptorChain 的代码是怎样的。

上面的for循环代表了只要是插件,都会以责任链的方式逐一执行(别指望它能跳过某个节点),所谓插件,其实就类似于拦截器。

这里就用到了责任链设计模式,责任链设计模式就相当于我们在OA系统里发起审批,领导们一层一层进行审批。

以上是 InterceptorChain 的全部代码,比较简单。它的 pluginAll 方法会调用具体插件的 plugin 方法植入相应的插件逻辑。如果有多个插件,则会多次调用 plugin 方法,最终生成一个层层嵌套的代理类。形如下面:

建议收藏,mybatis插件原理详解

当 Executor 的某个方法被调用的时候,插件逻辑会先行执行。执行顺序由外而内,比如上图的执行顺序为 <code>plugin3 → plugin2 → Plugin1 → Executor</code>。

plugin 方法是由具体的插件类实现,不过该方法代码一般比较固定,所以下面找个示例分析一下。

如上,plugin 方法在内部调用了 Plugin 类的 wrap 方法,用于为目标对象生成代理。Plugin 类实现了 InvocationHandler 接口,因此它可以作为参数传给 Proxy 的 newProxyInstance 方法。

到这里,关于插件植入的逻辑就分析完了。接下来,我们来看看插件逻辑是怎样执行的。

Plugin 实现了 InvocationHandler 接口,因此它的 invoke 方法会拦截所有的方法调用。invoke 方法会对所拦截的方法进行检测,以决定是否执行插件逻辑。该方法的逻辑如下:

invoke 方法的代码比较少,逻辑不难理解。首先,invoke 方法会检测被拦截方法是否配置在插件的 @Signature 注解中,若是,则执行插件逻辑,否则执行被拦截方法。插件逻辑封装在 intercept 中,该方法的参数类型为 Invocation。Invocation 主要用于存储目标类,方法以及方法参数列表。下面简单看一下该类的定义。

关于插件的执行逻辑就分析到这,整个过程不难理解,大家简单看看即可。

下面为了让大家更好的理解Mybatis的插件机制,我们来模拟一个慢sql监控的插件。

然后把这个插件类注入到容器中。

建议收藏,mybatis插件原理详解

然后我们来执行查询的方法。

建议收藏,mybatis插件原理详解

耗时28秒的,大于我们定义的10毫秒,那这条SQL就是我们认为的慢SQL。

通过这个插件,我们就能很轻松的理解setProperties()方法是做什么的了。

也是实现mybatis接口Interceptor。

intercept方法中

建议收藏,mybatis插件原理详解

AbstractHelperDialect类的实现类有如下(也就是此分页插件支持的数据库就以下几种):

建议收藏,mybatis插件原理详解

我们用的是MySQL。这里也有与之对应的。

到这里我们就知道了,它无非就是在我们执行的SQL上再拼接了Limit罢了。同理,Oracle也就是使用rownum来处理分页了。下面是Oracle处理分页

其他数据库分页操作类似。关于具体原理分析,这里就没必要赘述了,因为分页插件源代码里注释基本上全是中文。

水平分表

权限控制

数据的加解密

Spring-Boot+Mybatis继承了分页插件,以及使用案例、插件的原理分析、源码分析、如何自定义插件。

涉及到技术点:JDK动态代理、责任链设计模式、模板方法模式。

Mybatis插件关键对象总结:

Inteceptor接口:自定义拦截必须实现的类。

InterceptorChain:存放插件的容器。

Plugin:h对象,提供创建代理类的方法。

Invocation:对被代理对象的封装。

继续阅读