摘要：插件插件接口在中使用插件，我們必須實(shí)現(xiàn)接口。它將直接覆蓋你所攔截對(duì)象原有的方法，因此它是插件的核心方法。插件在對(duì)象中的保存插件的代理和反射設(shè)計(jì)插件用的是責(zé)任鏈模式，的責(zé)任鏈?zhǔn)怯扇ザx的。

在MyBatis中使用插件，我們必須實(shí)現(xiàn)接口Interceptor。

public interface Interceptor {
  // 它將直接覆蓋你所攔截對(duì)象原有的方法，因此它是插件的核心方法。
  // Intercept里面有個(gè)參數(shù)Invocation對(duì)象，通過它可以反射調(diào)度原來對(duì)象的方法
  Object intercept(Invocation invocation) throws Throwable;

  // 作用是給被攔截對(duì)象生成一個(gè)代理對(duì)象，并返回它。target是被攔截對(duì)象
  Object plugin(Object target);

  // 允許在plugin元素中配置所需參數(shù)，方法在插件初始化的時(shí)候就被調(diào)用了一次
  void setProperties(Properties properties);

}

插件的初始化是在MyBatis初始化的時(shí)候完成的。

public class XMLConfigBuilder extends BaseBuilder {
  ......
  private void pluginElement(XNode parent) throws Exception {
    if (parent != null) {
      for (XNode child : parent.getChildren()) {
        String interceptor = child.getStringAttribute("interceptor");
        Properties properties = child.getChildrenAsProperties();
        Interceptor interceptorInstance = (Interceptor) resolveClass(interceptor).newInstance();
        interceptorInstance.setProperties(properties);
        configuration.addInterceptor(interceptorInstance);
      }
    }
  }
}

在解析配置文件的時(shí)候，在MyBatis的上下文初始化過程中，就開始讀入插件節(jié)點(diǎn)和我們配置的參數(shù)，同時(shí)使用反射技術(shù)生成對(duì)應(yīng)的插件實(shí)例，然后調(diào)用插件方法中的setProperties方法，設(shè)置我們配置的參數(shù)，然后將插件實(shí)例保存到配置對(duì)象中，以便讀取和使用它。

插件在Configuration對(duì)象中的保存：

  public void addInterceptor(Interceptor interceptor) {
    interceptorChain.addInterceptor(interceptor);
  }

插件用的是責(zé)任鏈模式，MyBatis的責(zé)任鏈?zhǔn)怯蒳nterceptorChain去定義的。在MyBatis創(chuàng)建Executor執(zhí)行器的時(shí)候，我們可以看到有如下的一段代碼：

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

再看下Interceptor的pluginAll方法：

public class InterceptorChain {
  private final List interceptors = new ArrayList();

  public Object pluginAll(Object target) {
    for (Interceptor interceptor : interceptors) {
      // plugin方法是生成代理對(duì)象的方法
      // 可以看出來，如果有多個(gè)插件的話，會(huì)生成多層代理的代理對(duì)象
      target = interceptor.plugin(target);
    }
    return target;
  }
  ......
}

MyBatis為我們提供了Plugin類用于生成代理對(duì)象。

public class Plugin implements InvocationHandler {
  ......

  public static Object wrap(Object target, Interceptor interceptor) {
    Map, Set> 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;
  }

  @Override
  public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
    try {
      Set methods = signatureMap.get(method.getDeclaringClass());
      // 如果存在簽名的攔截方法，插件的intercept方法將被調(diào)用
      if (methods != null && methods.contains(method)) {
        return interceptor.intercept(new Invocation(target, method, args));
      }
      // 否則，直接反射調(diào)度我們要執(zhí)行的方法
      return method.invoke(target, args);
    } catch (Exception e) {
      throw ExceptionUtil.unwrapThrowable(e);
    }
  }
}

在調(diào)用插件的攔截方法時(shí)，可以看到傳遞了一個(gè)新創(chuàng)建的Invocation對(duì)象。

interceptor.intercept(new Invocation(target, method, args));

Invocation類封裝了被代理的對(duì)象、方法及其參數(shù)。

public class Invocation {
  public Invocation(Object target, Method method, Object[] args) {
    this.target = target;
    this.method = method;
    this.args = args;
  }

  // 這個(gè)方法會(huì)調(diào)度被代理對(duì)象的真實(shí)方法， 所以我們通過這個(gè)方法直接調(diào)用被代理對(duì)象原來的方法
  // 如果多個(gè)插件的話，我們知道會(huì)生成多層代理對(duì)象，那么每層被代理都可以通過Invocation調(diào)用這個(gè)proceed方法，
  // 所以在多個(gè)插件的環(huán)境下，調(diào)度proceed()方法時(shí)，MyBatis總是從最后一個(gè)代理對(duì)象運(yùn)行到第一個(gè)代理對(duì)象，
  // 最后是真實(shí)被攔截的對(duì)象方法被運(yùn)行
  public Object proceed() throws InvocationTargetException, IllegalAccessException {
    return method.invoke(target, args);
  }
}