一、概述

在Mybatis中从sql的解析到最后结果集的返回，经过了⼀系列的内部组件，⽐如执行器(Executor)，语句处理器(StatementHandler)，参数处理器(ParameterHandler)，结果集处理器(ResultSetHandler)等。

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

若开发者需要实现比如sql自动优化、参数类型的转换、数据分页功能、打印执⾏语句、统计查询时间等功能都可以通过Mybatis提供的Plugin机制实现，也就是通过拦截上述SqlSession 四大对象中的方法，对执⾏的特定环节进⾏特定处理。

具体实现使用到了责任链和代理的设计模式：

行为型：观察者模式、模板模式、策略模式、 $\color{#FF0000}{职责链模式}$ (Chain of Responsibility Pattern) 、迭代器模式、状态模式、访问者模式、备忘录模式、命令模式、解释器模式、中介模式。
结构型：组合模式、外观模式、 $\color{#FF0000}{代理模式}$ (Proxy Pattern) 、适配器模式、装饰模式、桥模式、享元模式。

二、实现原理

1、添加插件成链
mybatis配置【sqlSessionFactory.getConfiguration()】初始化时，将具体的实现类通过【InterceptorChain.addInterceptor】添加到责任链中。 $\color{#FF0000}{职责链模式}$

添加插件

2、生成Plugin代理对象
当mybatis初始化资源【Configuration】时，会调⽤【InterceptorChain.pluginAll】通过代理的⽅式，将所有的插件通过逐层代理的⽅式，将内部核⼼组件(⽐如Executor)包裹返回⼀个代理对象【Plugin对象】。 $\color{#FF0000}{代理模式}$

public class InterceptorChain {

  /**
   * 拦截器列表
   */
  private final List<Interceptor> interceptors = new ArrayList<>();

  /**
   * 返回插件的代理对象
   */
  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);
  }
}

3、执行代理对象
真正执⾏的地⽅是由于将内部核⼼组件都包装成了代理类，所以在调⽤执⾏⽅法时，会被代理对象拦截进⼊⽅法，根据执⾏⽅法所属invoke类以及注解等判断是否执⾏拦截器或者是执⾏原⽅法，如下：

public class Plugin implements InvocationHandler {

 @Override
 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)) {//如果当前方法需要被拦截，则调用interceptor.intercept方法进行拦截处理
       //自己重写的intercept方法，就是在这里被调用
       return interceptor.intercept(new Invocation(target, method, args));
     }
     //如果当前方法不需要被拦截，则调用对象自身的方法
     return method.invoke(target, args);
   } catch (Exception e) {
     throw ExceptionUtil.unwrapThrowable(e);
   }
 }
//省略
}

三、实现示例

这里展示的是官方简单的插件示例，也可以去看PageHelper的实现。
通过 MyBatis 提供的强大机制，使用插件是非常简单的，只需实现 Interceptor 接口，并指定想要拦截的方法签名即可。示例插件将会拦截在 Executor 实例中所有的 “update” 方法调用，这里的 Executor 是负责执行底层映射语句的内部对象。

// ExamplePlugin.java
@Intercepts({@Signature(
  type= Executor.class,
  method = "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;
  }
}

开启当前插件功能方法是在mybatis-config.xml配置plugin，或者将自定义的Interceptor注册为Bean。

参考：

https://mybatis.org/mybatis-3/zh/configuration.html#plugins
https://github.com/pagehelper/Mybatis-PageHelper/blob/master/wikis/zh/Interceptor.md

Mybatis Plugin实现原理之责任链和代理模式

Mybatis Plugin实现原理之责任链和代理模式

一、概述

二、实现原理

三、实现示例

参考：