SpringBoot自动配置原理（源码）

学习SpringBoot源码需要了解Spring相关源码，这样才能更通透。

一、原理简述

SpringBoot启动类本身也是一个配置类，Spring会解析配置类上的所有嵌套的@Import注解，其中就有@EnableAutoConfiguration注解中的@Import(AutoConfigurationImportSelector.class)，AutoConfigurationImportSelector类就是自动配置的关键，他的主要作用是获取META-INF/spring.factories文件中以EnableAutoConfiguration为key的值，这些值全是可能需要的自动配置类。例如：

获取到这些自动配置类后，根据它自身的@ConditionalOnClass等条件判断是否需要导入。最后处理这些过滤后的配置类完成自动配置。

需要注意的是META-INF/spring.factories中的值在SpringBoot启动的时候就被缓存起来了，处理AutoConfigurationImportSelector的时候是从缓存中取得值，不过两者都调用的是同一个方法。

二、源码探析

@SpringBootApplication
public class MySpringBootApplication {

	public static void main(String[] args) { 
		SpringApplication.run(MySpringBootApplication.class, args);
	}
}

这是一个初始的SpringBoot项目的启动类，这个类被@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 {

这个注解又被很多个注解修饰着，比如@SpringBootConfiguration表示这是一个配置类，也就是说咱们的启动类也是一个配置类。这些注解中，最重要的是 @EnableAutoConfiguration 注解。

这个注解的名字翻译过来就是开启自动配置，通过名字来看肯定和自动配置有关，那为什么加了这个注解就能开启自动配置呢？我们再点进去看看具体长什么样子。

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@AutoConfigurationPackage
@Import(AutoConfigurationImportSelector.class)
public @interface EnableAutoConfiguration {

我们发现这个注解上用@Import导入了一个AutoConfigurationImportSelector类，这个类翻译过来是自动注解导入选择器。自动配置的实现关键就在此了。

这里简述一下@Import注解的用处

1. 导入@Configuration配置类，会直接解析这个配置类
2. 可以导入@Component类
3. ImportSelector接口实现类，Spring会执行selectImports方法，用于导入一组的bean或配置类的全名。
4. DeferredImportSelector接口实现类，会在项目中所有配置类解析完毕后，执行Group.process方法处理导入@Configuration类。
5. ImportBeanDefinitionRegistrar接口实现类，执行registerBeanDefinitions方法注册BeanDefintion。

AutoConfigurationImportSelector类实现了DeferredImportSelector接口，在spring容器创建中会执行它的process方法导入配置类。

process方法中有个getAutoConfigurationEntry方法，翻译过来是获取自动配置类条目。

getAutoConfigurationEntry方法中获取候选配置类，并过滤和排除一些用不着的配置类。

	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);
		// 根据一下@ConditionalOnClass等条件注解过滤配置类
		configurations = getConfigurationClassFilter().filter(configurations);
		fireAutoConfigurationImportEvents(configurations, exclusions);
		return new AutoConfigurationEntry(configurations, exclusions);
	}

其中重要的是getCandidateConfigurations方法。

我们从下面的报错信息中也能了解到，它是从META-INF/spring.factories文件中获取自动配置类的信息。

SpringFactoriesLoader.loadFactoryNames 就是从META-INF/spring.factories文件中获取自动配置类的信息的，而key getSpringFactoriesLoaderFactoryClass() 就是org.springframework.boot.autoconfigure.EnableAutoConfiguration。

	protected List<String> getCandidateConfigurations(AnnotationMetadata metadata, AnnotationAttributes attributes) {
		List<String> configurations = SpringFactoriesLoader.loadFactoryNames(getSpringFactoriesLoaderFactoryClass(),
				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;
	}

获取到这些配置类之后，Spring就会处理这些配置类完成一些自动配置的工作。

我们在配置文件中配置的项，这些配置类是怎么获取到的呢？

以我们熟悉的JdbcTemplateAutoConfiguration为例。

这个自动配置类上有一个@EnableConfigurationProperties(JdbcProperties.class)注解，这个注解是用来让@ConfigurationProperties注解生效，并往容器注入一个JdbcProperties的bean。这样配置类就能从容器中获取这个bean，从而拿到咱们配置的项。

而@ConfigurationProperties注解就是将配置中以特定字符串开头的配置，映射到当前类的属性上。

@ConfigurationProperties(prefix = "spring.jdbc")
public class JdbcProperties {

@Configuration(proxyBeanMethods = false)
@ConditionalOnClass({ DataSource.class, JdbcTemplate.class })
@ConditionalOnSingleCandidate(DataSource.class)
@AutoConfigureAfter(DataSourceAutoConfiguration.class)
@EnableConfigurationProperties(JdbcProperties.class)
@Import({ JdbcTemplateConfiguration.class, NamedParameterJdbcTemplateConfiguration.class })
public class JdbcTemplateAutoConfiguration {

}

总结

SpringBoot启动时会加载META-INF/spring.factories中配置的自动配置类，并缓存起来。

Spring解析启动类上的所有嵌套的@Import注解，其中就有@EnableAutoConfiguration注解中的@Import(AutoConfigurationImportSelector.class)，AutoConfigurationImportSelector类会获取META-INF/spring.factories中（从缓存中）以org.springframework.boot.autoconfigure.EnableAutoConfiguration为key的所有自动配置类，将这些自动配置类过滤排除之后，解析处理这些配置类，这些配置类用@EnableConfigurationProperties(JdbcProperties.class)的方式获取配置文件中的配置项，完成自动配置的功能。