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

如何在 Java 中通过反射读取 Method 上的自定义 @Deprecated 提示以实现动态代码审计

星墨姑娘_2741

星墨姑娘_2741

发布时间:2026-05-08 13:59:47

|

675人浏览过

|

来源于php中文网

原创

Java原生@Deprecated不支持自定义属性和反射读取提示文字,需自定义@DeprecatedSince注解(含value/version字段)、通过反射扫描提取说明,并兼容原生@Deprecated以增强审计能力。

如何在 java 中通过反射读取 method 上的自定义 @deprecated 提示以实现动态代码审计

Java 原生的 @Deprecated 是一个内置注解(`java.lang.Deprecated`),它**不支持自定义属性**,也不能被反射直接“读取提示文字”。你无法通过反射获取类似 @Deprecated("请改用 newMethod()") 这样的字符串值——因为标准 @Deprecated 的定义中根本没有 value 字段。

所以,要实现“动态代码审计”中识别带说明的弃用方法,你需要的是:一个自定义的、可携带描述信息的弃用注解,再配合反射读取它。以下是具体做法:

1. 定义可携带说明的自定义弃用注解

创建一个保留策略为 RUNTIME 的注解,允许通过反射访问,并添加 value() 或 reason() 字段存储提示文本:

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface DeprecatedSince {
    String value() default "该方法已弃用,请检查替代方案";
    String version() default "";
}

这样就能在方法上使用:

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

java-api-doc-generator
java-api-doc-generator

分析 Java Spring Boot 后端 Controller 代码,自动生成 Markdown 格式的接口文档。当用户说“生成 Java 接口文档”、“生成 API 文档”、“从 Spring 代码生成文档”时触发。

下载
@DeprecatedSince("请改用 calculateV2(),精度更高")
public double calculate() { ... }

2. 用反射扫描类中的废弃方法并提取提示

遍历目标类的所有 Method,检查是否标注了你的自定义注解,并读取其字段:

  • 调用 method.getAnnotation(DeprecatedSince.class)
  • 若返回非 null,说明该方法被标记为弃用
  • 调用 annotation.value() 或 annotation.reason() 获取提示文本
  • 可结合 method.getDeclaringClass() 和 method.getName() 构建完整签名用于审计报告

3. 集成到审计流程(例如启动时扫描或测试阶段)

常见实用方式包括:

  • 在 Spring Boot 启动时,用 ClassPathScanningCandidateComponentProvider 扫描特定包下所有 @Component 类,再反射检查其 public 方法
  • 编写 JUnit 测试,对指定模块的 API 类批量校验:发现带 @DeprecatedSince 但未加 @Test 或未被日志/监控覆盖的方法,自动失败
  • 与 IDE 插件或 SonarQube 自定义规则联动:将注解信息导出为 JSON 报告供静态分析消费

4. 补充建议:兼容原生 @Deprecated 并增强语义

如果你仍需兼容 JDK 自带的 @Deprecated(比如第三方库方法),可以同时检查:

  • method.isAnnotationPresent(Deprecated.class) → 表示基础弃用标记
  • 再叠加检查你的 @DeprecatedSince → 提供可读原因
  • 两者共存时,优先采用自定义注解的 value(),作为审计报告中的“弃用说明”

这样既不破坏现有约定,又提升了可维护性与自动化审计能力。

热门AI工具

更多
超级简历WonderCV

一款AI办公效率工具,主要用于免费求职简历模版下载制作,应届生职场人必备简历制作神器,适合需要提升相关任务效率的用户。

AionClaw
AionClaw Hot

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

DeepSeek

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

Seko
Seko Hot

一款AI视频创作工具,主要用于商汤科技推出的创编一体的AI短视频创作Agent,适合需要提升相关任务效率的用户。

Laper
Laper Hot

Laper是专为编剧、导演和制片人推出的 AI 原生剧本创作工具。

WorkBuddy

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

Lovart
Lovart Hot

一款面向视觉设计创作的AI设计平台,可通过智能体和画布工作流辅助制作海报、Logo、网页、PPT及其他视觉内容。

VibeKnow
VibeKnow Hot

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

豆包大模型

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

相关专题

更多
java
java

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

11697

2023.06.15

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

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

8802

2023.07.05

java自学难吗
java自学难吗

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

7552

2023.07.31

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

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

1244

2023.08.01

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

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

1008

2023.08.02

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

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

1496

2023.08.02

java有什么用
java有什么用

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

3069

2023.08.02

java在线网站
java在线网站

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

20331

2023.08.03

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

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

100

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