开发者社区> Lux_Sun> 正文

MyBatis - 插件之原理机制

简介: MyBatis - 插件之原理机制
+关注继续查看

image.png


Mybatis采用责任链模式,通过动态代理组织多个拦截器(插件),通过这些拦截器可以改变Mybatis的默认行为(诸如SQL重写之类的),由于插件会深入到Mybatis的核心,因此在编写自己的插件前最好了解下它的原理,以便写出安全高效的插件。


MyBatis之所以通过SQL_XML(替代实现类),底层的操作就是MyBatis的核心四大对象。

责任链的模式相当于过滤器链。


一、代理链的生成


image.png


Mybatis支持对Executor、StatementHandler、PameterHandler和ResultSetHandler进行拦截,也就是说会对这4种对象进行代理。下面以Executor为例。Mybatis在创建Executor对象时会执行下面一行代码

executor =(Executor) interceptorChain.pluginAll(executor);

InterceptorChain里保存了所有的拦截器,它在mybatis初始化的时候创建。上面这句代码的含义是调用拦截器链里的每个拦截器依次对executor进行plugin(插入)代码如下

/**
 * 每一个拦截器对目标类都进行一次代理
 * @paramtarget
 * @return 层层代理后的对象
 */
public Object pluginAll(Object target) {
    for(Interceptor interceptor : interceptors) {
        target= interceptor.plugin(target);
    }
    return target;
}

下面以一个简单的例子来看看这个plugin方法里到底发生了什么。

@Intercepts({
    @Signature(type = Executor.class, method ="update", args = {MappedStatement.class, Object.class})})
public class ExamplePlugin implements Interceptor {
 
    @Override
    public Object intercept(Invocation invocation) throws Throwable {
        return invocation.proceed();
    }
 
    @Override
    public Object plugin(Object target) {
        return Plugin.wrap(target, this);
    }
 
    @Override
    public void setProperties(Properties properties) {
    }
 
}

每一个拦截器都必须实现上面的三个方法,其中


1)       Object intercept(Invocation invocation) 是实现拦截逻辑的地方,内部要通过invocation.proceed()显式地推进责任链前进,也就是调用下一个拦截器拦截目标方法。


2)       Object plugin(Object target) 就是用当前这个拦截器生成对目标target的代理,实际是通过Plugin.wrap(target,this) 来完成的,把目标target和拦截器this传给了包装函数。


3)       void setProperties(Properties properties) 用于设置额外的参数,参数配置在拦截器的Properties节点里。


注解里描述的是指定拦截方法的签名  [type, method, args] (即对哪种对象的哪种方法进行拦截),它在拦截前用于决断。


二、Plugin.wrap方法

从前面可以看出,每个拦截器的plugin方法是通过调用Plugin.wrap方法来实现的。代码如下:

public static Object wrap(Object target, Interceptor interceptor) {
   //从拦截器的注解中获取拦截的类名和方法信息
   Map<Class<?>, Set<Method>> signatureMap =getSignatureMap(interceptor);
   Class<?> type = target.getClass();
   //解析被拦截对象的所有接口(注意是接口)
   Class<?>[] interfaces = getAllInterfaces(type, signatureMap);
   if(interfaces.length > 0) {
        //生成代理对象, Plugin对象为该代理对象的InvocationHandler  (InvocationHandler属于java代理的一个重要概念,不熟悉的请参考相关概念)
        return Proxy.newProxyInstance(type.getClassLoader(), interfaces, new Plugin(target,interceptor,signatureMap));
    }
    return target;
} 

这个Plugin类有三个属性


  private Object target;//被代理的目标类


  private Interceptor interceptor;//对应的拦截器


  private Map, Set> signatureMap;//拦截器拦截的方法缓存


我们再次结合(Executor)interceptorChain.pluginAll(executor)这个语句来看,这个语句内部对


executor执行了多次plugin,第一次plugin后通过Plugin.wrap方法生成了第一个代理类,姑且就叫executorProxy1,这个代理类的target属性是该executor对象。第二次plugin后通过Plugin.wrap方法生成了第二个代理类,姑且叫executorProxy2,这个代理类的target属性是executorProxy1...这样通过每个代理类的target属性就构成了一个代理链(从最后一个executorProxyN往前查找,通过target属性可以找到最原始的executor类)。


三、代理链上的拦截

代理链生成后,对原始目标的方法调用都转移到代理者的invoke方法上来了。Plugin作为InvocationHandler的实现类,他的invoke方法是怎么样的呢?


public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
    try {
       Set<Method> methods = signatureMap.get(method.getDeclaringClass());
        if(methods != null && methods.contains(method)) {
           //调用代理类所属拦截器的intercept方法
           return interceptor.intercept(new Invocation(target, method, args));
        }
        return method.invoke(target, args);
    } 
    catch(Exception e) {
        throw ExceptionUtil.unwrapThrowable(e);
    }
} 

在invoke里,如果方法签名和拦截中的签名一致,就调用拦截器的拦截方法。我们看到传递给拦截器的是一个Invocation对象,这个对象是什么样子的,他的功能又是什么呢?

