从源码角度理解spring.factories

本文中SpringBoot版本为2.3.2.RELEASE

在阅读SpringBoot相关源码时，经常会看到resocures/META-INF文件夹下的spring.factories文件，里面写了自动配置（AutoConfiguration）相关的类名。

因此产生了一个疑问：“已经给类打上了@Configuration，为什么还要写spring.factories这个文件？”

想要弄清楚这个问题，得从@SpringBootApplication这个启动类上的注解开始。

查看@SpringBootApplication的源码，可以看到它扩展了以下注解：

@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@SpringBootConfiguration
@EnableAutoConfiguration
@ComponentScan(
    excludeFilters = {@Filter(
    type = FilterType.CUSTOM,
    classes = {TypeExcludeFilter.class}
), @Filter(
    type = FilterType.CUSTOM,
    classes = {AutoConfigurationExcludeFilter.class}
)}
)
public @interface SpringBootApplication {...}

其中比较重要的就是@EnableAutoConfiguration和@ComponentScan注解。

@ComponentScan的作用是扫描@SpringBootApplication所注解的启动类的所在包（以及子包）下的所以带有@Component或扩展了@Component注解的注解所修饰的所有类，将其作为bean注册到IOC容器中。

既然是这样，那么pom文件中引入的dependencies依赖项目中的bean又是怎样注入到当前的容器中的呢？

带着这个问题，我们深入@EnableAutoConfiguration的源码一探究竟。

@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@AutoConfigurationPackage
@Import({AutoConfigurationImportSelector.class})
public @interface EnableAutoConfiguration {
    String ENABLED_OVERRIDE_PROPERTY = "spring.boot.enableautoconfiguration";

    Class<?>[] exclude() default {};

    String[] excludeName() default {};
}

重点就是：

@Import({AutoConfigurationImportSelector.class})

直接将AutoConfigurationImportSelector类导入IOC中。

AutoConfigurationImportSelector类中核心代码：

public String[] selectImports(AnnotationMetadata annotationMetadata) {
	if (!this.isEnabled(annotationMetadata)) {
		return NO_IMPORTS;
	} else {
		AutoConfigurationImportSelector.AutoConfigurationEntry autoConfigurationEntry = this.getAutoConfigurationEntry(annotationMetadata);
		return StringUtils.toStringArray(autoConfigurationEntry.getConfigurations());
	}
}

其中，getAutoConfigurationEntry()方法获取需要自动配置的bean。

protected AutoConfigurationImportSelector.AutoConfigurationEntry getAutoConfigurationEntry(AnnotationMetadata annotationMetadata) {
	if (!this.isEnabled(annotationMetadata)) {
		return EMPTY_ENTRY;
	} else {
		AnnotationAttributes attributes = this.getAttributes(annotationMetadata);
		List<String> configurations = this.getCandidateConfigurations(annotationMetadata, attributes);
		configurations = this.removeDuplicates(configurations);
		Set<String> exclusions = this.getExclusions(annotationMetadata, attributes);
		this.checkExcludedClasses(configurations, exclusions);
		configurations.removeAll(exclusions);
		configurations = this.getConfigurationClassFilter().filter(configurations);
		this.fireAutoConfigurationImportEvents(configurations, exclusions);
		return new AutoConfigurationImportSelector.AutoConfigurationEntry(configurations, exclusions);
	}
}

其中，getCandidateConfigurations()方法获取了所有需要参与装配的候选bean，getExclusions()是获取排除的，不需要装配的bean。进一步查看this.getCandidateConfigurations()方法：

protected List<String> getCandidateConfigurations(AnnotationMetadata metadata, AnnotationAttributes attributes) {
	List<String> configurations = SpringFactoriesLoader.loadFactoryNames(this.getSpringFactoriesLoaderFactoryClass(), this.getBeanClassLoader());
	Assert.notEmpty(configurations, "No auto configuration classes found in META-INF/spring.factories. If you are using a custom packaging, make sure that file is correct.");
	return configurations;
}

此方法功能为读取classpath:/META-INF/spring.factories文件中的内容。
再看getSpringFactoriesLoaderFactoryClass()方法：

protected Class<?> getSpringFactoriesLoaderFactoryClass() {
	return EnableAutoConfiguration.class;
}

EnableAutoConfiguration类就是spring.factories文件中的第一行声明的类：

org.springframework.boot.autoconfigure.EnableAutoConfiguration

最终装配到spring项目中的bean就是由getCandidateConfigurations()配置的bean去掉getExclusions()中声明的bean得到的所有bean。

所以spring.factories配置文件的作用总结起来就是帮助spring-boot项目包以外的bean（即在pom文件中添加依赖中的bean）注册到spring-boot项目的spring容器。