MyBatis——插件原理及应用

学海_无涯_苦作舟

已于 2023-11-04 10:37:52 修改

阅读量221

点赞数 1

文章标签： 1024程序员节

于 2023-10-24 22:53:25 首次发布

本文链接：https://blog.csdn.net/qq_16500963/article/details/134023250

版权

MyBatis框架允许用户通过自定义拦截器的方式改变SQL的执行行为，例如在SQL执行时追加SQL分页语法，从而达到简化分页查询的目的。用户自定义的拦截器也被称为MyBatis插件，本章我们就来分析一下MyBatis插件的实现原理以及如何开发一个插件。

MyBatis插件实现原理

为了弄清楚MyBatis插件的实现原理，我们可以从插件的配置及解析过程开始分析。在MyBatis主配置文件中，可以通过<plugins>标签注册用户自定义的插件信息，例如：

  <plugins>
    <plugin interceptor="org.apache.ibatis.builder.ExamplePlugin">
      <property name="pluginProperty" value="100"/>
    </plugin>
  </plugins>

MyBatis的插件实际上就是一个拦截器，Configuration类中维护了一个InterceptorChain的实例，代码如下：

public class Configuration {
  protected final InterceptorChain interceptorChain = new InterceptorChain();

  /**
   * Gets the interceptors.
   *
   * @return the interceptors
   * @since 3.2.2
   */
  public List<Interceptor> getInterceptors() {
    return interceptorChain.getInterceptors();
  }

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

interceptorChain属性是一个拦截器链，用于存放通过<plugins>标签注册的所有拦截器，Configration类中还定义了一个addInterceptor()方法，用于向拦截器链中添加拦截器。MyBatis框架在应用启动时会对<plugins>标签进行解析。下面是XMLConfigBuilder类的pluginElement()方法解析<plugins>标签的过程：

  private void pluginElement(XNode parent) throws Exception {
    if (parent != null) {
      for (XNode child : parent.getChildren()) {
        // 获取<plugin>标签的interceptor属性
        String interceptor = child.getStringAttribute("interceptor");

        // 获取拦截器属性，转换为Properties对象
        Properties properties = child.getChildrenAsProperties();

        // 创建拦截器实例
        Interceptor interceptorInstance = (Interceptor) resolveClass(interceptor).getDeclaredConstructor().newInstance();

        // 设置拦截器实例属性信息
        interceptorInstance.setProperties(properties);

        // 将拦截器实例添加到拦截器链中
        configuration.addInterceptor(interceptorInstance);
      }
    }
  }

如上面的代码所示，在XMLConfigBuilder类的pluginElement()方法中，首先获取<plugin>标签的interceptor属性，然后获取用户指定的拦截器属性并转换为Properties对象，然后通过Java的反射机制实例化拦截器对象，设置完拦截器对象的属性信息后，将拦截器对象添加到Configuration类中维护的拦截器链中。

到此为止，拦截器的注册过程已经分析完毕。接下来我们来看一下拦截器的执行过程。用户自定义的插件只能对MyBatis中的4种组件的方法进行拦截，这4种组件及方法如下：

Executor（update, query, flushStatements,commit, rollback, getTransaction, close, isClosed）
ParameterHandler（getParameterObject, setParameters）
ResultSetHandler（handleResultSets, handleOutputParameters）
StatementHandler（prepare, parameterize, batch, update, query）

为什么MyBatis插件能够对Executor、ParameterHandler、ResultSetHandler、StatementHandler四种组件的实例进行拦截呢？

我们可以从MyBatis源码中获取答案。前面在介绍Configuration组件的作用时，我们了解到Configuration组件有3个作用，分别如下：

用于描述MyBatis配置信息，项目启动时，MyBatis的所有配置信息都被转换为Configuration对象。
作为中介者简化MyBatis各个组件之间的交互，解决了各个组件错综复杂的调用关系，属于中介者模式的应用。
作为Executor、ParameterHandler、ResultSetHandler、StatementHandler组件的工厂创建这些组件的实例。

MyBatis使用工厂方法创建Executor、ParameterHandler、ResultSetHandler、StatementHandler组件的实例，其中一个原因是可以根据用户配置的参数创建不同实现类的实例；另一个比较重要的原因是可以在工厂方法中执行拦截逻辑。我们不妨看一下Configuration类中这些工厂方法的实现，代码如下：

  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) {
    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);
    }
    executor = (Executor) interceptorChain.pluginAll(executor);
    return executor;
  }

