mybatis插件機制

目錄

• mybatis插件機制
• 主要 類/介面 和 方法
• mybatis插件機制實現

mybatis插件機制

mybatis的插件機制使用動態代理實現，不瞭解的朋友請先瞭解代理模式和動態代理；插件本質是功能增強，那麼它如果需要對某個方法進行增強，首先要攔截這個方法，其實也就類似於攔截器，mybatis的插件在代碼中定義為Interceptor，也就是攔截器；後面統一稱作攔截器；

主要 類/介面 和 方法

• Interceptor

• InterceptorChain

• Plugin

mybatis插件機制實現

InterceptorChain中維護了一個攔截器列表，也就說所有的攔截器都要在這裡註冊；

InterceptorChain中關鍵的一個方法是pluginAll：

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

pluginAll方法中是調用了Interceptor的plugin方法，
這個plugin方法是一個覆寫方法，需要插件開發者自己實現，但是Mybatis已經提供了相應的實現：

  @Override
    public Object plugin(Object target) {
        return Plugin.wrap(target, this);
    }

打開Plugin這個工具類發現它實現了InvocationHandler介面，再看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);
    //判斷是否是否實現了介面，如果是則使用jdk動態代理生成代理對象，否則返回原對象
    if (interfaces.length > 0) {
      return Proxy.newProxyInstance(
          type.getClassLoader(),
          interfaces,
          new Plugin(target, interceptor, signatureMap));
    }
    return target;
  }

實際上就是使用jdk動態代理為target創建了一個代理對象，並且這個被代理的對象必須是一個介面的實現類（jdk動態代理必須有介面），否則不會生成代理對象，也就是說攔截器只能攔截介面的方法；既然是動態代理肯定要看一下invoke方法：

 public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
    try {
      Set<Method> methods = signatureMap.get(method.getDeclaringClass());
      //如果當前執行的方法是攔截器想要攔截的方法則執行攔截器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);
    }
  }

可以看到invoke方法中signatureMap是否有存在當前調用的Method決定了是否調用Interceptor的intercept方法，也就是說Interceptor只對signatureMap中的方法生效，那麼再來看signatureMap是怎麼來的：

 private static Map<Class<?>, Set<Method>> getSignatureMap(Interceptor interceptor) {
    //獲取攔截器Intercepts註解
    Intercepts interceptsAnnotation = interceptor.getClass().getAnnotation(Intercepts.class);
    if (interceptsAnnotation == null) { // issue #251
      throw new PluginException("No @Intercepts annotation was found in interceptor " + interceptor.getClass().getName());      
    }
    Signature[] sigs = interceptsAnnotation.value();
    Map<Class<?>, Set<Method>> signatureMap = new HashMap<Class<?>, Set<Method>>();
    for (Signature sig : sigs) {
      Set<Method> methods = signatureMap.get(sig.type());
      if (methods == null) {
        methods = new HashSet<Method>();
        signatureMap.put(sig.type(), methods);
      }
      try {
       //根據方法簽名（類類型，方法名，方法參數）反射獲取方法對象
        Method method = sig.type().getMethod(sig.method(), sig.args());
        methods.add(method);
      } catch (NoSuchMethodException e) {
        throw new PluginException("Could not find method on " + sig.type() + " named " + sig.method() + ". Cause: " + e, e);
      }
    }
    return signatureMap;
  }

到這裡可以看到，Interceptor需要攔截的方法通過@Intercepts註解申明，這裡根據註解中的方法簽名（類類型，方法名，方法參數）反射獲取具體方法並添加到signatureMap中；Interceptor中的Intercepts註解就是定義需要攔截的方法集合；

那麼再回過頭看InterceptorChain的pluginAll方法，方法內遍歷所有的攔截器並調用plugin方法，實際上就是每個插件都是一層代理，通過多層代理來綁定多個插件；換句話說，某個對象要想被InterceptorChain中的攔截器攔截，那麼此對象必須經過InterceptorChain的pluginAll(Object target)方法的包裝，當然由於jdk動態代理的關係必須是介面對象；

比如mybatis分頁插件：

@SuppressWarnings({"rawtypes", "unchecked"})
@Intercepts(
    {
        @Signature(type = Executor.class, method = "query", args = {MappedStatement.class, Object.class, RowBounds.class, ResultHandler.class}),
        @Signature(type = Executor.class, method = "query", args = {MappedStatement.class, Object.class, RowBounds.class, ResultHandler.class, CacheKey.class, BoundSql.class}),
    }
)
public class PageInterceptor implements Interceptor {
    //緩存count查詢的ms
    protected Cache<CacheKey, MappedStatement> msCountMap = null;
    private Dialect dialect;
    private String default_dialect_class = "com.github.pagehelper.PageHelper";
    private Field additionalParametersField;

    @Override
    public Object intercept(Invocation invocation) throws Throwable {
        //分頁邏輯
    }

    @Override
    public Object plugin(Object target) {
        return Plugin.wrap(target, this);
    }

    @Override
    public void setProperties(Properties properties) {
       //獲取配置
    }

}

通過上文我們知道它需要攔截Executor的query方法，Executor是mybatis運行sql的核心組件，之所以能夠被攔截是因為：
在Configuration類中創建Executor之後，有這樣一句代碼：

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

完~