快捷導(dǎo)航

MyBatis插件機(jī)制的使用及說(shuō)明

更新時(shí)間：2026年01月08日 15:37:31 作者：jpq+

MyBatis插件機(jī)制通過(guò)攔截器實(shí)現(xiàn),允許開(kāi)發(fā)者在不修改源代碼的情況下擴(kuò)展和定制MyBatis功能,主要攔截方法包括Executor、ParameterHandler、ResultSetHandler和StatementHandler,攔截器通過(guò)XML配置或Java代碼定義,實(shí)現(xiàn)對(duì)目標(biāo)對(duì)象的方法調(diào)用攔截和增強(qiáng)

Executor (update, query, flushStatements, commit, rollback, getTransaction, close, isClosed) 攔截執(zhí)行器的方法
ParameterHandler (getParameterObject, setParameters) 攔截參數(shù)的處理
ResultSetHandler (handleResultSets, handleOutputParameters) 攔截結(jié)果集的處理
StatementHandler (prepare, parameterize, batch, update, query) 攔截Sql語(yǔ)法構(gòu)建的處理

攔截器介紹及配置

MyBatis攔截器的接口定義，plugin方法用于某些處理器(Handler)的構(gòu)建過(guò)程。interceptor方法用于處理代理類(lèi)的執(zhí)行。

setProperties方法用于攔截器屬性的設(shè)置：

public interface Interceptor {

  Object intercept(Invocation invocation) throws Throwable;

  Object plugin(Object target);

  void setProperties(Properties properties);

}

MyBatis默認(rèn)沒(méi)有一個(gè)攔截器接口的實(shí)現(xiàn)類(lèi)。

下面的MyBatis官網(wǎng)的一個(gè)攔截器實(shí)例，這個(gè)攔截器攔截Executor接口的update方法，所有執(zhí)行executor的update方法都會(huì)被該攔截器攔截到：

@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) {
  }
}

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

源碼分析

先從源頭->配置文件開(kāi)始分析：

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);
        }
    }
}
public void addInterceptor(Interceptor interceptor) {
    interceptorChain.addInterceptor(interceptor);
}

InterceptorChain類(lèi)包含一個(gè)Interceptor類(lèi)型的列表，用于存儲(chǔ)攔截器。

類(lèi)中有三個(gè)方法：pluginAll()用于將所有攔截器應(yīng)用于目標(biāo)對(duì)象：

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);
    }

}

一開(kāi)始說(shuō)的幾種方法都會(huì)調(diào)用pluginAll：

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) {
    return newExecutor(transaction, defaultExecutorType);
  }

  public Executor newExecutor(Transaction transaction, ExecutorType executorType) {
   ...
    executor = (Executor) interceptorChain.pluginAll(executor);
    return executor;
  }

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

Plugin.wrap方法

Mybatis 中的 Plugin.wrap方法用于生成代理對(duì)象，實(shí)現(xiàn)對(duì)目標(biāo)對(duì)象的增強(qiáng)。在 Mybatis 中，插件是通過(guò)動(dòng)態(tài)代理實(shí)現(xiàn)的，而 Plugin.wrap方法就是用于創(chuàng)建代理對(duì)象的核心方法。

具體來(lái)說(shuō)，Plugin.wrap方法接收兩個(gè)參數(shù)：

一個(gè)是目標(biāo)對(duì)象（target），另一個(gè)是插件實(shí)例（plugin）。

方法的主要作用是將插件實(shí)例和目標(biāo)對(duì)象進(jìn)行綁定，然后通過(guò)動(dòng)態(tài)代理技術(shù)生成一個(gè)新的代理對(duì)象，該代理對(duì)象在調(diào)用目標(biāo)對(duì)象的方法時(shí)，會(huì)先執(zhí)行插件實(shí)例中對(duì)應(yīng)的攔截方法（interceptor），從而實(shí)現(xiàn)對(duì)目標(biāo)對(duì)象的功能增強(qiáng)。

public class Plugin implements InvocationHandler {
private Object target;// 被代理的目標(biāo)類(lèi)

private Interceptor interceptor;// 對(duì)應(yīng)的攔截器

private Map<Class<?>, Set<Method>> signatureMap;// 攔截器攔截的方法緩存

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;
  }
  }