【MyBatis】插件原理（一）：如何实现一个插件

你的名字 2023-01-18 04:10 189阅读 0赞

MyBatis 通过提供插件机制，让我们可以根据自己的需要去增强 MyBatis 的功能。下面来看 [MyBatis 官网][MyBatis] 对插件的描述：

MyBatis 允许你在映射语句执行过程中的某一点进行拦截调用。默认情况下，MyBatis 允许使用插件来拦截的方法调用包括：

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

我们应该了解 MyBatis 允许哪些对象的哪些方法允许被拦截，并不是每一个运行的节点都是可以被修改的。只有清楚了这些对象的方法的作用，当我们自己编写插件的时候才知道从哪里去拦截。

通过 MyBatis 提供的强大机制，使用插件是非常简单的，只需实现 Interceptor 接口，并指定想要拦截的方法签名即可。下面来看个例子…

### 1.编写插件 ###

编写插件类，实现 Interceptor 接口，添加 @Intercepts 注解

Interceptor 接口是所有的插件必须实现的接口，方法如下：

public interface Interceptor {
        
    	
      // 用于覆盖被拦截对象的原有方法（在调用代理对象 Plugin 的 invoke() 方法时被调用
      Object intercept(Invocation invocation) throws Throwable;
      // target 是被拦截对象，这个方法的作用是给被拦截对象生成一个代理对象，并返回它
      Object plugin(Object target);
      // 可以对插件设置的参数
      void setProperties(Properties properties);
    }

而添加@Intercepts(\{@Signature()\}) 是为了指定拦截的对象和方法，方法参数

> PS：方法名称+参数类型，构成了方法的签名，决定了能够拦截到哪个方法

下面是个具体的例子：

@Intercepts({
        @Signature(
      type= Executor.class, // 拦截的顶层的 Executor 对象
      method = "update", 	// 拦截 update 方法
      args = {
        MappedStatement.class,Object.class})})
    public class ExamplePlugin implements Interceptor {
        
    
      private Properties properties = new Properties();
      
      public Object intercept(Invocation invocation) throws Throwable {
        
        // implement pre processing if need
        Object returnObject = invocation.proceed();
        // implement post processing if need
        return returnObject;
      }
      
      public void setProperties(Properties properties) {
        
        this.properties = properties;
      }
    }

上面的插件将会拦截在 Executor 实例中所有的 “update” 方法调用， 这里的 Executor 是负责执行底层映射语句的内部对象。

### 2.注册插件 ###

<plugins>
      <plugin interceptor="org.mybatis.example.ExamplePlugin">
        <property name="someProperty" value="100"/>
      </plugin>
    </plugins>

MyBatis 启动时会扫描`<plugins>`标签， 注册到 Configuration 对象的 InterceptorChain 中。property 里面的参数，会调用 setProperties() 方法处理。最终保存在 Configuration 类的 InterceptorChain 中

![在这里插入图片描述][20210504214457970.png_pic_center]

我们打开 InterceptorChain 可以看到，它实际是封装了一个 List

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzkzNTkyNw_size_16_color_FFFFFF_t_70_pic_center]

> PS：关于 MyBatis 插件原理，请看[下一篇文章][Link 1]…

[MyBatis]: https://mybatis.org/mybatis-3/zh/configuration.html#plugins
[20210504214457970.png_pic_center]: /images/20221021/8a8ee323897d4db397dd4ad4dadfc26a.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzkzNTkyNw_size_16_color_FFFFFF_t_70_pic_center]: /images/20221021/cfea812da5b142f1b72f8270fdab86ed.png
[Link 1]: https://blog.csdn.net/weixin_43935927/article/details/111399700