myabtis 中简述 MyBatis 的插件运行原理，以及如何编写一个插件

有的时候博客内容会有变动，首发博客是最新的，其他博客地址可能会未同步, 认准 https://blog.zysicyj.top

全网最细面试题手册，支持艾宾浩斯记忆法。这是一份最全面、最详细、最高质量的 java 面试题，不建议你死记硬背，只要每天复习一遍，有个大概印象就行了。https://store.amazingmemo.com/chapterDetail/1685324709017001`

MyBatis 插件运行原理

MyBatis 插件是基于拦截器（Interceptor）模式实现的，允许用户在指定的点进行切入，以增强或改变 MyBatis 原有的功能。

原理概述：

MyBatis 允许你在某些点进行拦截：

  • 执行方法前后
  • 修改方法的执行结果
  • 修改方法本身

其核心运行原理可以概括为以下几点：

  1. 拦截点识别： MyBatis 通过 插件签名 识别插件需要拦截的接口方法。这些签名定义了可拦截的 MyBatis 核心类的方法。
  2. 动态代理： MyBatis 使用 JDK 动态代理或 CGLIB 为目标对象创建代理。当执行目标方法时，将触发代理逻辑。
  3. 插件链： 插件可以形成一个链式结构，按顺序执行，这通过在 Plugin#wrap 调用中连续应用多个插件来实现。
  4. 拦截器调用： 当执行被代理对象的方法时，会先调用拦截器的 intercept 方法，允许你在这个方法中增加你的逻辑。

基于上述原理，MyBatis 插件机制就可以修改 MyBatis 核心类的行为。

如何编写一个 MyBatis 插件

要编写 MyBatis 插件，需要遵循以下步骤：

  1. 实现 Interceptor 接口：

    插件需要实现 org.apache.ibatis.plugin.Interceptor 接口，该接口具有三个方法：

    • intercept(Invocation invocation): 实际拦截处理逻辑的方法。
    • plugin(Object target): 用来判断是否要拦截该对象，并返回它的代理对象。
    • setProperties(Properties properties): 插件初始化时调用，用于传递插件配置的属性。

  2. 使用 @Intercepts 注解指定拦截的方法：

    示例代码：

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    @Intercepts({
      @Signature(
        type = Executor.class,
        method = "update",
        args = {MappedStatement.class, Object.class}
      )
    })
    public class MyPlugin implements Interceptor {
      ...
    }

  3. 实现拦截逻辑：

    在 intercept 方法中，编写你想要实现的增强逻辑。

    示例代码：

    1
    2
    3
    4
    5
    6
    7
    @Override
    public Object intercept(Invocation invocation) throws Throwable {
      // 在目标方法被执行前可以加入自己的逻辑
      Object result = invocation.proceed(); // 执行目标方法
      // 在目标方法被执行后也可以加入自己的逻辑
      return result;
    }

  4. 在 MyBatis 配置文件中注册插件：

    最后，在 mybatis-config.xml 配置文件中添加插件配置：

    1
    2
    3
    4
    5
    <plugins>
      <plugin interceptor=" 全限定类名 ">
        <!-- 可以添加插件属性配置 -->
      </plugin>
    </plugins>

通过遵循以上步骤，你可以编写并注册自己的 MyBatis 插件，从而改变 MyBatis 的默认行为或增强其功能。