原文作者：Format
原文地址：原文鏈接
摘抄申明：我們不占有不侵權(quán)篷朵，我們只是好文的搬運(yùn)工！轉(zhuǎn)發(fā)請帶上原文申明糠聪。

MyBatis攔截器介紹

MyBatis提供了一種插件(plugin)的功能荒椭，雖然叫做插件，但其實(shí)這是攔截器功能舰蟆。那么攔截器攔截MyBatis中的哪些內(nèi)容呢趣惠？

我們進(jìn)入官網(wǎng)看一看：

MyBatis 允許你在已映射語句執(zhí)行過程中的某一點(diǎn)進(jìn)行攔截調(diào)用。默認(rèn)情況下身害，MyBatis 允許使用插件來攔截的方法調(diào)用包括：

• 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)

我們看到了可以攔截Executor接口的部分方法，比如update界赔，query丢习，commit，rollback等方法淮悼，還有其他接口的一些方法等咐低。

總體概括為：

• 1、攔截執(zhí)行器的方法
• 2袜腥、攔截參數(shù)的處理
• 3见擦、攔截結(jié)果集的處理
• 4、攔截Sql語法構(gòu)建的處理

攔截器的使用

攔截器介紹及配置

首先我們看下MyBatis攔截器的接口定義：

public interface Interceptor {

  Object intercept(Invocation invocation) throws Throwable;

  Object plugin(Object target);

  void setProperties(Properties properties);

}

比較簡單羹令，只有3個方法鲤屡。 MyBatis默認(rèn)沒有一個攔截器接口的實(shí)現(xiàn)類，開發(fā)者們可以實(shí)現(xiàn)符合自己需求的攔截器福侈。

下面的MyBatis官網(wǎng)的一個攔截器實(shí)例：

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

全局xml配置：

<plugins>
    <plugin interceptor="org.format.mybatis.cache.interceptor.ExamplePlugin"></plugin>
</plugins>

這個攔截器攔截Executor接口的update方法（其實(shí)也就是SqlSession的新增酒来，刪除，修改操作）肪凛，所有執(zhí)行executor的update方法都會被該攔截器攔截到堰汉。

源碼分析

下面我們分析一下這段代碼背后的源碼辽社。

首先從源頭 --> 配置文件開始分析：

XMLConfigBuilder解析MyBatis全局配置文件的pluginElement私有方法：

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í)比較簡單，就不貼了翘鸭，主要就是通過反射實(shí)例化plugin節(jié)點(diǎn)中的interceptor屬性表示的類滴铅。然后調(diào)用全局配置類Configuration的addInterceptor方法。

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

這個interceptorChain是Configuration的內(nèi)部屬性就乓，類型為InterceptorChain汉匙，也就是一個攔截器鏈，我們來看下它的定義：

public class InterceptorChain {

  private final List<Interceptor> interceptors = new ArrayList<Interceptor>();

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

  public void addInterceptor(Interceptor interceptor) {
    interceptors.add(interceptor);
  }

  public List<Interceptor> getInterceptors() {
    return Collections.unmodifiableList(interceptors);
  }

}

現(xiàn)在我們理解了攔截器配置的解析以及攔截器的歸屬档址，現(xiàn)在我們回過頭看下為何攔截器會攔截這些方法（Executor盹兢，ParameterHandler邻梆，ResultSetHandler守伸，StatementHandler的部分方法）：

public ParameterHandler newParameterHandler(MappedStatement mappedStatement, Object parameterObject, BoundSql boundSql) {
    ParameterHandler parameterHandler = mappedStatement.getLang().createParameterHandler(mappedStatement, parameterObject, boundSql);
    parameterHandler = (ParameterHandler) interceptorChain.pluginAll(parameterHandler);
    return parameterHandler;
}

public ResultSetHandler newResultSetHandler(Executor executor, MappedStatement mappedStatement, RowBounds rowBounds, ParameterHandler parameterHandler,
  ResultHandler resultHandler, BoundSql boundSql) {
    ResultSetHandler resultSetHandler = new DefaultResultSetHandler(executor, mappedStatement, parameterHandler, resultHandler, boundSql, rowBounds);
    resultSetHandler = (ResultSetHandler) interceptorChain.pluginAll(resultSetHandler);
    return resultSetHandler;
}

