Java 怎么通过反射批量获取包下所有带有特定注解的类

酷芳小哥_1750

酷芳小哥_1750

2026-09-05

133人浏览

原创

java无法直接通过反射扫描包路径获取类,需先扫描类字节码再加载检查注解;推荐使用classgraph库或spring的classpathscanningcandidatecomponentprovider实现,注意注解需@retention(runtime)且正确处理类加载与资源释放。

java 怎么通过反射批量获取包下所有带有特定注解的类

Java 无法直接通过反射“扫描包路径”获取类,因为反射本身只作用于已加载的类(Class对象),而包下的类在未被加载前对 JVM 是不可见的。要批量获取某个包下所有带有特定注解的类,本质是:先扫描包路径下的类字节码(即发现类),再加载并检查注解。这需要借助类路径(classpath)扫描 + 反射配合实现。

使用 ClassGraph 快速扫描带注解的类

ClassGraph 是目前最轻量、高效且跨环境(IDE/打包/JAR/模块化)支持良好的扫描库。它不依赖 Spring,纯 Java 实现,能自动处理 jar、目录、嵌套 jar 等场景。

Java Maven Code Review
Java Maven Code Review

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

下载
  • 添加 Maven 依赖:

  io.github.classgraph
  classgraph
  4.8.172
  • 扫描示例(查找 com.example.service 包下所有标有 @RestController 的类):

try (ScanResult scanResult = new ClassGraph()
.acceptPackages("com.example.service")
.enableAnnotationInfo()
.scan()) {
List annotatedClasses = scanResult
.getClassesWithAnnotation(RestController.class.getName());
for (ClassInfo classInfo : annotatedClasses) {
Class> clazz = classInfo.loadClass(); // 触发加载
System.out.println("Found: " + clazz.getName());
}
}

用 Spring 的 ClassPathScanningCandidateComponentProvider(适合 Spring 项目)

如果你已在使用 Spring(尤其是 Spring Boot),可直接复用其内置扫描器,它底层也基于类路径扫描,支持过滤注解。

  • 代码示例:

ClassPathScanningCandidateComponentProvider scanner =
new ClassPathScanningCandidateComponentProvider(false);
scanner.addIncludeFilter(new AnnotationTypeFilter(MyCustomAnnotation.class));
scanner.setResourcePattern("**/*.class");

String basePackage = "com.example.module";
for (BeanDefinition candidate : scanner.findCandidateComponents(basePackage)) {
try {
Class> clazz = Class.forName(candidate.getBeanClassName());
System.out.println("Matched: " + clazz.getName());
} catch (ClassNotFoundException e) {
// 忽略加载失败
}
}

手动解析 classpath(不推荐,仅作理解)

原理是:获取当前线程上下文类加载器的 getResource("") 路径,判断是 file://(目录)还是 jar:file://(JAR),再分别用 File.listFiles() 或 JarFile.entries() 遍历 .class 文件,按包名匹配、用 ClassLoader.loadClass() 加载后检查注解。但需处理路径分隔、嵌套 jar、模块路径(JPMS)等边界问题,极易出错,生产环境不建议手写。

关键注意事项

  • 注解必须声明为 @Retention(RetentionPolicy.RUNTIME),否则运行时不可见,反射查不到
  • 扫描结果中的类可能尚未初始化(static 块未执行),loadClass() 只加载不初始化;如需初始化,调用 Class.forName(className, true, classLoader)
  • 避免重复加载或内存泄漏:ClassGraph 的 scan() 返回的 ScanResult 应及时关闭(try-with-resources);Spring 扫描器无需手动释放
  • 包名必须用点号(.)分隔,且末尾不加 .* —— 扫描器会自动递归子包

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

9717

6

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

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

2023.07.05

6862

9

java自学难吗
java自学难吗

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

2023.07.31

6052

8

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

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

2023.08.01

1064

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

1276

5

java有什么用
java有什么用

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

2023.08.02

2549

5

java在线网站
java在线网站

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

2023.08.03

19871

3

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

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

2023.08.03

1155

8

热门下载

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

精品课程

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

共0课时 | 0人学习

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

共0课时 | 0人学习