Spring 工具类 ComponentScanAnnotationParser @ComponentScan注解处理器:扫描和注册组件bean

最新推荐文章于 2025-07-07 09:22:56 发布
原创 最新推荐文章于 2025-07-07 09:22:56 发布 · 2.9k 阅读 · 2 ·
CC 4.0 BY-SA版权
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。

概述

ComponentScanAnnotationParser是Spring的一个内部工具，它会基于某个类上的@ComponentScan注解属性分析指定包(package)以获取其中的bean定义。

所分析的包可以是多个包。

你可以简单地将ComponentScanAnnotationParser理解成注解@ComponentScan的处理器：

  • 输入 : @ComponentScan 注解信息
  • 处理 :
    • 执行ClassPathBeanDefinitionScanner 的扫描逻辑
      • 扫描输入信息所指定的各个包以发现bean定义
      • 注册扫描得到的每个bean定义到容器
  • 输出 : 输入信息所指定的包中所有的bean定义

它对注解@ComponentScan的处理在应用启动过程中配置类分析阶段进行。具体的可以参考ConfigurationClassParser#doProcessConfigurationClass。

所分析的包(package)包括 ：

  • 注解属性中属性basePackages所指定的包(package)
  • 注解属性中属性basePackageClasses指定的类所在的包(package)
  • 注解属性的注解类所在的包(package)
    • 仅在basePackages,basePackageClasses都为空时才生效

ComponentScanAnnotationParser 最终所使用的扫描器是ClassPathBeanDefinitionScanner。

ComponentScanAnnotationParser 的分析流程其实是从注解属性中提取有关信息，将其设置到ClassPathBeanDefinitionScanner扫描器上，然后调用ClassPathBeanDefinitionScanner执行bean定义的扫描和到容器的注册。

ComponentScanAnnotationParser所在包:org.springframework.context.annotation

相关文章

Spring 工具类 ConfigurationClassParser 分析得到配置类
Spring 工具类 ClassPathBeanDefinitionScanner Bean定义扫描
Spring BeanDefinitionRegistryPostProcessor : ConfigurationClassPostProcessor