public StatementHandler newStatementHandler(Executor executor, MappedStatement mappedStatement, Object parameterObject, RowBounds rowBounds, ResultHandler resultHandler, BoundSql boundSql) {
    StatementHandler statementHandler = new RoutingStatementHandler(executor, mappedStatement, parameterObject, rowBounds, resultHandler, boundSql);
    statementHandler = (StatementHandler) interceptorChain.pluginAll(statementHandler);
    return statementHandler;
}

public Executor newExecutor(Transaction transaction, ExecutorType executorType, boolean autoCommit) {
    executorType = executorType == null ? defaultExecutorType : executorType;
    executorType = executorType == null ? ExecutorType.SIMPLE : executorType;
    Executor executor;
    if (ExecutorType.BATCH == executorType) {
      executor = new BatchExecutor(this, transaction);
    } else if (ExecutorType.REUSE == executorType) {
      executor = new ReuseExecutor(this, transaction);
    } else {
      executor = new SimpleExecutor(this, transaction);
    }
    if (cacheEnabled) {
      executor = new CachingExecutor(executor, autoCommit);
    }
    executor = (Executor) interceptorChain.pluginAll(executor);
    return executor;
}

以上4個方法都是Configuration的方法。這些方法在MyBatis的一個操作(新增浦妄，刪除尼摹，修改，查詢)中都會被執(zhí)行到剂娄，執(zhí)行的先后順序是Executor蠢涝，ParameterHandler，ResultSetHandler阅懦，StatementHandler(其中ParameterHandler和ResultSetHandler的創(chuàng)建是在創(chuàng)建StatementHandler[3個可用的實(shí)現(xiàn)類CallableStatementHandler,PreparedStatementHandler,SimpleStatementHandler]的時候和二，其構(gòu)造函數(shù)調(diào)用的[這3個實(shí)現(xiàn)類的構(gòu)造函數(shù)其實(shí)都調(diào)用了父類BaseStatementHandler的構(gòu)造函數(shù)])。

這4個方法實(shí)例化了對應(yīng)的對象之后耳胎，都會調(diào)用interceptorChain的pluginAll方法惯吕，InterceptorChain的pluginAll剛才已經(jīng)介紹過了，就是遍歷所有的攔截器怕午，然后調(diào)用各個攔截器的plugin方法废登。注意：攔截器的plugin方法的返回值會直接被賦值給原先的對象。

由于可以攔截StatementHandler郁惜，這個接口主要處理sql語法的構(gòu)建堡距，因此比如分頁的功能，可以用攔截器實(shí)現(xiàn)兆蕉，只需要在攔截器的plugin方法中處理StatementHandler接口實(shí)現(xiàn)類中的sql即可羽戒，可使用反射實(shí)現(xiàn)。

MyBatis還提供了 @Intercepts和 @Signature關(guān)于攔截器的注解虎韵。官網(wǎng)的例子就是使用了這2個注解半醉，還包括了Plugin類的使用：

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

下面我們就分析這3個 "新組合" 的源碼，首先先看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) {
      return Proxy.newProxyInstance(
          type.getClassLoader(),
          interfaces,
          new Plugin(target, interceptor, signatureMap));
    }
    return target;
}

Plugin類實(shí)現(xiàn)了InvocationHandler接口劝术，很明顯缩多，我們看到這里返回了一個JDK自身提供的動態(tài)代理類呆奕。我們解剖一下這個方法調(diào)用的其他方法：

getSignatureMap方法：

private static Map<Class<?>, Set<Method>> getSignatureMap(Interceptor interceptor) {
    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;
}

getSignatureMap方法解釋：首先會拿到攔截器這個類的 @Interceptors注解，然后拿到這個注解的屬性 @Signature注解集合衬吆，然后遍歷這個集合梁钾，遍歷的時候拿出 @Signature注解的type屬性(Class類型)，然后根據(jù)這個type得到帶有method屬性和args屬性的Method逊抡。由于 @Interceptors注解的 @Signature屬性是一個屬性姆泻，所以最終會返回一個以type為key，value為Set<Method>的Map冒嫡。

