MyBatis-Plugin源码全面分析

三、MyBatis-Plugin

1. 基本开发方式

需求：在MyBatis执行之前打印一行醒目的日志，携带参数

实现Interceptor接口：

@Intercepts(@Signature(type = Executor.class,method = "query",args = {MappedStatement.class,Object.class, RowBounds.class, ResultHandler.class}))
public class MyPlugin implements Interceptor {
  private  String param;
  @Override
  public Object intercept(Invocation invocation) throws Throwable {

    System.out.println("====================================="+param+"===================================");
    // 继续执行原始的 SQL 逻辑
    return invocation.proceed();
  }

  @Override
  public Object plugin(Object target) {
    return Interceptor.super.plugin(target);
  }

  @Override
  public void setProperties(Properties properties) {
    this.param = properties.getProperty("log");
  }
}

修改配置：

    <plugins>
        <plugin interceptor="com.mybatis.study.plugin.MyPlugin">
            <property name="log" value="wz-MyBatis"/>
        </plugin>
    </plugins>

image-20230626091650816

2. Plugin机制与源码

Mybatis插件又称拦截器，Mybatis采用责任链模式，通过动态代理组织多个插件（拦截器），通过这些插件可以改变Mybatis的默认行为（诸如SQL重写之类的），MyBatis 允许你在已映射语句执行过程中的某一点进行拦截调用。默认情况下，MyBatis 允许使用插件来拦截的方法调用包括：

//拦截执行器中的方法
Executor (update, query, flushStatements, commit, rollback, getTransaction, close, isClosed)

//拦截对参数的处理
ParameterHandler (getParameterObject, setParameters)

//拦截对结果集的处理
ResultSetHandler (handleResultSets, handleOutputParameters)

//拦截SQL构建的处理
StatementHandler (prepare, parameterize, batch, update, query)

2.1 Plugin创建时机

Plugin的创建我们可以追溯到xml的解析，XMLConfigBuilder类中：

private void parseConfiguration(XNode root) {
    try {
      propertiesElement(root.evalNode("properties"));
      Properties settings = settingsAsProperties(root.evalNode("settings"));
      loadCustomVfs(settings);
      loadCustomLogImpl(settings);
      typeAliasesElement(root.evalNode("typeAliases"));
       //解析插件
      pluginElement(root.evalNode("plugins"));
      objectFactoryElement(root.evalNode("objectFactory"));
      objectWrapperFactoryElement(root.evalNode("objectWrapperFactory"));
      reflectorFactoryElement(root.evalNode("reflectorFactory"));
      settingsElement(settings);
      environmentsElement(root.evalNode("environments"));
      databaseIdProviderElement(root.evalNode("databaseIdProvider"));
      typeHandlerElement(root.evalNode("typeHandlers"));
      mapperElement(root.evalNode("mappers"));
    } catch (Exception e) {
      throw new BuilderException("Error parsing SQL Mapper Configuration. Cause: " + e, e);
    }
  }

如果获取到plugins节点，就遍历plugins创建plugin拦截器：

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).getDeclaredConstructor().newInstance();
        interceptorInstance.setProperties(properties);
         //加入到责任链
        configuration.addInterceptor(interceptorInstance);
      }
    }
  }

  public void addInterceptor(Interceptor interceptor) {
     //加入到责任链中
    interceptorChain.addInterceptor(interceptor);
  }

2.2 Plugin的使用时机

将插件逻辑植入到Executor是发生在InterceptorChain的pluginAll() 方法中。如果在MyBatis的配置文件中配置了插件，那么配置的插件会在加载配置文件的时候被解析成拦截器Interceptor并添加到Configuration的InterceptorChain中。

下面是Executor的创建源码：

  public Executor newExecutor(Transaction transaction, ExecutorType executorType) {
    executorType = executorType == null ? defaultExecutorType : 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中
    return (Executor) interceptorChain.pluginAll(executor);
  }

PS：插件的应用位置不同，作用地点也不同：

image-20230626103731719

我们发现，interceptorChain（拦截器链）在Plugin的创建和应用上都起了关键作用，下面来分析一下源码：

public class InterceptorChain {

  /**
   * 用于存储拦截器对象的列表
   */
  private final List<Interceptor> interceptors = new ArrayList<>();


