mybatis 插件的原理-责任链和动态代理的体现

目录

  • 1 拦截哪些方法
  • 2 如何代理
  • 3 代理对象
  • 4 责任链设计模式

@

如果没有自定义过拦截器, 可以看我前面的文章。如果不知道 JDK 动态代理怎么使用的, 可以看我这文章。 责任链设计模式理解起来很简单, 网上找个例子看看即可。

mybatis 插件的原理使用的是动态代理和责任链来实现的。

1 拦截哪些方法

前面说过, 可以通过注解 InteceptsSignature 来进行指定拦截哪些方法。 然而, 并不是说所有的方法都可以拦截的。

mybatis 拦截器所拦截的方法, 有如下类型:

1. Executor (update, query, flushStatements, commit, rollback, getTransaction, close, isClosed)
2. ParameterHandler (getParameterObject, setParameters)
3. ResultSetHandler (handleResultSets, handleOutputParameters)
4. StatementHandler (prepare, parameterize, batch, update, query)

为什么说可以拦截的方法是这些呢?

mybatis 中, 以上几个类是 SqlSession 的四大对象。 SqlSession 通过这些对象实现对数据库的操作, 结果的处理。 因此, 从流程上来说, 是拦截这几个对象中的方法是有非常重要的作用的。

而在源码上的体现呢, 就在 Configuration 类中, 这个类的重要性不做过多的阐述, 可以看看前面的文章。

在总 xml 解析成 Configuration 过程中, 需要 new 出以上的几个类。而以上的几个类在后面都会调用 interceptorChain#pluginAll 方法。

2 如何代理

public class InterceptorChain {

  /**
   * 拦截器列表
   */
  private final List<Interceptor> interceptors = new ArrayList<>();

  public Object pluginAll(Object target) {
    for (Interceptor interceptor : interceptors) {
      target = interceptor.plugin(target);
    }
    return target;
  }

  /**
   * 添加拦截器
   *
   * @param interceptor
   */
  public void addInterceptor(Interceptor interceptor) {
    interceptors.add(interceptor);
  }

  /**
   * 获取拦截器列表
   *
   * @return
   */
  public List<Interceptor> getInterceptors() {
    return Collections.unmodifiableList(interceptors);
  }

}

可以看到, 其会将调用所有拦截器的 plugin 方法, 层层代理之后返回最终的代理对象。 要注意这里的层层代理。

如果有 A、B、C 三个拦截器(签名相同), 则在此时, 会被层层封装。 最后执行的时候, 是 A>B>C> target.proceed() >C>B>A.

3 代理对象

InterceptorChain 会调用每个拦截器中的 plugin 方法。该方法是会返回相应的代理对象的。

/**
 * 拦截器接口
 *
 * @author Clinton Begin
 */
public interface Interceptor {

  /**
   * 执行拦截逻辑的方法
   *
   * @param invocation 调用信息
   * @return 调用结果
   * @throws Throwable 异常
   */
  Object intercept(Invocation invocation) throws Throwable;

  /**
   * 代理
   *
   * @param target
   * @return
   */
  Object plugin(Object target);

  /**
   * 根据配置来初始化 Interceptor 方法
   * @param properties
   */
  void setProperties(Properties properties);

}

其中的 plugin 是需要我们来实现的。 而 mybatis 也给我们提供了很方便的方法。

  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) {
      // 创建代理对象
      return Proxy.newProxyInstance(
              type.getClassLoader(),
              interfaces,
              new Plugin(target, interceptor, signatureMap));
    }
    return target;
  }

我们在重写 plugin 方法时, 只需要调用上面这个方法即可。 其会返回 Plugin 这个类的一个对象。

public class Plugin implements InvocationHandler
  @Override
  public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
    try {
      // 获取方法所在类中, 可以被拦截的所有的方法
      Set<Method> methods = signatureMap.get(method.getDeclaringClass());
      // 如果需要被拦截, 则调用 interceptor.intercept
      if (methods != null && methods.contains(method)) {
        return interceptor.intercept(new Invocation(target, method, args));
      }
      // 没有被拦截则正常调用
      return method.invoke(target, args);
    } catch (Exception e) {
      throw ExceptionUtil.unwrapThrowable(e);
    }
  }

由于 JDK 的动态代理是接口级别的。 因此, 其代理了类的所有接口的方法。 然而并不是所有的方法都是需要被代理的, 因此, 在方法中通过注解中的签名信息进行区分。

4 责任链设计模式

在插件的使用过程中, 责任链设计模式体现在动态代理的层层嵌套的代理增强之中。 体现在interceptorChain#pluginAll 方法中。 调用时会层层的进行代理。 mybatis 插件的原理-责任链和动态代理的体现

原文地址:https://www.cnblogs.com/homejim/p/11605228.html

时间: 2024-11-03 05:32:13

mybatis 插件的原理-责任链和动态代理的体现的相关文章

【Mybtais】Mybatis 插件 Plugin开发(一)动态代理步步解析

