Spring-IOC之组件扫描

版本 Spring Framework 6.0.9

1. 前言

通过自动扫描，Spring 会自动从扫描指定的包及其子包下的所有类，并根据类上的特定注解将该类装配到容器中，而无需在 XML 配置文件或 Java 配置类中逐一声明每一个 Bean。

支持的注解
Spring 支持一系列注解，用于标记哪些类应被自动扫描并作为 Bean 管理。这些注解通常包含：

@Component：基础注解，标记一个类作为 Spring 组件。所有其他特殊用途的组件注解都继承自此注解。
@Repository：用于标注 DAO（Data Access Object）类，除了具备 @Component 的功能外，还为数据访问异常提供了特殊的翻译机制。
@Service：用于标注业务层（Service）类，强调这是一个业务相关的组件。
@Controller：用于标注 MVC 架构中的控制器类，通常在 Spring MVC 中使用，与 Spring Web 相关的请求处理逻辑相关联。
@Configuration：用于标注配置类，这类类通常包含 @Bean 方法，用于定义其他 Bean。
@RestController：结合了 @Controller 和 @ResponseBody，适用于构建 RESTful Web 服务的控制器。

例子相关实体类

控制层（例子中没引入spring-web包，注解先使用@Component替代）
服务层
数据访问层

2. 基于xml

2.1 使用

在 Spring 的XML配置文件中，通过 <context:component-scan> 标签开启自动扫描功能。我们可以配置 base-package 指定扫描路径。
在这里插入图片描述

输出信息说明每个实体类都已加载到容器。

<context:component-scan> 其他配置元素：