  /**
   * 用于对目标对象应用所有的拦截器
   * @param target 目标对象
   * @return 处理后的目标对象
   */
  public Object pluginAll(Object target) {
    //遍历拦截器列表，一次对目标对象应用每一个拦截器的plugin方法
    for (Interceptor interceptor : interceptors) {
      target = interceptor.plugin(target);
    }
    return target;
  }

  /**
   * 向拦截器列表中添加一个拦截器
   * @param interceptor 拦截器
   */
  public void addInterceptor(Interceptor interceptor) {
    interceptors.add(interceptor);
  }

  /**
   * 返回拦截器列表的不可变列表，防止外部修改，保证列表的不可变
   * @return 不可变列表
   */
  public List<Interceptor> getInterceptors() {
    return Collections.unmodifiableList(interceptors);
  }

}

2.3 核心类源码分析

分析了Plugin的创建于使用时机，我们可以清楚的知道，当我们自定义一个拦截器的时候，会将其加入到拦截器链，并执行plugin方法，下面再来看看plugin方法：

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

进入到Plugin.wrap静态方法中，该方法的核心作用是：对目标方法进行包装，返回一个代理对象来实现拦截器的功能

  /**
   * 返回代理对象，该代理对象实现了目标对象的接口，并在方法调用时应用拦截器的逻辑（典型的代理设计模式）
   * @param target 目标对象
   * @param interceptor 拦截器
   * @return 代理对象
   */
  public static Object wrap(Object target, Interceptor interceptor) {
    //根据拦截器对象生成一个签名映射表，签名映射表将拦截器中定义的拦截方法按照类和方法进行组织，以便快速查找对应的拦截方法
    // 将插件的@Signature注解内容获取出来并生成映射结构
    Map<Class<?>, Set<Method>> signatureMap = getSignatureMap(interceptor);
    //获取目标对象的类型
    Class<?> type = target.getClass();
    //根据目标对象的类型和签名映射表获取所有需要被代理的接口
    Class<?>[] interfaces = getAllInterfaces(type, signatureMap);
    if (interfaces.length > 0) {
      //为需要被代理的几口创建代理对象。代理方法的调用将被转发到Plugin的实例对象上，Plugin类实现了InvocationHandler接口，负责处理拦截逻辑的执行。
      return Proxy.newProxyInstance(type.getClassLoader(), interfaces, new Plugin(target, interceptor, signatureMap));
    }
    //返回目标对象
    return target;
  }

下面来看看代理对象的创建逻辑与代理对象中的额外方法都做了什么？从上面创建代理的方法我们可以知道，使用了JDK的动态代理(Proxy.newProxyIntance(ClassLoader,Interface,InvocationHandler）)，Plugin类实现了InvocationHandler接口，所以代理的额外方法在invoke中：

  @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)) {
        //如果方法集合不为空并且包含正在调用的方法，则执行以下代码块。这个判断确保只有在目标对象需要被拦截的方法上才会执行拦截逻辑
        //创建 Invocation 对象，传入目标对象、正在调用的方法和方法参数，作为拦截器的调用参数。
        //调用拦截器的 intercept 方法，将 Invocation 对象传入进行拦截逻辑的执行。
        return interceptor.intercept(new Invocation(target, method, args));
      }
      //使用反射调用 method.invoke 方法来执行目标对象的方法。
      return method.invoke(target, args);
    } catch (Exception e) {
      throw ExceptionUtil.unwrapThrowable(e);
    }
  }

下面我们来看看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的proceed() 方法可以执行被插件作用的方法。所以插件可以在其实现的intercept() 方法中通过Invocation获取到插件作用目标的完整信息，也可以通过Invocation的proceed() 方法运行作用目标的原本逻辑。

最后在看一下拦截器的接口：

public interface Interceptor {

  /**
   * 拦截器在此方法中可以对目标对象的方法进行拦截和修改。
   * @param invocation 封装了目标对象的信息
   * @return 处理后的目标对象
   */
  Object intercept(Invocation invocation) throws Throwable;

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

  /**
   * 接收参数
   * @param properties 配置信息
   */
  default void setProperties(Properties properties) {
    // NOP
  }

}

到这里，对于Plugin的创建及使用核心原理应该都已经掌握，那么思考一下，如果是(对同一个组件的)多个插件，如何决定插件的执行顺序呢？

