讲师中心 微信公众号
AI工具推荐 视频效率加速

Java中 MyBatis 插件 Interceptor 怎么通过反射读取 MappedStatement 上的自定义注解

风枫姑娘_2441

风枫姑娘_2441

发布时间:2026-07-18 10:40:57

|

122人浏览过

|

来源于php中文网

原创

MyBatis拦截器通过MappedStatement.getId()解析出Mapper接口类和方法名,再反射获取对应Method对象,从而读取其上的自定义注解(需@Retention(RUNTIME)且@Target(METHOD));XML中无法直接加Java注解,应改用注解式Mapper或扩展XML属性方案。

java中 mybatis 插件 interceptor 怎么通过反射读取 mappedstatement 上的自定义注解

MyBatis 的 Interceptor 可以在执行 SQL 前后拦截 MappedStatement,而要读取其上的自定义注解,核心在于:MappedStatement 本身不直接持有注解,注解实际是写在对应的 @Select、@Update 等接口方法或 XML 中的 SQL 标签上;MyBatis 在构建 MappedStatement 时会把接口方法(Method)信息存入其 sqlSource 或 configuration 相关结构中,但最可靠、通用的方式是通过 MappedStatement 获取绑定的 Method 对象,再用反射读取该方法上的注解。

确认注解定义和使用位置

你的自定义注解必须声明为 @Retention(RetentionPolicy.RUNTIME),且目标为 @Target(ElementType.METHOD)(如果标注在 Mapper 接口方法上):

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface MyCustomAnnotation {
    String value() default "";
}

然后在 Mapper 接口中使用:

public interface UserMapper {
    @MyCustomAnnotation("log-this")
    @Select("SELECT * FROM user WHERE id = #{id}")
    User selectById(@Param("id") Long id);
}

在 Interceptor 中获取 Method 并读取注解

MappedStatement 本身没有直接暴露 Method,但可通过以下路径还原:

立即学习“Java免费学习笔记(深入)”;

  • 从 MappedStatement 获取 configuration → 找到对应 MapperRegistry → 定位到该 statement 的 mapperType(即 Mapper 接口 Class)
  • 再结合 MappedStatement.getId()(格式通常是 com.example.UserMapper.selectById),提取方法名 selectById
  • 用反射从 mapperType 中查找同名 Method,注意参数类型需匹配(可借助 ParamNameResolver 或简化处理:若只用于注解读取,可忽略重载,用名称+参数个数粗筛)

更轻量、推荐的做法(适用于注解在接口方法上的场景):

// 在 Interceptor 的 intercept 方法中
Object target = invocation.getTarget();
if (target instanceof Executor) {
    // 拦截的是 Executor#query/update 等,参数[0] 是 MappedStatement
    MappedStatement ms = (MappedStatement) invocation.getArgs()[0];
<pre class="brush:php;toolbar:false;">// Step 1: 解析 id 获取 mapper 接口类和方法名
String id = ms.getId(); // e.g. "com.example.UserMapper.selectById"
int lastDot = id.lastIndexOf('.');
if (lastDot > 0) {
    String className = id.substring(0, lastDot);
    String methodName = id.substring(lastDot + 1);

    try {
        Class<?> mapperClass = Resources.classForName(className);
        // 尝试获取无参或单参方法(常见情况)
        Method method = Arrays.stream(mapperClass.getDeclaredMethods())
                .filter(m -> m.getName().equals(methodName))
                .findFirst()
                .orElse(null);

        if (method != null && method.isAnnotationPresent(MyCustomAnnotation.class)) {
            MyCustomAnnotation ann = method.getAnnotation(MyCustomAnnotation.class);
            System.out.println("Found annotation: " + ann.value());
            // ✅ 此处可做日志、权限校验、SQL 改写等
        }
    } catch (ClassNotFoundException e) {
        // 忽略或记录 warn
    }
}

}

XML 映射文件中的注解怎么办?

XML 方式(如 <select id="selectById"></select>)无法直接加 Java 注解。此时有两种替代方案:

  • 改用 注解式 Mapper:把 SQL 移到接口方法上,才能自然使用自定义注解
  • 在 XML 的 <select></select> 标签里加自定义属性,例如 <select id="selectById" my:custom="log-this"></select>,并在 Interceptor 中解析 ms.getSqlSource() 是否为 XMLLanguageDriver 创建的 XMLScriptBuilder,再从 ms.getBoundSql(...).getAdditionalParameters() 或扩展 XMLConfigBuilder 提前注入元数据 —— 但复杂度高,不推荐

注意事项与避坑点

反射读取注解看似简单,但容易踩坑:

  • 方法可能被代理:Spring AOP 或 MyBatis 自身代理可能导致 ms.getId() 和实际接口类不一致,建议优先用 ms.getConfiguration().getMapperRegistry().getMappers() 查找已注册的 mapper 类
  • 泛型/重载方法识别不准:仅靠方法名匹配可能出错,生产环境建议缓存 Map<string method></string>(key 为 ms.getId()),在应用启动时预扫描所有 Mapper 接口
  • 性能考虑:避免每次拦截都重复 Class.forName 和 getDeclaredMethods(),应提前构建好 Map<string annotation></string> 缓存

热门AI工具

更多
火山引擎

火山引擎是一款面向企业的云计算与AI服务平台。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

AionClaw
AionClaw Hot

AionClaw是一款面向办公、创作和编程任务的AI桌面智能体。

PixPix
PixPix Hot

PixPix是一款面向电商视觉生产的AI商品图生成工具。

VibeKnow
VibeKnow Hot

一款AI视频创作工具,主要用于全球首个AI知识视频创作平台,文档、文章、网页,一键生成视频,适合需要提升相关任务效率的用户。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

讯飞绘文

讯飞绘文是一款由科大讯飞推出的一站式 AIGC 内容运营平台。

UP简历
UP简历 Hot

一款AI办公效率工具,主要用于基于AI技术的免费在线简历制作工具,适合需要提升相关任务效率的用户。

相关专题

更多
java
java

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

11457

2023.06.15

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

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

8562

2023.07.05

java自学难吗
java自学难吗

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

7372

2023.07.31

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

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

1224

2023.08.01

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

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

988

2023.08.02

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

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

1476

2023.08.02

java有什么用
java有什么用

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

3009

2023.08.02

java在线网站
java在线网站

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

20271

2023.08.03

Vite 项目如何打包和部署
Vite 项目如何打包和部署

Vite项目打包部署专题汇集生产构建、产物预览、输出目录、资源路径、Nginx与GitHub Pages部署及常见白屏和路由404问题的已审核文章,帮助读者完成上线流程。

40

2026.10.28

热门下载

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

精品课程

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

共0课时 | 0人学习

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

共0课时 | 0人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn