Java中 Spring ClassPathScanningCandidateComponentProvider 怎么按自定义注解过滤组件

胖伟君_2629

胖伟君_2629

2026-07-20

891人浏览

原创

可以通过重写iscandidatecomponent方法并结合自定义注解的元注解(@target、@retention)及运行时检查逻辑,使classpathscanningcandidatecomponentprovider仅识别带特定自定义注解(如@mycomponent)的类,需确保注解作用于类型、运行时可见,并可选添加@documented和@indexed;配置时禁用默认过滤器,添加annotationtypefilter或自定义typefilter实现精准扫描。

java中 spring classpathscanningcandidatecomponentprovider 怎么按自定义注解过滤组件

可以通过重写 isCandidateComponent 方法,并结合自定义注解的元注解(如 @Target、@Retention)和运行时检查逻辑,让 ClassPathScanningCandidateComponentProvider 仅识别带特定自定义注解的类。

确保自定义注解满足 Spring 组件扫描要求

Spring 默认只扫描带有 @Component 及其派生注解(如 @Service、@Repository、@Controller)的类。若要用自定义注解(例如 @MyComponent),需满足:

  • 必须声明 @Target({ElementType.TYPE})(作用于类)
  • 必须声明 @Retention(RetentionPolicy.RUNTIME)(运行时可见)
  • 推荐添加 @Documented 和 @Indexed(后者可提升扫描性能,需引入 spring-context-indexer)

创建并注册自定义注解

示例注解定义:

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Indexed // 可选,配合 spring-context-indexer 使用
public @interface MyComponent {
    String value() default "";
}

在目标类上使用它:

@MyComponent
public class MyService {
    // ...
}

配置 ClassPathScanningCandidateComponentProvider 并过滤

直接实例化扫描器后,禁用默认过滤器,添加基于自定义注解的类型过滤:

Java Maven Secondary Analysis
Java Maven Secondary Analysis

分析ZIP压缩包或GitLab仓库中的Java Maven项目,确定二次开发范围、类数量、模块分布及生产相关指标。

下载
ClassPathScanningCandidateComponentProvider scanner =
    new ClassPathScanningCandidateComponentProvider(false); // false 表示不使用默认@Component过滤

// 添加包含过滤器:只接受标有 @MyComponent 的类
scanner.addIncludeFilter(new AnnotationTypeFilter(MyComponent.class));

// (可选)排除其他干扰,比如跳过接口、注解、枚举等
scanner.addExcludeFilter(new AssignableTypeFilter(Annotation.class));
scanner.addExcludeFilter(new AssignableTypeFilter(Interface.class));
scanner.addExcludeFilter(new AssignableTypeFilter(Enum.class));

然后执行扫描:

String basePackage = "com.example.myapp";
Set<beandefinition> candidates = scanner.findCandidateComponents(basePackage);
for (BeanDefinition beanDef : candidates) {
    System.out.println("Found: " + beanDef.getBeanClassName());
}</beandefinition>

进阶:自定义 TypeFilter 实现更灵活逻辑

若需更复杂判断(如检查注解属性值、继承关系、或组合多个注解),可实现 TypeFilter:

scanner.addIncludeFilter(new TypeFilter() {
    @Override
    public boolean match(MetadataReader metadataReader, MetadataReaderFactory metadataReaderFactory)
            throws IOException {
        AnnotationMetadata metadata = metadataReader.getAnnotationMetadata();
        return metadata.hasAnnotation(MyComponent.class.getName());
        // 或更细粒度:metadata.getAnnotationAttributes(MyComponent.class.getName()) != null;
    }
});

该方式完全绕过 Spring 内置注解解析机制,适合动态条件或元数据校验场景。

注意:扫描路径需确保在 classpath 下且未被其他 exclude 规则拦截;若使用 JDK 9+ 模块系统,还需确认模块导出(exports)和打开(opens)包给反射访问。

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

10017

6

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

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

2023.07.05

7162

9

java自学难吗
java自学难吗

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

2023.07.31

6292

8

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

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

2023.08.01

1084

3

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

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

2023.08.02

908

3

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

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

2023.08.02

1316

5

java有什么用
java有什么用

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

2023.08.02

2629

5

java在线网站
java在线网站

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

2023.08.03

19951

3

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

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

2023.08.03

1175

8

热门下载

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

精品课程

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

共0课时 | 0人学习

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

共0课时 | 0人学习