如果定义了多个插件，那么会根据插件在MyBatis配置文件中的声明顺序，一层一层的生成代理对象，比如如下的配置中，先后声明了两个插件。

<plugins>
    <plugin intercepter="插件1"></plugin>
    <plugin intercepter="插件2"></plugin>
</plugins>

那么生成的代理对象可以用下图进行示意。

插件的执行顺序

即为四大对象植入插件逻辑时，是根据声明插件时的顺序从里向外一层一层的生成代理对象，反过来四大对象实际运行时，是从外向里一层一层的调用插件的逻辑。

2.4 Debug 验证

经过上面的源码分析，下面我们来验证一下，首先创建两个插件。最开始我们创建了一个打印日志的插件，下面再创建一个打印参数的插件：

@Intercepts({
  @Signature(
    type = StatementHandler.class,
    method = "prepare",
    args = {Connection.class, Integer.class}
  )
})
public class ParamPlugin implements Interceptor {
  @Override
  public Object intercept(Invocation invocation) throws Throwable {
    MetaObject metaObject = SystemMetaObject.forObject(invocation);
    Object value = metaObject.getValue("target.delegate.parameterHandler.parameterObject");
    System.out.println("拦截到 prepare 方法，并打印参数：" + value.toString());
    return invocation.proceed();
  }
}

并将其在配置文件中注册：

    <plugins>
        <plugin interceptor="com.mybatis.study.plugin.MyPlugin">
            <property name="log" value="wz-MyBatis"/>
        </plugin>
        <plugin interceptor="com.mybatis.study.plugin.ParamPlugin">

        </plugin>
    </plugins>

下面开始Debug，首先从创建开始：

img

遍历完之后，可以看到拦截链中已经存在：

image-20230626103356679

之后，我们再到pluginAll打一个断点，观察到四大组件创建都会进入这里：

image-20230626104454586

拿到目标对象后，下面进入plugin方法，再进入wrap方法：

这里会判断是不是需要被代理的接口：如果不是(这里paramPlugin插件拦截的是StatementHandler所以不会进入if)就直接return。

image-20230626104845380

如果需要被代理：则创建代理对象

image-20230626105226969

代理对象处理逻辑：

进入intercept方法，可以看到进入了我们自定义的插件中：

image-20230626105941308

到此为止，插件的执行与应用流程就分析完毕了。多个插件会继续从pluginAll中进入循环。

2.5 Plugin机制原理总结

Application XMLConfigBuilder Configuration InterceptorChain Plugin Invocation Interceptor 加载 MyBatis 配置,遍历plugin标签 创建拦截器对象 添加拦截器到拦截链中 创建四大组件时调用pluginAll() 遍历拦截器列表，对目标方法执行plugin方法 wrap()对目标方法包装返回代理对象 封装Invocation 执行intercept方法 loop [执行invoke方法] 返回处理后的对象wrap方法 返回给plugin方法 pluginAll loop [继续遍历其它拦截器] Application XMLConfigBuilder Configuration InterceptorChain Plugin Invocation Interceptor

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：/a/73638.html

如若内容造成侵权/违法违规/事实不符，请联系我们进行投诉反馈qq邮箱809451989@qq.com，一经查实，立即删除！

相关文章

600 V单管IGBT，可在电源应用中实现出色效率

600 V单管IGBT，可在电源应用中实现出色效率

基础半导体器件领域的高产能生产专家Nexperia (安世半导体)今日宣布&#xff0c;将凭借600 V器件系列进军绝缘栅双极晶体管(IGBT)市场&#xff0c;而30A NGW30T60M3DF将打响进军市场的第一炮。Nexperia在其庞大的产品组合中增加了IGBT&#xff0c;满足了市场对于高效高压开关器…
阅读更多...
多个项目使用的node版本不一致？vscode dev container + docker 真香

多个项目使用的node版本不一致？vscode dev container + docker 真香

一、接手的项目多了&#xff0c;什么node版本都有~ 遇到这种情况&#xff0c;多数情况会使用 nvm 进行 node 版本管理&#xff0c;具体使用方法可戳nvm的安装与使用。但若要并行开发两个不同环境下的项目&#xff0c;不停切换node版本&#xff0c;也难免有些繁琐。此时&#xf…
阅读更多...
HCIP学习--BGP3

HCIP学习--BGP3

