Java MyBatis 插件原理怎么基于 Interceptor 接口实现

风晨酱_7423

风晨酱_7423

2026-09-02

893人浏览

原创

mybatis插件机制基于jdk动态代理与责任链模式,interceptor为统一入口;通过@intercepts声明拦截点,plugin()包装目标对象,intercept()执行增强逻辑,四大核心对象创建时被逐层代理。

java mybatis 插件原理怎么基于 interceptor 接口实现

MyBatis 插件机制本质是基于 JDK 动态代理 + 责任链模式,而 Interceptor 接口是整个机制的统一入口和契约规范。它不直接参与代理创建,而是通过约定好的方法签名,让 MyBatis 框架在关键对象(Executor、StatementHandler 等)初始化时自动织入拦截逻辑。

Interceptor 是插件的“行为协议”,不是代理本身

实现 Interceptor 接口只是告诉 MyBatis:“我有增强逻辑”。真正起作用的是框架调用其 plugin(Object target) 方法,把目标对象(比如 StatementHandler 实例)包装成代理对象。这个代理会在方法调用时触发 intercept(Invocation) —— 你写的业务逻辑就在这里执行。

  • intercept() 必须重写:所有拦截动作都放这里,比如改 SQL、记日志、统计耗时
  • plugin() 一般用默认实现:Plugin.wrap(target, this),它内部用 JDK Proxy 生成代理
  • setProperties() 用于接收配置项,比如分页插件读取 dialect=MySQL

拦截点由 @Intercepts + @Signature 显式声明

MyBatis 不会盲目拦截所有方法,而是严格按你在类上标注的 @Intercepts 注解来决定哪些对象、哪些方法需要被代理。例如:

  • @Signature(type = Executor.class, method = "query", args = {MappedStatement.class, Object.class, RowBounds.class, ResultHandler.class}) → 拦截查询执行
  • @Signature(type = StatementHandler.class, method = "prepare", args = {Connection.class, Integer.class}) → 拦截 SQL 准备阶段,适合重写 SQL 实现分页

多个 @Signature 可共存,一个插件能同时处理多个环节,比如既统计耗时又打印带参 SQL。

Alibabacloud Sdk Client Initialization For Java
Alibabacloud Sdk Client Initialization For Java

在 Java 中初始化和管理阿里云 SDK客户端。包括单例模式、线程安全、endpoint 与 region 配置、VPC 终端节点、同步与异步等。

下载

四大对象在创建时统一被插件链处理

MyBatis 启动时会构建四类核心对象:Executor、StatementHandler、ParameterHandler、ResultSetHandler。每个对象实例化后,都会经过 InterceptorChain.pluginAll(target) 流程:

  • 遍历所有已注册的 Interceptor
  • 依次调用它们的 plugin(target) 方法
  • 返回层层包装后的代理对象(责任链式嵌套)

最终 SqlSession 使用的,已经是被所有插件增强过的对象。执行 SQL 时,调用链会逐层触发各插件的 intercept(),顺序取决于注册顺序。

线程安全与上下文需自行保障

Interceptor 实例是单例的,intercept() 可能被多线程并发调用。因此:

  • 避免在插件中使用共享可变状态(如 static 成员变量)
  • 若需临时存储上下文(如记录某次查询的开始时间),推荐用 ThreadLocal
  • 获取当前 SQL、参数、连接等信息,要通过 Invocation 的 getTarget() 和类型判断,再反射或调用对应 getter(如 ((StatementHandler)target).getBoundSql())

Java免费学习笔记:立即使用
解锁 Java 大师之旅:从入门到精通的终极指南

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

java

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
java
java

Java是一个通用术语,用于表示Java软件及其组件,包括“Java运行时环境 (JRE)”、“Java虚拟机 (JVM)”以及“插件”。php中文网还为大家带了Java相关下载资源、相关课程以及相关文章等内容,供大家免费下载使用。

2023.06.15

9157

6

java正则表达式语法
java正则表达式语法

java正则表达式语法是一种模式匹配工具,它非常有用,可以在处理文本和字符串时快速地查找、替换、验证和提取特定的模式和数据。本专题提供java正则表达式语法的相关文章、下载和专题,供大家免费下载体验。

2023.07.05

6322

9

java自学难吗
java自学难吗

Java自学并不难。Java语言相对于其他一些编程语言而言,有着较为简洁和易读的语法,本专题为大家提供java自学难吗相关的文章,大家可以免费体验。

2023.07.31

5652

8

java配置jdk环境变量
java配置jdk环境变量

Java是一种广泛使用的高级编程语言,用于开发各种类型的应用程序。为了能够在计算机上正确运行和编译Java代码,需要正确配置Java Development Kit(JDK)环境变量。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.08.01

1004

3

java保留两位小数
java保留两位小数

Java是一种广泛应用于编程领域的高级编程语言。在Java中,保留两位小数是指在进行数值计算或输出时,限制小数部分只有两位有效数字,并将多余的位数进行四舍五入或截取。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.08.02

848

3

java基本数据类型
java基本数据类型

java基本数据类型有:1、byte;2、short;3、int;4、long;5、float;6、double;7、char;8、boolean。本专题为大家提供java基本数据类型的相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.02

1196

5

java有什么用
java有什么用

java可以开发应用程序、移动应用、Web应用、企业级应用、嵌入式系统等方面。本专题为大家提供java有什么用的相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.02

2409

5

java在线网站
java在线网站

Java在线网站是指提供Java编程学习、实践和交流平台的网络服务。近年来,随着Java语言在软件开发领域的广泛应用,越来越多的人对Java编程感兴趣,并希望能够通过在线网站来学习和提高自己的Java编程技能。php中文网给大家带来了相关的视频、教程以及文章,欢迎大家前来学习阅读和下载。

2023.08.03

19751

3

配置java环境变量
配置java环境变量

配置Java环境变量是为了让操作系统能够识别和使用Java的相关命令和功能。本专题为大家提供配置java环境变量相关文章,帮助大家解决问题。

2023.08.03

1095

8

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
dev.java 官方:Learn Java
dev.java 官方:Learn Java

共0课时 | 0人学习

Java JDBC数据库连接官方教程
Java JDBC数据库连接官方教程

共0课时 | 0人学习