public class Invocation {
 
  private Object target;
  private Methodmethod;
  private Object[]args;
 
  public Invocation(Object target, Method method, Object[] args) {
    this.target =target;
    this.method =method;
    this.args =args;
  }
  ...
 
  public Object proceed() throws InvocationTargetException, IllegalAccessException {
    return method.invoke(target, args);
  }
 
}

可以看到,Invocation类保存了代理对象的目标类,执行的目标类方法以及传递给它的参数。


在每个拦截器的intercept方法内,最后一个语句一定是returninvocation.proceed()(不这么做的话拦截器链就断了,你的mybatis基本上就不能正常工作了)。invocation.proceed()只是简单的调用了下target的对应方法,如果target还是个代理,就又回到了上面的Plugin.invoke方法了。这样就形成了拦截器的调用链推进。


public Object intercept(Invocation invocation) throws Throwable {
 
   //完成代理类本身的逻辑
   ...
   //通过invocation.proceed()方法完成调用链的推进
   return invocation.proceed();
}

四、总结


image.png


image.png


针对多个拦截器,拦截同一个对象的同一个方法时,会有这般规则。


我们假设在MyBatis配置了一个插件,在运行时会发生什么?


1)       所有可能被拦截的处理类都会生成一个代理


2)       处理类代理在执行对应方法时,判断要不要执行插件中的拦截方法


3)       执行插接中的拦截方法后,推进目标的执行


如果有N个插件,就有N个代理,每个代理都要执行上面的逻辑。这里面的层层代理要多次生成动态代理,是比较影响性能的。虽然能指定插件拦截的位置,但这个是在执行方法时动态判断,初始化的时候就是简单的把插件包装到了所有可以拦截的地方。


因此,在编写插件时需注意以下几个原则


image.png

版权声明:本文内容由阿里云实名注册用户自发贡献,版权归原作者所有,阿里云开发者社区不拥有其著作权,亦不承担相应法律责任。具体规则请查看《阿里云开发者社区用户服务协议》和《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容,填写侵权投诉表单进行举报,一经查实,本社区将立刻删除涉嫌侵权内容。

相关文章
如何设置阿里云服务器安全组?阿里云安全组规则详细解说
阿里云安全组设置详细图文教程(收藏起来) 阿里云服务器安全组设置规则分享,阿里云服务器安全组如何放行端口设置教程。阿里云会要求客户设置安全组,如果不设置,阿里云会指定默认的安全组。那么,这个安全组是什么呢?顾名思义,就是为了服务器安全设置的。安全组其实就是一个虚拟的防火墙,可以让用户从端口、IP的维度来筛选对应服务器的访问者,从而形成一个云上的安全域。
19804 0
阿里云服务器如何登录?阿里云服务器的三种登录方法
购买阿里云ECS云服务器后如何登录?场景不同,阿里云优惠总结大概有三种登录方式: 登录到ECS云服务器控制台 在ECS云服务器控制台用户可以更改密码、更换系.
29140 0
阿里云服务器安全组设置内网互通的方法
虽然0.0.0.0/0使用非常方便,但是发现很多同学使用它来做内网互通,这是有安全风险的,实例有可能会在经典网络被内网IP访问到。下面介绍一下四种安全的内网互联设置方法。 购买前请先:领取阿里云幸运券,有很多优惠,可到下文中领取。
22538 0
阿里云服务器端口号设置
阿里云服务器初级使用者可能面临的问题之一. 使用tomcat或者其他服务器软件设置端口号后,比如 一些不是默认的, mysql的 3306, mssql的1433,有时候打不开网页, 原因是没有在ecs安全组去设置这个端口号. 解决: 点击ecs下网络和安全下的安全组 在弹出的安全组中,如果没有就新建安全组,然后点击配置规则 最后如上图点击添加...或快速创建.   have fun!  将编程看作是一门艺术,而不单单是个技术。
20693 0
阿里云服务器ECS登录用户名是什么?系统不同默认账号也不同
阿里云服务器Windows系统默认用户名administrator,Linux镜像服务器用户名root
16432 0
腾讯云服务器 设置ngxin + fastdfs +tomcat 开机自启动
在tomcat中新建一个可以启动的 .sh 脚本文件 /usr/local/tomcat7/bin/ export JAVA_HOME=/usr/local/java/jdk7 export PATH=$JAVA_HOME/bin/:$PATH export CLASSPATH=.
14898 0
使用OpenApi弹性释放和设置云服务器ECS释放
云服务器ECS的一个重要特性就是按需创建资源。您可以在业务高峰期按需弹性的自定义规则进行资源创建,在完成业务计算的时候释放资源。本篇将提供几个Tips帮助您更加容易和自动化的完成云服务器的释放和弹性设置。
20910 0
+关注
2689
文章
1
问答
文章排行榜
最热
最新
相关电子书
更多
JS零基础入门教程(上册)
立即下载
性能优化方法论
立即下载
手把手学习日志服务SLS,云启实验室实战指南
立即下载