反射读取包级别声明的注解值_反射如何获取package-info.java中定义的包级注解

夏萱姑娘_4968

夏萱姑娘_4968

2026-05-23

758人浏览

原创

Package.getAnnotations()通常为空,因为package-info.java中的注解默认为SOURCE保留策略,编译后即丢弃,且JDK的Package类不解析package-info.class中的注解。

反射读取包级别声明的注解值_反射如何获取package-info.java中定义的包级注解

Java 反射 API 本身不支持直接通过 Package 对象读取 package-info.java 中声明的注解值,因为 Package.getAnnotations() 返回的是 JVM 在运行时从 META-INF/MANIFEST.MF 或模块描述中加载的“运行时包注解”,而非源码中定义在 package-info.java 上的注解。

为什么 Package.getAnnotations() 通常为空?

JVM 规范并未要求将 package-info.java 中的注解编译进运行时类文件(.class)或注入到 java.lang.Package 实例中。这些注解默认保留策略是 @Retention(RetentionPolicy.SOURCE) —— 仅存在于源码阶段,编译后即丢弃。即使你显式声明为 @Retention(RetentionPolicy.CLASS) 或 @Retention(RetentionPolicy.RUNTIME),标准 JDK 的 Package 类仍不会自动关联它们。

  • 关键限制:JDK 的 Package 类不解析或加载 package-info.class 中的注解信息
  • 例外情况:只有当注解被 JVM 特定机制识别(如模块系统中的 @Deprecated、@SuppressWarnings 等极少数内置注解),或通过自定义类加载器/字节码工具主动注入时,才可能出现在 Package 对象中

正确获取 package-info.java 注解的两种可行方式

要真正读取 package-info.java 中定义的注解(例如 @PackageVersion("1.2.0")),必须绕过 Package API,改用以下方法:

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

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

下载
  • 方式一:通过 ClassLoader 加载 package-info.class 并用 ASM/Javassist 解析字节码
    编译后,每个包会生成一个 package-info.class 文件(位于对应包路径下)。你可以用类加载器定位该类资源,再借助字节码库(如 ASM)读取其 RuntimeVisibleAnnotations 属性。
  • 方式二:使用 Java Compiler API 在编译期处理(APT)
    编写注解处理器(javax.annotation.processing.Processor),在编译阶段扫描 package-info.java,提取注解并生成辅助类(如 PackageMetadata.java),运行时即可通过普通反射读取该辅助类的静态字段。

实用建议:更简单且推荐的替代方案

与其依赖脆弱的字节码解析或复杂的 APT 流程,不如采用工程上更稳定的设计:

  • 将包级元数据移到常量类中:例如在包根目录下创建 PackageInfo.java,用 public static final 字段承载版本、作者等信息
  • 利用 module-info.java(Java 9+):若项目已模块化,可在 module-info.java 中用 opens/uses 或自定义指令配合 Module.getDescriptor() 获取结构化元数据
  • 约定优于配置:通过 Maven/Gradle 构建时写入 META-INF/MANIFEST.MF,运行时用 getClass().getPackage().getImplementationVersion() 读取

不复杂但容易忽略:包级注解本质是源码组织手段,不是运行时契约。需要运行时可读的元数据,就该选择明确支持反射访问的载体。

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

相关文章

java速学教程(入门到精通)
java速学教程(入门到精通)

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

下载

相关标签:

java

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

相关专题

更多
java
java

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

2023.06.15

11457

6

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

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

2023.07.05

8562

9

java自学难吗
java自学难吗

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

2023.07.31

7372

8

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

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

2023.08.01

1224

3

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

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

2023.08.02

988

3

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

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

2023.08.02

1476

5

java有什么用
java有什么用

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

2023.08.02

3009

5

java在线网站
java在线网站

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

2023.08.03

20271

3

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

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

2023.08.03

1315

8

热门下载

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

精品课程

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

共0课时 | 0人学习

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

共0课时 | 0人学习