resource-pattern：可选属性，用于指定在扫描包路径下应匹配的资源模式。默认值为 “**/*.class”，即扫描所有 .class 文件。可以根据需要修改此模式，例如，仅扫描特定目录下的类。
use-default-filters：布尔属性，默认值为 true。决定是否启用默认的过滤规则，即查找带有 @Component、@Repository、@Service、@Controller、@Configuration 等注解的类。如果设置为 false，则需要手动配置和来指定扫描规则。
scope-resolver：指定一个自定义的 ScopeMetadataResolver 实现类，用于确定扫描到的 Bean 的作用域。默认情况下，Spring 使用 AnnotationScopeMetadataResolver，根据类上的 @Scope 注解来确定作用域。
scoped-proxy：指定是否为扫描到的带有作用域注解的 Bean 创建代理。可能的值包括：
- no（默认）：不创建代理。
- interfaces：为实现了接口的 Bean 创建 JDK 动态代理。
- targetClass：为未实现接口或需要保留原始类类型的 Bean 创建 CGLIB 代理。
name-generator：指定一个自定义的 BeanNameGenerator 实现类，用于生成扫描到的 Bean 的名称。默认使用 AnnotationBeanNameGenerator，根据类上的 @Component 等注解的 value 属性或类名生成 Bean 名称。
include-filter 和 exclude-filter：这两个元素属于子标签，用于指定更细粒度的扫描规则。可以按注解类型、注解属性、全类名模式等进行包含或排除。

2.2 扫描原理

当我们使用ClassPathXmlApplicationContext作为IOC容器，在refresh方法的obtainFreshBeanFactory阶段会创建一个bean工厂DefaultListableBeanFactory。
当前上下文调用loadBeanDefinitions方法，根据容器的配置文件加载bean定义。
配置文件中通过 <context:component-scan> 标签开启自动扫描功能，属于其他命名空间，托管给 ComponentScanBeanDefinitionParser处理。
ComponentScanBeanDefinitionParser#parse方法中创建一个ClassPathBeanDefinitionScanner对象，调用其scan方法扫描组件并加载到bean工厂中。

在这里插入图片描述

其他命名空间

Spring框架除了核心的XML命名空间外，还提供了多个扩展命名空间（除beans以外的命名空间），以支持特定的功能模块和简化配置。

http://www.springframework.org/schema/beans：核心命名空间，这是最基础且最常用的命名空间，用于定义bean、设置属性、注入依赖、配置构造函数参数、初始化方法、销毁方法、自动装配等基本IoC容器功能。
http://www.springframework.org/schema/context：
context命名空间，提供了对Java配置类、自动扫描、注解驱动的bean定义、属性占位符替换、资源加载等上下文相关的高级功能的支持。通过此命名空间，可以简化基于注解的配置，如@Component、@Autowired等。

在实例化XmlReaderContext时，DefaultBeanDefinitionDocumentReader会创建一个命名空间解析器DefaultNamespaceHandlerResolver，缓存到XmlReaderContext，当Reader解析配置文件时发现存在其他命名空间时，通过DefaultNamespaceHandlerResolver加载 META-INF/spring.handlers 路径下的其他命名空间处理器，获取对应的处理器处理。

XmlReaderContext 是Spring框架中用于处理XML配置文件解析过程中的上下文对象，为DefaultBeanDefinitionDocumentReader在解析和处理XML配置文件时提供了必要的环境支持。

在这里插入图片描述

context命名空间处理器（ComponentScanBeanDefinitionParser）

获取基础包名basePackages。
创建类路径 Bean 定义扫描程序ClassPathBeanDefinitionScanner。
遍历扫描包名，查找被@Component及其派生注解修饰的类。将它们封装为BeanDefinitionHolder对象。
往bean工厂加载特定注解后置处理器的bean定义（internalConfigurationAnnotationProcessor、internalAutowiredAnnotationProcess、internalCommonAnnotationProcessor、internalEventListenerProcessor、internalEventListenerFactory），触发组件注册事件.

获取基础包名basePackages

element.getAttribute(BASE_PACKAGE_ATTRIBUTE)方法从对象中获取base-package的属性值。
parserContext.getReaderContext().getEnvironment().resolvePlaceholders(basePackage)方法解析占位符，获取解析值。
StringUtils.tokenizeToStringArray(basePackage,ConfigurableApplicationContext.CONFIG_LOCATION_DELIMITERS)方法将基础包名按逗号、分号或空格等常见分隔符拆分为一个字符串数组basePackages。

在这里插入图片描述

创建组件扫描器

ComponentScanBeanDefinitionParser#configureScanner方法通过对XML元素element的各项属性（use-default-filters、resource-pattern、name-generator、scope-resolver、scoped-proxy）和子元素（include-filter、exclude-filter）进行解析，创建一个定制化的扫描器ClassPathBeanDefinitionScanner。
在这里插入图片描述

另外通过ClassPathBeanDefinitionScanner构造函数实例化时，会创建一个Component类型的注解类型过滤器AnnotationTypeFilter添加到includeFilters属性中，用于将类与@Component进行匹配。
在这里插入图片描述

扫描组件

ClassPathBeanDefinitionScanner#doScan扫描指定的basePackages包及其子包，查找并处理符合要求的bean定义，最终将它们封装为BeanDefinitionHolder对象并返回，bean定义类型是ScannedGenericBeanDefinition。
在这里插入图片描述

扫描核心方法ClassPathScanningCandidateComponentProvider#findCandidateComponents用于在指定的basePackage包及其子包下查找符合要求的候选bean组件（BeanDefinition），支持索引查找（效率更高）或按传统方式查找（获取指定包下所有class对象筛选）。
在这里插入图片描述

我们只看传统方式查找方式，ClassPathScanningCandidateComponentProvider#scanCandidateComponents方法用于在给定的basePackage及其子包下通过类路径扫描机制查找候选bean组件（BeanDefinition）.
在这里插入图片描述

ClassPathScanningCandidateComponentProvider#isCandidateComponent方法用于判断给定的MetadataReader所代表的类是否满足候选bean组件的条件，在不添加其他排除过滤器、包含过滤器或配置，上面创建组件扫描器过程中，已知添加了一个AnnotationTypeFilter包含过滤器，在此处使用，匹配被@Component注解的类。
在这里插入图片描述

触发组件注册事件

ComponentScanBeanDefinitionParser#registerComponents负责将一组BeanDefinition注册到Spring IoC容器中，并处理与之相关的XML元素及注解配置处理器。实际上做了两件事

往bean工厂加载特定注解后置处理器的bean定义
触发组件注册事件，一般情况下是EmptyReaderEventListener，空方法。

在这里插入图片描述

3. 全注解开发

AnnotationConfigApplicationContext 是 Spring Framework 中的一个核心类，用于创建和管理基于 Java 注解的 Spring 应用程序上下文。AnnotationConfigApplicationContext 有两种开启组件扫描的方式

直接指定包路径
通过@ComponentScan注解

3.1 通过指定包路径开启扫描

使用

在这里插入图片描述

扫描原理

接受一个字符串数组参数 basePackages的有参构造逻辑分成三部分：

this(); 调用无参构造函数
scan(basePackages); 执行类路径扫描
refresh(); 启动应用上下文

无参构造函数实例化组件扫描器 ClassPathBeanDefinitionScanner，用于在类路径中扫描并注册基于注解的 Bean 定义（如 @Component、@Service、@Repository、@Controller 等）。
在这里插入图片描述

调用ClassPathBeanDefinitionScanner#scan方法扫描组件，与基于xml扫描逻辑一样，调用的是ClassPathBeanDefinitionScanner#scan方法，所以bean定义创建的类型也是ScannedGenericBeanDefinition类。
在这里插入图片描述

3.2 通过Java配置类开启扫描

使用

在这里插入图片描述 c

扫描原理

接受一个类型为 Class<?> 的可变参数数组 componentClasses的有参构造逻辑分成三部分：

this(); 调用无参构造函数
register(componentClasses); 注册指定的组件
refresh(); 启动应用上下文

在这里插入图片描述

第一部分虽然与接受字符串的有参构造（指定扫描路径）一样调用了无参构造，但我们这里只关注带注释的 Bean 定义读取器AnnotatedBeanDefinitionReader，而不是类路径 Bean 定义扫描程器ClassPathBeanDefinitionScanner。
在这里插入图片描述

实例化AnnotatedBeanDefinitionReader过程中，会调用AnnotationConfigUtils.registerAnnotationConfigProcessors(this.registry)方法，往bean工厂注册一个bean定义后置处理器ConfigurationClassPostProcessor。
在这里插入图片描述

第二部分注册Java配置类ScanConfig，实例化并初始化bean定义类AnnotatedGenericBeanDefinition，并加载到bean工厂中。
在这里插入图片描述

在这里插入图片描述

第三部分在refresh方法invokeBeanFactoryPostProcessors阶段，会调用在第一部分注册的ConfigurationClassPostProcessor（在当前阶段会调用getBean方法实例化）后置处理。
在这里插入图片描述

ConfigurationClassPostProcessor 是 Spring 框架中一个重要的 BeanDefinitionRegistryPostProcessor 实现，主要负责处理带有 @Configuration 注解的类以及它们内部定义的 @Bean 方法和其他相关注解。postProcessBeanDefinitionRegistry方法会筛选出有效的@configuration类，调用配置类解析器ConfigurationClassParser的parse方法解析。
在这里插入图片描述

从第二部分知道，ScanConfig生成的bean定义类是AnnotatedGenericBeanDefinition，是AnnotatedBeanDefinition的子类。debug源码到处理@ComponentScan注解（this.componentScanParser.parse(componentScan, sourceClass.getMetadata().getClassName());），说明ConfigurationClassParser处理逻辑委托给componentScanParser，调用其parse方法处理。
在这里插入图片描述

这里的this.componentScanParser是ComponentScanAnnotationParser类，在调用ConfigurationClassParser构造函数实例化时创建。
在这里插入图片描述

ComponentScanAnnotationParser#parse方法中的逻辑就很熟悉了，可以对标context命名空间处理各个属性。在方法中是新建了一个ClassPathBeanDefinitionScanner类，而不是使用AnnotationConfigApplicationContext无参构造中实例化的ClassPathBeanDefinitionScanner，最后执行doscan方法扫描组件。
在这里插入图片描述

总结

总结一下通过@ComponentScan开启扫描流程.

this();
- 在实例化AnnotatedBeanDefinitionReader过程中，往bean工厂加载了ConfigurationClassPostProcessor的bean定义
register(componentClasses);
- 往bean工厂加载了包含@Configuration、@ComponentScan注解的ScanConfig配置类的bean定义。
refresh();
- 在invokeBeanFactoryPostProcessors阶段实例化了ConfigurationClassPostProcessor，并调用其postProcessBeanDefinitionRegistry方法处理@Configuration配置类。
- ConfigurationClassPostProcessor#postProcessBeanDefinitionRegistry方法中，获取并筛选有效的 @Configuration类，实例化了配置类解析器ConfigurationClassParser，调用其parse方法，解析配置类（ScanConfig.class）。
- ConfigurationClassParser#parse包含处理配置类中各种注解，其中就包含@ComponentScan。但解析@ComponentScan，委托给了ComponentScanAnnotationParser类，调用其parse方法.
- ComponentScanAnnotationParser#parse实例化了类路径 Bean 定义扫描器ClassPathBeanDefinitionScanner，ClassPathBeanDefinitionScanner加载扫描配置后调用doScan扫描组件。