@Intercepts({@Signature(
  type= Executor.class,
  method = "update",
  args = {MappedStatement.class,Object.class})})

比如這個 @Interceptors注解會返回一個key為Executor拇勃，value為集合(這個集合只有一個元素，也就是Method實(shí)例孝凌，這個Method實(shí)例就是Executor接口的update方法方咆，且這個方法帶有MappedStatement和Object類型的參數(shù))。這個Method實(shí)例是根據(jù) @Signature的method和args屬性得到的蟀架。如果args參數(shù)跟type類型的method方法對應(yīng)不上瓣赂，那么將會拋出異常。

getAllInterfaces方法：

private static Class<?>[] getAllInterfaces(Class<?> type, Map<Class<?>, Set<Method>> signatureMap) {
    Set<Class<?>> interfaces = new HashSet<Class<?>>();
    while (type != null) {
      for (Class<?> c : type.getInterfaces()) {
        if (signatureMap.containsKey(c)) {
          interfaces.add(c);
        }
      }
      type = type.getSuperclass();
    }
    return interfaces.toArray(new Class<?>[interfaces.size()]);
}

getAllInterfaces方法解釋：根據(jù)目標(biāo)實(shí)例target(這個target就是之前所說的MyBatis攔截器可以攔截的類片拍，Executor,ParameterHandler,ResultSetHandler,StatementHandler)和它的父類們煌集，返回signatureMap中含有target實(shí)現(xiàn)的接口數(shù)組。

所以Plugin這個類的作用就是根據(jù) @Interceptors注解捌省，得到這個注解的屬性 @Signature數(shù)組苫纤，然后根據(jù)每個 @Signature注解的type，method纲缓，args屬性使用反射找到對應(yīng)的Method卷拘。最終根據(jù)調(diào)用的target對象實(shí)現(xiàn)的接口決定是否返回一個代理對象替代原先的target對象。

比如MyBatis官網(wǎng)的例子色徘，當(dāng)Configuration調(diào)用newExecutor方法的時候恭金，由于Executor接口的update(MappedStatement ms, Object parameter)方法被攔截器被截獲。因此最終返回的是一個代理類Plugin褂策，而不是Executor横腿。這樣調(diào)用方法的時候，如果是個代理類斤寂，那么會執(zhí)行：

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)) {
        return interceptor.intercept(new Invocation(target, method, args));
      }
      return method.invoke(target, args);
    } catch (Exception e) {
      throw ExceptionUtil.unwrapThrowable(e);
    }
}

沒錯耿焊，如果找到對應(yīng)的方法被代理之后，那么會執(zhí)行Interceptor接口的interceptor方法遍搞。

這個Invocation類如下：

public class Invocation {

  private Object target;
  private Method method;
  private Object[] args;

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

  public Object getTarget() {
    return target;
  }

  public Method getMethod() {
    return method;
  }

  public Object[] getArgs() {
    return args;
  }

  public Object proceed() throws InvocationTargetException, IllegalAccessException {
    return method.invoke(target, args);
  }

}

它的proceed方法也就是調(diào)用原先方法(不走代理)罗侯。

總結(jié)

MyBatis攔截器接口提供的3個方法中，plugin方法用于某些處理器(Handler)的構(gòu)建過程溪猿。interceptor方法用于處理代理類的執(zhí)行钩杰。setProperties方法用于攔截器屬性的設(shè)置纫塌。

其實(shí)MyBatis官網(wǎng)提供的使用 @Interceptors和 @Signature注解以及Plugin類這樣處理攔截器的方法，我們不一定要直接這樣使用讲弄。我們也可以拋棄這3個類措左，直接在plugin方法內(nèi)部根據(jù)target實(shí)例的類型做相應(yīng)的操作。

總體來說MyBatis攔截器還是很簡單的避除，攔截器本身不需要太多的知識點(diǎn)怎披，但是學(xué)習(xí)攔截器需要對MyBatis中的各個接口很熟悉，因?yàn)閿r截器涉及到了各個接口的知識點(diǎn)瓶摆。