如上面的代码所示，在Configuration类的newParameterHandler()、newResultSetHandler()、newStatementHandler()、newExecutor()这些工厂方法中，都调用了InterceptorChain对象的pluginAll()方法，pluginAll()方法返回ParameterHandler、ResultSetHandler、StatementHandler或者Executor对象的代理对象，拦截逻辑都是在代理对象中完成的。这就解释了为什么MyBatis自定义插件只能对Executor、ParameterHandler、ResultSetHandler、StatementHandler这4种组件的方法进行拦截。

接下来我们再来了解一下拦截器链InterceptorChain类的实现，代码如下：

public class InterceptorChain {

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

  // 调用所有拦截器对象的plugin()方法执行拦截逻辑
  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);
  }

}

在InterceptorChain类中通过一个List对象维护所有的拦截器实例，在InterceptorChain的pluginAll()方法中，会调用所有拦截器实例的plugin()方法，该方法返回一个目标对象的代理对象。

MyBatis中所有用户自定义的插件都必须实现Interceptor接口，该接口的定义如下：

public interface Interceptor {

  Object intercept(Invocation invocation) throws Throwable;

  default Object plugin(Object target) {
    return Plugin.wrap(target, this);
  }

  default void setProperties(Properties properties) {
    // NOP
  }

}

Interceptor接口中定义了3个方法，intercept()方法用于定义拦截逻辑，该方法会在目标方法调用时执行。plugin()方法用于创建Executor、ParameterHandler、ResultSetHandler或StatementHandler的代理对象，该方法的参数即为Executor、ParameterHandler、ResultSetHandler或StatementHandler组件的实例。setProperties()方法用于设置插件的属性值。需要注意的是，intercept()接收一个Invocation对象作为参数，Invocation对象中封装了目标对象的方法及参数信息。Invocation类的实现代码如下：

public class Invocation {

  private final Object target;
  private final Method method;
  private final 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);
  }

}

如上面的代码所示，Invocation类中封装了目标对象、目标方法及参数信息，我们可以通过Invocation对象获取目标对象（Executor、ParameterHandler、ResultSetHandler或StatementHandler）的所有信息。另外，Invocation类中提供了一个proceed()方法，该方法用于执行目标方法的逻辑。所以在自定义插件类中，拦截逻辑执行完毕后一般都需要调用proceed()方法执行目标方法的原有逻辑。

为了便于用户创建Executor、ParameterHandler、ResultSetHandler或StatementHandler实例的代理对象，MyBatis中提供了一个Plugin工具类，该类的关键代码如下：

public class Plugin implements InvocationHandler {
  // 目标对象，即Executor、ParameterHandler、ResultSetHandler和StatementHandler对象
  private final Object target;
  // 用户自定义拦截器实例
  private final Interceptor interceptor;
  // Intercepts注解指定的方法
  private final Map<Class<?>, Set<Method>> signatureMap;

  private Plugin(Object target, Interceptor interceptor, Map<Class<?>, Set<Method>> signatureMap) {
    this.target = target;
    this.interceptor = interceptor;
    this.signatureMap = signatureMap;
  }

  @Override
  public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
    try {
      // 如果方法是Intercepts注解指定的方法，则调用拦截器实例的intercept()方法执行拦截逻辑
      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);
    }
  }

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

}