目录 前置内容 BGP下一跳的修改问题 BGP的属性 配置 PrefVal权重属性 负载分担 LocPrf 负载分担 NextHop AS-PATH Ogn 配置 MED 配置 BGP选路规则 BGP的社团属性 配置及解释 前置内容 HCIP学习--BGP1_板栗妖怪的博客-CSDN博客 HCIP学习--BGP2_板栗妖怪的博客…
阅读更多...
【LVS-NAT配置】

【LVS-NAT配置】

配置 node1&#xff1a;128&#xff08;客户端&#xff09; node2&#xff1a;135&#xff08;调度器&#xff09; RS&#xff1a; node3&#xff1a;130 node4&#xff1a;132 node2添加网络适配器&#xff08;仅主机模式&#xff09; [rootnode2 ~]# nmtui[rootnode2 ~]#…
阅读更多...
利用 Splashtop Enterprise 改善公司的网络安全

利用 Splashtop Enterprise 改善公司的网络安全

在我们日益数字化的世界中&#xff0c;对强有力的网络安全措施的需求从未像现在这样迫切。随着组织扩大其数字足迹并采用远程办公解决方案&#xff0c;他们面临着一系列不断变化的挑战。 威胁行为者不断寻找利用漏洞的新方法&#xff0c;这使得企业保持领先地位至关重要。俗话…
阅读更多...
Spring Boot实现第一次启动时自动初始化数据库流程详解

Spring Boot实现第一次启动时自动初始化数据库流程详解

随着互联网的发展项目中的业务功能越来越复杂&#xff0c;有一些基础服务我们不可避免的会去调用一些第三方的接口或者公司内其他项目中提供的服务&#xff0c;但是远程服务的健壮性和网络稳定性都是不可控因素。 在测试阶段可能没有什么异常情况&#xff0c;但上线后可能会出…
阅读更多...
HCIP BGP小综合

HCIP BGP小综合

BGP小综合 AS配置AS1AS2 中的小自治系统64512AS2 中的小自治系统64513AS3 测试 首先该实验分成三个AS&#xff0c;AS2里面有联邦&#xff0c;所以配置顺序 要先将IBGP通&#xff0c;然后配置AS1,AS3和联邦 AS配置 AS1 R1 # bgp 1router-id 1.1.1.1peer 12.1.1.2 as-number …
阅读更多...
计算机设计大赛国赛一等奖项目分享——基于多端融合的化工安全生产监管可视化系统

计算机设计大赛国赛一等奖项目分享——基于多端融合的化工安全生产监管可视化系统

文章目录 一、计算机设计大赛国赛一等奖二、项目背景三、项目简介四、系统架构五、系统功能结构六、项目特色&#xff08;1&#xff09;多端融合&#xff08;2&#xff09;数据可视化&#xff08;3&#xff09;计算机视觉&#xff08;目标检测&#xff09; 七、系统界面设计&am…
阅读更多...
MySQL8安装和删除教程 保姆级(Windows)

MySQL8安装和删除教程 保姆级(Windows)

下载 官网: mysql官网点击Downloads->MySQL Community(GPL) Downloads->MySQL Community Server(或者点击MySQL installer for Windows) Windows下有两种安装方式 在线安装 一般带有 web字样 这个需要联网离线安装 一般没有web字样 安装 下载好之后,版本号可以不一样&…
阅读更多...
超好用的接口自动化框架，lemon-easytest内测版发布，赶紧用起来~

超好用的接口自动化框架，lemon-easytest内测版发布，赶紧用起来~

easytest easytest 是一个接口自动化框架。 功能特点&#xff1a; 支持 http 接口测试 支持 json&#xff0c;html,xml 格式的响应断言 支持数据库断言 支持用例标记筛选 支持用例失败重运行 支持多线程 安装 pip install lemon_easytest 快速使用 不需要写任何代码…
阅读更多...
k8s常用资源管理 控制

k8s常用资源管理 控制

目录 Pod&#xff08;容器组&#xff09;&#xff1a;Pod是Kubernetes中最小的部署单元&#xff0c;可以包含一个或多个容器。Pod提供了一种逻辑上的封装&#xff0c;使得容器可以一起共享网络和存储资源 1、创建一个pod 2、pod管理 pod操作 目录 创建Pod会很慢 Pod&…
阅读更多...
腾讯云轻量应用服务器搭建WordPress网站教程