需求: 对原有系统中的方法进行'拦截',在方法执行的前后添加新的处理逻辑. 分析: 不是办法的办法就是,对原有的每个方法进行修改,添加上新的逻辑:如果需要拦截的方法比较少,选择此方法到是会节省成本.但是面对成百上千的方法怎么办?此时需要用到动态代理来实现. 场景: 例如:对原有的系统添加日志记录.添加性能分析等等... 举例: 如下,需要对Sleep对象的sleep方法进行"拦截",并在此方法的执行前后添加新的逻辑.想知道'睡觉前干了什么?睡觉后干了什么?' interface Sle

小白也能看懂的插件化DroidPlugin原理(一)-- 动态代理

前言:插件化在Android开发中的优点不言而喻,也有很多文章介绍插件化的优势,所以在此不再赘述.前一阵子在项目中用到 DroidPlugin 插件框架 ,近期准备投入生产环境时出现了一些小问题,所以决心花些时间研究了一下 DroidPlugin 插件框架的原理,以便再出现问题时也能从容应对.打开源码后发现尽是大把大把的 hook.binder.classloader 等等,很难摸清头绪,幸运的是,有很多热心的大神已经对 DroidPlugin 的原理进行了透彻的剖析,文末会有本人对参考文章的致

mybatis插件机制原理

mybatis插件机制及分页插件原理 参考链接:mybatis插件机制及分页插件原理 如何编写一个自定义mybatis插件 参考链接:mybatis 自定义插件的使用 原文地址:https://www.cnblogs.com/jxxblogs/p/12150439.html

jdk动态代理和cglib动态代理底层实现原理详细解析(cglib动态代理篇)

代理模式是一种很常见的模式,关于底层原理网上看到很多的有关的讲解,但看了一些都觉得比较粗略,很多时候把底层代码copy下来也不大讲解,感觉不如自己详细的写上一篇.本文将以非常详细的说明来分析cglib动态代理底层的实现原理,篇幅较长,但是每个核心方法代码中每步都有说明.还请耐心阅读 1. 举例 使用cglib代理需要引入两个包,maven的话包引入如下 <!-- https://mvnrepository.com/artifact/cglib/cglib --> <dependency&

MyBATIS插件原理第一篇——技术基础(反射和JDK动态代理)(转)

在介绍MyBATIS插件原理前我们需要先学习一下一些基础的知识,否则我们是很难理解MyBATIS的运行原理和插件原理的. MyBATIS最主要的是反射和动态代理技术,让我们首先先熟悉它们. 1:Java反射技术 在Java中反射技术已经大行其道,通过不断的优化性能得到了巨大的提高,而反射技术使得Java的可配置性大大提高.让我们来写一个服务打印hello + 姓名. import java.lang.reflect.InvocationTargetException; import java.l

深入浅出MyBatis:MyBatis插件及开发过程

本篇文章是「深入浅出MyBatis:技术原理与实践」书籍的总结笔记. 上一篇介绍了 MyBatis解析和运行原理 ,包括SqlSessionFactory的构建和SqlSession的执行过程,其中,SqlSession包含四大对象,可以在四大对象调度的时候插入自定义的代码,以满足特殊的需求,这便是MyBatis提供的插件技术. 有些特殊场景,需要使用插件统一处理,比如:在进行多租户开发时,数据要按租户隔离,可以在sql语句后面统一添加租户编号筛选条件. 本篇就来介绍下插件,通过本篇的介绍,你会

java动态代理原理及解析

代理:设计模式 代理模式是一种常用的设计模式,其目的就是为其他对象提供一个代理以控制对某个真实对象的访问.代理类负责为委托类预处理消息,过滤消息并转发消息,以及进行消息被委托类执行后的后续处理. 通过代理层这一中间层,有效的控制对于真实委托类对象的直接访问,同时可以实现自定义的控制策略(Spring的AOP机制),设计上获得更大的灵活性. java动态代理的类和接口(jdk1.6源码) 1,java.lang.reflect.Proxy:动态代理机制的主类,提供一组静态方法为一组接口动态的生成对

设计模式(十八):责任链模式

一.定义 请求在这个链上传递,直到链上的某一个对象决定处理此请求. 发出这个请求的客户端并不知道链上的哪一个对象最终处理这个请求,这使得系统可以在不影响客户端的情况下动态地重新组织和分配责任. 二.实例 其实和状态模式类似,只是状态模式在具体的子类中指定了下一个具体的处理对象.而责任链模式,可以在客户端动态的组织链的规则和责任. 首先,上下文类: public class Context { public string Suffix { get; set; } } 其次,抽象责任 public

设计模式----责任链模式(职责链模式)Chain of Responsibility)

一.定义 职责链模式是一种对象的行为模式.在职责链模式里,很多对象由每一个对象对其下家的引用而连接起来形成一条链.请求在这个链上传递,直到链上的某一个对象决定处理此请求.发出这个请求的客户端并不知道链上的哪一个对象最终处理这个请求,这使得系统可以在不影响客户端的情况下动态地重新组织链和分配责任. 1.为请求创建一个接收此次请求对象的链 2.类型:行为型 二.适用场景 一个请求的处理需要多个对象当中的一个或几个协作处理 三.有点 请求的发送者和接收者(请求的处理)解耦 责任链可以动态的组合 四.缺