如上面的代码所示，Plugin类实现了InvocationHandler接口，即采用JDK内置的动态代理方式创建代理对象。Plugin类中维护了Executor、ParameterHandler、ResultSetHandler或者StatementHandler类的实例，以及用户自定义的拦截器实例和拦截器中通过Intercepts注解指定的拦截方法。Plugin类的invoke()方法会在调用目标对象的方法时执行，在invoke()方法中首先判断该方法是否被Intercepts注解指定为被拦截的方法，如果是，则调用用户自定义拦截器的intercept()方法，并把目标方法信息封装成Invocation对象作为intercept()方法的参数。

Plugin类中还提供了一个静态的wrap()方法，该方法用于简化动态代理对象的创建，代码如下：

  public static Object wrap(Object target, Interceptor interceptor) {
    // 调用getSignatureMap()方法获取自定义插件中，通过Intercepts注解指定的方法
    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;
  }

如上面的代码所示，wrap()方法的第一个参数为目标对象，即Executor、ParameterHandler、ResultSetHandler、StatementHandler类的实例；第二个参数为拦截器实例。在wrap()方法中首先调用getSignatureMap()方法获取Intercepts注解指定的要拦截的组件及方法，然后调用getAllInterfaces()方法获取当前Intercepts注解指定要拦截的组件的接口信息，接着调用Proxy类的静态方法newProxyInstance()创建一个动态代理对象。

Intercepts注解用于修饰拦截器类，告诉拦截器要对哪些组件的方法进行拦截。下面是Intercepts注解的一个使用案例：