Spring系列（三）：@ComponentScan注解用法介绍
IT技术分享社区
02-20 3967
今天给大家分享Spring中@ComponentScan注解的用法，希望对大家能有所帮助！1、@ComponentScan注解的作用@ComponentSc...
【报错解决】引入@ComponentScan注解注册bean容器后，导致的接口404问题
guojiaqi_的博客
06-22 1028
由于微服务开发中，经常需要在公共模块在引入一些公共模块，供其他服务使用，但是其他服务需要在启动类中配置@ComponentScan注解扫描这个公共模块下注册的 bean，但是，如果我们配置了@ComponentScan并且扫描了公共模块下的 bean，那么将会破坏@ComponentScan默认扫描的包，也就是@ComponentScan默认扫描的启动类同级目录下的包会破坏，此时我们当前模块的所有包都不会被注册，也就导致了 web 项目找不到控制器，从而报错 404。
ComponentScanAnnotationParser
qq_44587855的博客
12-27 159
Set<BeanDefinitionHolder> scannedBeanDefinitions = this.componentScanParser.parse(componentScan, sourceClass.getMetadata().getClassName()); public Set<BeanDefinitionHolder> parse(AnnotationAttributes componentScan, final String declaringCla
springboot @ComponentScan注解原理解析
08-25
主要介绍了springboot @ComponentScan注解原理解析,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
spring @ComponentScan
金溪的博客
05-09 489
@ComponentScan会提示Spring哪个package需要自动扫描，加载注解的类到bean容器。excludeFilters：指定哪些不用扫描includeFilters：指定哪些需要扫描 lazyInit：指定扫描到的bean是惰性加载nameGenerator：用于在Spring容器中检测到的组件命名resourcePattern：控制可用于组件检测的类文件scopedProxy：指...
自定义注解和组件扫描在Spring Boot中动态注册Bean（二）
2301_76419561的博客
10-13 958
自定义注解是一种强大的工具，它允许开发者定义自己的注解并在代码中使用它们，以实现特定的功能。在Spring Boot中，自定义注解可以用于动态注册Bean。首先，需要定义一个自定义注解。这个注解可以包含一些元信息，用于后续的处理。@Target(ElementType.TYPE) // 注解的目标为类@Retention(RetentionPolicy.RUNTIME) // 注解在运行时保留，可通过反射访问// 定义一个属性然后，在需要被动态注册为Bean的类上使用这个自定义注解。
`@Import` 和 `@ComponentScan` 有什么区别？
最新发布
Java的专栏
07-07 413
Import和都是 Spring 框架中用于配置和管理 Bean 的注解，但它们的作用和使用场景有着明显的区别。理解这两者的不同之处对于有效地组织和管理 Spring 应用程序的配置至关重要。@Import@Import注解用于显式地导入一个或多个配置类到当前的 Spring 应用上下文中。它允许你将分散在不同配置类中的 Bean 定义集中在一起。在这个例子中，AppConfig类通过@Import引入了和配置类，这意味着这两个配置类中的 Bean 定义也会被加载到 Spring 应用上下文中。
Spring注解篇：@Configuration详解
喵手的博客
12-16 1464
在Spring框架中，注解是实现Java配置的核心。它允许开发者以编程的方式定义Bean的创建过程，而不是使用XML文件。这种基于注解的配置方式，不仅简化了配置的复杂性，还提高了代码的可读性和可维护性。本文将详细介绍注解的用法和重要性。从基本概念到实际应用，再到源码解析，我们将全面了解如何使用注解来定义Spring的Bean。此外，还将分享使用案例和应用场景，以及对注解的优缺点进行分析。注解是Spring框架中用于标记配置类的注解。
Spring注解篇：@ComponentScan详解
喵手的博客
02-06 974
在Java开发的世界中，Spring框架以其强大的功能、灵活性和易用性，成为了许多开发者的首选。Spring框架的核心之一是依赖注入（DI），它允许开发者以声明的方式管理对象的创建和依赖关系。而注解，则是实现自动依赖注入的关键工具之一。本文将深入探讨Spring框架中的注解，从基础概念到实际应用，再到源码解析，我们将一步步揭开其神秘的面纱。同时，通过使用案例和应用场景的分享，我们将更加深入地理解的实际价值和应用范围。是一个用于指定Spring容器应扫描的包及其子包的注解。
Spring - @ComponentScan
大后生大大大的博客
06-19 325
ComponentScan是用来扫描组件的，只要用@Service、@Repository、@Controller、@RestController、@Component注解的类都会被Spring
ComponentScanAnnotationParser与ClassPathBeanDefinitionScanner解析
吐蕃圣僧
02-03 276
参考 spring源码阅读环境准备 ConfigurationClassPostProcessor 注册 BeanFactoryPostProcessor 接口调用源码分析 BeanDefinitionRegistryPostProcessor详解 ConfigurationClassPostProcessor解析 前言 上一篇我们写到了ConfigurationClassPostProcessor解析到了ComponentScanAnnotationParser的创建和解析。这里我们具体分析s
【Spring之ComponentScanAnnotationParser】
ypykip博客
01-14 605
ComponentScan注解的解析器，你知道如何实现的吗？
Spring系列——@ComponentScan
明亮的星光
10-21 296
Spring注解之@ComponentScan前言二级目录三级目录 前言 大家都了解过传统的Xml配置方式的Spring，基本上都知道Xml配置中有<Context:compent-scan>标签，它的作用是开启包扫描，把标注了@Controller、@Service、@Repository、@Component注册进Spring容器中，而Spring注解之@ComponentScan的作用就是代理此功能。 二级目录 三级目录 ...
Spring框架解析之@ComponentScan
镜悬xhs
02-07 436
​本文是Spring IoC容器技术介绍系列文章之一。本文介绍@ComponentScan。 1 自动扫描机制 @ComponentScan注解在Spring中用来定义IoC容器需要扫描哪些类文件。在这些类文件中，所有以@Component标注的对象和以@Bean标注的方法都会被自动加载到IoC容器中。 另外，除了@Component注解之外，其他诸如@Controller、@Configuration、@Service这些继承了@Component注解的注解，也同样适用于上述的扫描规则，均会被自动加
annotation parser
zhouzizhi的博客
02-21 440
[code="java"] public Map loadVlaue(Class annotationClasss, String annotationField, String className) throws Exception { System.out.println("处理An...
spring @ComponentScan使用
qq_36331657的博客
08-04 222
@ComponentScan(basePackages = {"com.xxx"},includeFilters={@ComponentScan.Filter(type = FilterType.ANNOTATION,classes = {Service.class})},excludeFilters = {@ComponentScan.Filter(type = FilterType.ANNOT...
Spring实例化源码解析之ComponentScanAnnotationParser(四)
于琦海
09-25 565
对ComponentScanAnnotationParser的parse方法的整体流程进行了分析，这个类是对@ComponentScan注解进行解析，并且将这些属性值设置到扫描器中，主要的使用还是在解析器,也就是ClassPathBeanDefinitionScanner的doScan方法
Spring注解@ComponentScan
大树
12-16 1227
Spring注解@ComponentScan 一、@ComponentScan注解 1、@ComponentScan注解作用 @ComponentScan用于扫描指定包下的类，将标注有@Controller、@Service、@Repository、@Component4个注解其中一个的类扫描到Spring容器，作为Spring Bean 2、@ComponentScan使用实例 （1）项目结构 （2）标注有标注有@Controller、@Service、@Repository、@Component4
@ComponentScan注解
05-10
### Spring @ComponentScan 注解 使用说明及常见问题解决方案 #### 一、@ComponentScan 注解概述 `@ComponentScan` 是 Spring 框架中的一个重要注解，主要用于自动扫描指定包及其子包下的类，并将其注册为 Spring 容器中的 Bean。默认情况下，Spring Boot 项目会基于 `@SpringBootApplication` 注解所在的包路径进行扫描，但如果需要自定义扫描范围，则可以通过 `@ComponentScan` 显式指定[^1]。 - **核心功能**：扫描带有特定注解（如 `@Component`、`@Service`、`@Repository` 和 `@Controller` 等）的类，并将它们注册为 Spring 容器中的 Bean。 - **注意事项**：如果目标类是接口而非具体实现类，即使标注了 `@Component` 注解，也无法被实例化为 Bean，因为接口本身无法直接实例化[^2]。 --- #### 二、@ComponentScan 的常用属性 以下是 `@ComponentScan` 注解的一些重要属性及其作用： 1. **basePackages** - 类型：字符串数组 (`String[]`) - 描述：指定需要扫描的包名列表。例如： ```java @ComponentScan(basePackages = {"com.example.package1", "com.example.package2"}) ``` 2. **basePackageClasses** - 类型：Class 数组 (`Class<?>[]`) - 描述：通过指定某些类来间接确定扫描的包路径。这些类所在的包会被作为根目录进行扫描。例如： ```java @ComponentScan(basePackageClasses = {MyClass1.class, MyClass2.class}) ``` 3. **useDefaultFilters** - 类型：布尔值 (`boolean`) - 描述：控制是否启用默认过滤规则，默认值为 `true`。如果设为 `false`，则需要显式定义过滤条件。 4. **includeFilters/excludeFilters** - 类型：Filter 数组 (`Filter[]`) - 描述：用于定义包含或排除的过滤规则。支持多种类型的过滤器，如按注解、类类型等筛选。例如： ```java @ComponentScan( includeFilters = @ComponentScan.Filter(type = FilterType.ANNOTATION, classes = Controller.class), useDefaultFilters = false ) ``` 5. **resourcePattern** - 类型：字符串 (`String`) - 描述：定义扫描时匹配的资源模式，默认为 `/**/*.class`，即扫描所有 `.class` 文件。 --- #### 三、典型应用场景与代码示例 ##### 场景 1：覆盖默认扫描路径 当项目的包结构较为复杂，或者需要引入外部 jar 包中的组件时，可以使用 `@ComponentScan` 来扩展扫描范围。例如： ```java @ComponentScan(basePackages = {"com.external.lib", "com.myapp.service"}) public class AppConfig { } ``` ##### 场景 2：多重扫描不同包路径 有时需要同时扫描多个不相关的包路径，可通过重复使用 `@ComponentScan` 或利用 `@Repeatable` 特性完成。例如： ```java @ComponentScan("com.pwx.bean") @ComponentScan("com.pwx.bean1") public class MyConfig { public static void main(String[] args) { AnnotationConfigApplicationContext applicationContext = new AnnotationConfigApplicationContext(MyConfig.class); String[] beanDefinitionNames = applicationContext.getBeanDefinitionNames(); Arrays.stream(beanDefinitionNames).forEach(System.out::println); } } ``` 注意：上述写法在现代版本中可能更推荐使用 `@ComponentScans` 组合形式[^3]。 ##### 场景 3：定制化过滤规则 假设只希望扫描带 `@Controller` 注解的类，可配置如下： ```java @ComponentScan( basePackages = "com.myapp", includeFilters = @ComponentScan.Filter(type = FilterType.ANNOTATION, classes = Controller.class), useDefaultFilters = false ) public class WebAppConfig { } ``` --- #### 四、常见问题及解决方法 1. **问题**: 引入第三方库后，部分 Bean 未被扫描到。 - **原因**: 默认扫描路径仅限于启动类所在包及其子包。 - **解决办法**: 使用 `@ComponentScan` 扩展扫描范围至目标包路径[^5]。 2. **问题**: 控制器类未被识别，导致 HTTP 请求返回 404 错误。 - **原因**: 启动类所在包之外的控制器类未被纳入扫描范围。 - **解决办法**: 确保 `@ComponentScan` 正确指定了包含控制器类的包路径。 3. **问题**: 接口类加了 `@Component` 注解却未能成为 Bean。 - **原因**: 接口无法直接实例化。 - **解决办法**: 提供具体的实现类并为其添加相应注解[^2]。 --- ### 总结 `@ComponentScan` 是一个强大的工具，可以帮助开发者灵活地管理 Spring 应用中的组件扫描行为。合理配置其属性能够显著提升开发效率，同时也需留意潜在陷阱以避免不必要的错误发生。 ---
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值