腾讯云轻量应用服务器搭建WordPress网站教程

腾讯云百科分享使用腾讯云轻量应用服务器搭建WordPress网站教程流程&#xff0c;WordPress 是全球最流行的开源的博客和内容管理网站的建站平台&#xff0c;具备使用简单、功能强大、灵活可扩展的特点&#xff0c;提供丰富的主题插件。腾讯云轻量应用服务器提供 WordPress 应用…
阅读更多...
打破传统直播，最新数字化升级3DVR全景直播

打破传统直播，最新数字化升级3DVR全景直播

导语&#xff1a; 近年来&#xff0c;随着科技的不断创新和发展&#xff0c;传媒领域也正经历着一场前所未有的变革。在这个数字化时代&#xff0c;直播已经不再仅仅是在屏幕上看到一些人的视频&#xff0c;而是将观众带入一个真实世界的全新体验。其中&#xff0c;3DVR全景直…
阅读更多...
ARMday2

ARMday2

.text .global _start _start:mov r0,#0x1mov r1,#0x0sum:cmp r0,#0x64bhi stopaddls r1,r1,r0addls r0,r0,#0x1bls sumstop:b stop .end
阅读更多...
Opencv将数据保存到xml、yaml / 从xml、yaml读取数据

Opencv将数据保存到xml、yaml / 从xml、yaml读取数据

Opencv将数据保存到xml、yaml / 从xml、yaml读取数据 Opencv提供了读写xml、yaml的类实现&#xff1a; 本文重点参考&#xff1a;https://blog.csdn.net/cd_yourheart/article/details/122705776?spm1001.2014.3001.5506&#xff0c;并将给出文件读写的具体使用实例。 1. 官…
阅读更多...
STM32基于CubeIDE和HAL库 基础入门学习笔记：物联网项目开发流程和思路

STM32基于CubeIDE和HAL库 基础入门学习笔记：物联网项目开发流程和思路

文章目录&#xff1a; 第一部分&#xff1a;项目开始前的计划与准备 1.项目策划和开发规范 1.1 项目要求文档 1.2 技术实现文档 1.3 开发规范 2.创建项目工程与日志 第二部分&#xff1a;调通硬件电路与驱动程序 第三部分&#xff1a;编写最基础的应用程序 第四部分&…
阅读更多...
我们常说这个pycharm里有陷阱，第三方库导入失败，看这里！

我们常说这个pycharm里有陷阱，第三方库导入失败，看这里！

最近有小伙伴遇到了明明安装了 python 第三方库&#xff0c;但是在 pycharm 当中却导入不成功的问题。 ​ 一直以来&#xff0c;也有不少初学 python 的小伙伴&#xff0c;一不小心就跳进了虚拟环境和系统环境的【陷阱】中。 本文就基于此问题&#xff0c;来说说在 pycharm 当…
阅读更多...
前端:Vue.js学习

前端:Vue.js学习

前端:Vue.js学习 1. 第一个Vue程序2. Vue指令2.1 v-if、v-else-if、v-else2.2 v-for2.3 事件绑定 v-on:2.4 v-model 数据双向绑定2.5 v-bind 绑定属性 3. Vue组件4. Vue axios异步通信5. 计算属性6. 插槽 slots7. 自定义事件内容分发 1. 第一个Vue程序 首先把vue.js拷贝到本地…
阅读更多...
【Linux进程篇】环境变量

【Linux进程篇】环境变量

【Linux进程篇】环境变量 目录 【Linux进程篇】环境变量基本概念常见环境变量查看环境变量方法测试PATH测试HOME测试SHELL和环境变量相关的命令环境变量的组织方式通过代码如何获取环境变量命令行参数命令行第三个参数通过第三方变量environ获取 本地变量通过系统调用获取或设置…
阅读更多...
打造专属企业展示小程序

打造专属企业展示小程序

在当今的数字化时代&#xff0c;企业展示小程序已经成为了推广企业形象和吸引客户的重要工具。而如何打造一个专属的企业展示小程序呢&#xff1f;下面将带您一步步操作&#xff0c;通过乔拓云网来实现这一目标。 首先&#xff0c;您需要注册登录乔拓云网并进入操作后台。在乔拓…
阅读更多...
最新文章

Copyright @ 2022~2023