如上面的代码所示，通过Intercepts注解指定拦截ResultHandler组件的query()方法，同时拦截StatementHandler组件的prepare()方法。接下来我们就来了解一下Plugin类的getSignatureMap()方法解析Intercepts注解的过程，代码如下：

  private static Map<Class<?>, Set<Method>> getSignatureMap(Interceptor interceptor) {
    // 获取制定拦截器的Intercepts注解信息
    Intercepts interceptsAnnotation = interceptor.getClass().getAnnotation(Intercepts.class);
    // issue #251
    if (interceptsAnnotation == null) {
      throw new PluginException("No @Intercepts annotation was found in interceptor " + interceptor.getClass().getName());
    }

    // 获取所有Signature注解信息
    Signature[] sigs = interceptsAnnotation.value();
    Map<Class<?>, Set<Method>> signatureMap = new HashMap<>();

    // 对所有Signature注解进行遍历，把Signature注解指定拦截器的组件及方法添加到Map中
    for (Signature sig : sigs) {
      Set<Method> methods = MapUtil.computeIfAbsent(signatureMap, sig.type(), k -> new HashSet<>());
      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;
  }

如上面的代码所示，在Plugin类的getSignatureMap()方法中，首先获取Intercepts注解，然后获取Intercepts注解中配置的所有Signature注解，接着对所有的Signature注解信息进行遍历，将Signature注解中指定要拦截的组件及方法添加到Map对象中，其中Key为Executor、ParameterHandler、ResultSetHandler或StatementHandler对应的Class对象，Value为拦截的所有方法对应的Method对象数组。

当我们需要自定义一个MyBatis插件时，只需要实现Interceptor接口，在intercept()方法中编写拦截逻辑，通过plugin()方法返回一个动态代理对象，通过setProperties()方法设置<plugin>标签中配置的属性值即可。MyBatis源码中提供了一个自定义插件案例，代码如下：

@Intercepts({})
public class ExamplePlugin implements Interceptor {
  private Properties properties;

  @Override
  public Object intercept(Invocation invocation) throws Throwable {
    // TODO: 自定义拦截逻辑
    return invocation.proceed();
  }

  @Override
  public Object plugin(Object target) {
    // 调用Plugin类的wrap()方法返回一个动态代理对象
    return Plugin.wrap(target, this);
  }

  @Override
  public void setProperties(Properties properties) {
    // 设置插件的属性信息
    this.properties = properties;
  }

  public Properties getProperties() {
    return properties;
  }

}

如上面的代码所示，由于MyBatis提供了Plugin工具类用于创建拦截目标的代理对象，因此我们只需要在plugin()方法中调用Plugin.wrap()方法创建一个代理对象并返回即可。

最后，我们再来回顾MyBatis插件的工作原理。以执行一个查询操作为例，通过前面章节的介绍，我们知道SqlSession是MyBatis中提供的面向用户的操作数据库的接口，而真正执行SQL操作的是Executor组件。MyBatis通过工厂模式创建Executor实例，Configuration类中提供了一个newExecutor()工厂方法，该方法返回的实际上是一个Executor的动态代理对象。

上图是动态代理对象创建过程，SqlSession获取Executor实例的过程如下：

SqlSession中会调用Configuration类提供的newExecutor()工厂方法创建Executor对象。
Configuration类中通过一个InterceptorChain对象维护了用户自定义的拦截器链。newExecutor()工厂方法中调用InterceptorChain对象的pluginAll()方法。
InterceptorChain对象的pluginAll()方法中会调用自定义拦截器的plugin()方法。
自定义拦截器的plugin()方法是由我们来编写的，通常会调用Plugin类的wrap()静态方法创建一个代理对象。

SqlSession获取到的Executor实例实际上已经是一个动态代理对象了。接下来我们就以SqlSession执行查询操作为例介绍自定义插件执行拦截逻辑的过程。

上图是插件拦截逻辑执行过程，当我们调用SqlSession对象的selectOne()方法执行查询操作时，大致会经历下面几个过程：

SqlSession操作数据库需要依赖于Executor组件，SqlSession会调用Configuration对象的newExecutor()方法获取Executor的实例。
SqlSession获取到的是Executor组件的代理对象，执行查询操作时会调用代理对象的query()方法。
按照JDK动态代理机制，调用Executor代理对象的query()方法时，会调用Plugin类的invoke()方法。
Plugin类的invoke()方法中会调用自定义拦截器对象的intercept()方法执行拦截逻辑。
自定义拦截器对象的intercept()方法调用完毕后，调用目标Executor对象的query()方法。
所有操作执行完毕后，会将查询结果返回给SqlSession对象。

自定义慢SQL统计插件

本节我们来编写一个统计慢SQL插件。通过该插件，我们可以把执行时间超过若干秒的SQL语句输出到日志中，这样就可以有针对性地对SQL语句进行优化。该插件代码如下：

如上面的代码所示，在SlowSqlInterceptor拦截器类中，我们使用Intercepts注解指定对StatementHandler组件的query()、update()、batch()方法进行拦截，这些方法调用之前会调用SlowSqlInterceptor对象的intercept()方法中的拦截逻辑。

SlowSqlInterceptor对象实例化后，会调用setProperties()方法设置<plugin>标签中配置的属性，这里我们通过limitSecond属性指定SQL执行时间超过多少秒被定义为慢SQL。在SlowSqlInterceptor类的intercept()方法中，首先获取SQL语句执行前的时间戳，然后计算SQL执行后的消耗时长，如果时长超过我们通过limitSecond属性指定的时长，则调用getFormatedSql()方法对执行的SQL进行参数占位符替换及格式化，然后将处理后的SQL输出。该插件出于演示目的，只是将SQL语句输出到控制台，实际项目中，可以输出到一个单独的日志文件中。

最后，我们再来看一下SlowSqlInterceptor插件的使用，在MyBatis主配置文件中注册该插件即可，配置如下：

学海_无涯_苦作舟

关注

1
点赞
踩
1

收藏

觉得还不错? 一键收藏
0
评论
MyBatis——插件原理及应用

MyBatis框架允许用户通过自定义拦截器的方式改变SQL的执行行为，例如在SQL执行时追加SQL分页语法，从而达到简化分页查询的目的。用户自定义的拦截器也被称为MyBatis插件，本章我们就来分析一下MyBatis插件的实现原理以及如何开发一个插件。
复制链接

扫一扫