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

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 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 流程,不如采用工程上更稳定的设计:
立即学习“Java免费学习笔记(深入)”;
-
将包级元数据移到常量类中:例如在包根目录下创建
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()读取
不复杂但容易忽略:包级注解本质是源码组织手段,不是运行时契约。需要运行时可读的元数据,就该选择明确支持反射访问的载体。


















