废话不多说,直接上干货
SpringBoot 是如何实现自动装配的?
以我这个2.6.13的版本为例
第一步,我们先从@SpringBootApplication这个入口注解看起
在springBootApplication这个注解当中有三个关键性的注解,大概可以看作是:
1,@SpringBootConfiguration 声明是个配置类 2,@EnableAutoConfiguration 负责自动配置 3,@ComponentScan 负责包扫描
我们的重点是@EnableAutoConfiguration,因为这个才是负责spring的自动配置,
第二步,我们进入@EnableAutoConfiguration这个注解中:
@Import(AutoConfigurationImportSelector.class)这行代码是重点!
第三步,我们打开AutoConfigurationImportSelector这个类
能看到这个类实现了DeferredImportSelector接口(延迟加载的功能,也就是等其他bean定义之后来)
注意:DeferredImportSelector是ImportSelector的子接口,里面有一个selectImports的方法
这个方法中的importingClassMetadata参数能拿到类上注解的信息,比如读取注解的名称、属性值等信息。
第四步,我们来到 AutoConfigurationImportSelector类的selectImports方法
@Override
/*** 决定哪些自动配置类应该被导入到Spring应用程序中。* @param annotationMetadata 当前正在处理的配置类的注解元数据。* @return 一个字符串数组,包含了应该被导入的自动配置类的全限定类名。*/
public String[] selectImports(AnnotationMetadata annotationMetadata) {// 检查是否应该启用自动配置。这通常基于特定的条件,比如类上的注解。if (!isEnabled(annotationMetadata)) {// 如果自动配置未启用,返回一个空数组,表示没有配置类需要被导入。return NO_IMPORTS;}// 获取自动配置条目,这包含了应该被导入的配置类的信息。// 这个方法会根据注解元数据和其他条件来确定这些配置类。AutoConfigurationEntry autoConfigurationEntry = getAutoConfigurationEntry(annotationMetadata);// 将配置类的列表转换为字符串数组。这是为了满足selectImports方法的返回类型要求。// StringUtils.toStringArray方法将List<String>转换为String[]。return StringUtils.toStringArray(autoConfigurationEntry.getConfigurations());
}
第五步,我们进入getAutoConfigurationEntry这个方法
这才是自动装配的根源,接下来我们一行一行来解读
跟着我的解读,自己可以Debug一步一步看,效果会更好!
protected AutoConfigurationEntry getAutoConfigurationEntry(AnnotationMetadata annotationMetadata) {if (!isEnabled(annotationMetadata)) {return EMPTY_ENTRY;}AnnotationAttributes attributes = getAttributes(annotationMetadata);List<String> configurations = getCandidateConfigurations(annotationMetadata, attributes);configurations = removeDuplicates(configurations);Set<String> exclusions = getExclusions(annotationMetadata, attributes);checkExcludedClasses(configurations, exclusions);configurations.removeAll(exclusions);configurations = getConfigurationClassFilter().filter(configurations);fireAutoConfigurationImportEvents(configurations, exclusions);return new AutoConfigurationEntry(configurations, exclusions);}
下面是这个方法中每个步骤的详细解释:
1. **检查是否启用自动配置**:
if (!isEnabled(annotationMetadata)) {
return EMPTY_ENTRY;
}
这一步检查是否应该启用自动配置。`isEnabled` 方法可能会检查类上的注解(如 `@EnableAutoConfiguration`)或者类路径上的条件来决定是否启用。如果不启用,就返回一个空的 `AutoConfigurationEntry` 对象。2. **获取注解属性**:
AnnotationAttributes attributes = getAttributes(annotationMetadata);
这一步获取与自动配置相关的注解属性。这些属性可能包括 `@AutoConfiguration` 注解的属性,如 `exclude` 和 `excludeName`,它们用于指定应该排除哪些自动配置类。3. **获取候选配置**:
List<String> configurations = getCandidateConfigurations(annotationMetadata, attributes);
获取需要自动装配的所有配置类,读取META-INF/spring.factories文件,
Spring Boot Starter 下的META-INF/spring.factories
都会被读取到。4. **去重**:
configurations = removeDuplicates(configurations);
这一步确保候选配置列表中没有重复的类名。这通常通过创建一个新的集合来实现,只包含之前列表中未出现过的类名。5. **获取排除的配置**:
Set<String> exclusions = getExclusions(annotationMetadata, attributes);
这一步根据注解属性(如 `exclude`)获取需要排除的自动配置类的集合。6. **检查排除的类**:
checkExcludedClasses(configurations, exclusions);
这一步检查排除的类是否在候选配置列表中。如果不在,可能意味着排除逻辑有误,或者是一个bug。7. **移除排除的配置**:
configurations.removeAll(exclusions);
这一步从候选配置列表中移除所有在排除集合中的类名。8. **过滤配置类**:
configurations = getConfigurationClassFilter().filter(configurations);
这一步使用 `ConfigurationClassFilter` 对候选配置列表进行过滤。这个过滤器可以根据@ConditionalOnxxx相关的注解,来决定哪些类应该被包含9. **触发自动配置导入事件**:
fireAutoConfigurationImportEvents(configurations, exclusions);
这一步触发Spring的自动配置导入事件,允许其他组件(如监听器)在自动配置类被确定之前进行干预。10. **创建并返回AutoConfigurationEntry对象**:
return new AutoConfigurationEntry(configurations, exclusions);
最后,这个方法创建一个 `AutoConfigurationEntry` 对象,它包含了最终确定的自动配置类列表和排除的类列表,并返回这个对象。这个对象随后会被Spring Boot用来加载和应用自动配置。
总的来说,这个方法是Spring Boot自动配置流程的核心部分,它负责确定哪些自动配置类应该被加载,以及哪些应该被排除。这个过程涉及到注解解析、条件检查、去重、过滤等多个步骤,以确保自动配置既准确又高效。