Java MyBatis 插件中 `@Intercepts` 和 `@Signature` 怎么注解配置

老瑶酱_3343

老瑶酱_3343

2026-09-02

745人浏览

原创

mybatis插件中@intercepts和@signature注解用于精准拦截四大核心对象(executor、parameterhandler、statementhandler、resultsethandler)的指定方法,必须严格匹配type、method、args三要素;@intercepts为类级注解,声明拦截器身份并接受一个或多个@signature数组;@signature通过type定位接口、method指定方法名、args按顺序完整声明参数类型以区分重载,二者配合interceptor接口实现方法增强。

java mybatis 插件中 `@intercepts` 和 `@signature` 怎么注解配置

MyBatis 插件中 `@Intercepts` 和 `@Signature` 是声明拦截器的核心注解,配合 `Interceptor` 接口使用,用于精准定位要增强的方法。关键不是“加了注解就生效”,而是类型、方法名、参数列表三者必须严格匹配 MyBatis 四大核心对象的实际签名。

@Intercepts:声明这是一个拦截器类

它是一个**类级别注解**,只能加在实现了 `Interceptor` 接口的类上。它的作用是告诉 MyBatis:“这个类要参与插件链,别跳过”。

  • 必须传入一个 `@Signature` 数组(哪怕只拦截一个方法,也要用 `{@Signature(...)}` 包裹)
  • 不支持嵌套或继承;一个类只能有一个 `@Intercepts`
  • 若配置多个 `@Signature`,表示该拦截器同时作用于多个目标方法(共用同一套 `intercept()` 逻辑)

@Signature:精确指定拦截点

它定义“拦谁、拦哪个方法、拦哪一重载”,三个属性缺一不可:

Java Maven Code Review
Java Maven Code Review

审查Java Maven项目(ZIP压缩包或GitLab仓库URL),检查代码规范、命名、模块边界、可维护性问题以及重复代码。

下载
  • type:四大对象之一 —— Executor、ParameterHandler、StatementHandler 或 ResultSetHandler
  • method:该对象接口中声明的公开方法名(如 prepare、query、handleResultSets),注意大小写和拼写
  • args:对应方法的**完整参数类型数组**,用于区分重载。必须和源码中该方法的 `public xxx method(xxx a, xxx b)` 参数类型、顺序完全一致(例如 `MappedStatement.class, Object.class, RowBounds.class, ResultHandler.class`)

常见错误:把 `args` 写成 `String.class`(实际是 `Object.class`),或漏掉泛型擦除后的原始类型(如 `List.class` 错,应为 `java.util.List.class` 或更准确的 `java.util.ArrayList.class` —— 但通常用接口类型即可)。

典型配置示例

下面是一个同时拦截 SQL 准备和结果处理的写法:

@Intercepts({
    @Signature(type = StatementHandler.class, method = "prepare", args = {Connection.class, Integer.class}),
    @Signature(type = ResultSetHandler.class, method = "handleResultSets", args = {Statement.class})
})
public class SqlAuditInterceptor implements Interceptor {
    @Override
    public Object intercept(Invocation invocation) throws Throwable {
        // 根据 invocation.getTarget().getClass() 和 invocation.getMethod().getName()
        // 可判断当前实际进入的是 prepare 还是 handleResultSets
        System.out.println("正在拦截: " + invocation.getMethod().getName());
        return invocation.proceed();
    }

    @Override
    public Object plugin(Object target) {
        return Plugin.wrap(target, this);
    }
}

注意:两个 `@Signature` 共享同一个 `intercept()` 方法,内部需自行判断上下文;若逻辑差异大,建议拆分成两个独立拦截器类。

配置生效的必要条件

  • 拦截器类必须被 MyBatis 加载:通过 `` 标签注册到 `mybatis-config.xml`,或在 Spring 中调用 `configuration.addInterceptor(...)`
  • `plugin()` 方法不能被重写为直接返回 `target`(否则代理失效)
  • 确保 `args` 类型与 MyBatis 版本源码一致(不同版本方法签名可能微调,比如 `Integer` vs `int`、新增参数等)

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

9537

6

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

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

2023.07.05

6702

9

java自学难吗
java自学难吗

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

2023.07.31

5932

8

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

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

2023.08.01

1044

3

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

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

2023.08.02

868

3

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

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

2023.08.02

1236

5

java有什么用
java有什么用

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

2023.08.02

2509

5

java在线网站
java在线网站

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

2023.08.03

19851

3

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

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

2023.08.03

1135

8

热门下载

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

精品课程

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

共0课时 | 0人学习

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

共0课时 | 0人学习