SpringBoot的自动配置原理

SpringBoot自动配置的能力为我们在项目开发中省去了很多繁琐的配置，它的本质还是Spring框架。SringBoot可以通过pom文件中是否存在相应的启动器从而有选择的加载相应的配置。下面让我们来一起探究下SpringBoot是如何实现自动配置的。

@SpringBootApplication

@SpringBootApplication
public class SpringbootApplication {

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

}

从SpringBoot的启动类中我们可以看到有一个@SpringBootApplication注解，这是SpringBoot自动配置的起源。SpringBoot通过@SpringBootApplication注解来来声明这是一个主配置类，SpringBoot 运行这个类的main方法来启动 SpringBoot 应用。这个注解是一个组合注解，我们点进去可以看到以下代码：

@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
@ComponentScan

下面让我们深入了解一下这三个重要的注解：

@SpringBootConfiguration注解：

@SpringBootConfiguration作用是标注于某个类中，表明这是一个配置类。

@EnableAutoConfiguration注解：

@EnableAutoConfiguration会告诉SpringBoot开启自动配置，这样我们的自动配置才会生效。点进@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 {};
}

@AutoConfigurationPackage：
点进@AutoConfigurationPackage：

@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@Import({Registrar.class})
public @interface AutoConfigurationPackage {
    String[] basePackages() default {};

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

**@Import：**为容器中导入一个组件，导入的组件由 AutoConfigurationPackages.class的内部类 Registrar.class 执行逻辑来决定是如何导入的。
点开Registrar我们可以看到：

}

    static class Registrar implements ImportBeanDefinitionRegistrar, DeterminableImports {
        Registrar() {
        }

        public void registerBeanDefinitions(AnnotationMetadata metadata, BeanDefinitionRegistry registry) {
            AutoConfigurationPackages.register(registry, (String[])(new AutoConfigurationPackages.PackageImports(metadata)).getPackageNames().toArray(new String[0]));
        }

Registrar实现了ImportBeanDefinitionRegistrar接口，就可以被导入到spring容器中。

public void registerBeanDefinitions(AnnotationMetadata metadata, BeanDefinitionRegistry registry) {
            AutoConfigurationPackages.register(registry, (String[])(new AutoConfigurationPackages.PackageImports(metadata)).getPackageNames().toArray(new String[0]));
        }

给上面registerBeanDefinitions方法打上断点，运行一下SpringBoot我们可以看到：

new AutoConfigurationPackages.PackageImports(metadata)).getPackageNames().toArray(new String[0])的值为class com.apesource.demo00000001（当前类的包名）
由此可以看出：@AutoConfigurationPackage是将其所在的包下的所有组件扫描注册至spring容器。

@Import({AutoConfigurationImportSelector.class})：
作用：开启自动配置类的导包选择器，由它来进行有选择性的导入。
点开AutoConfigurationImportSelector.class可以看到：

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

selectImports方法：选择需要导入的组件。
其中：getAutoConfigurationEntry是根据导入的annotationMetadata返回AutoConfigurationImportSelector.AutoConfigurationEntry

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);
        }
    }

在 List configurations = this.getCandidateConfigurations(annotationMetadata, attributes)打上断点运行可以看到：

这里有127个配置类供SpringBoot去选择配置。

点开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;
    }

一直跟进我们发现最终会调用到这个方法loadSpringFactories，从classpath下获取所有META-INF/spring.factories这个文件下的信息。
loadSpringFactories()该方法就是从“META-INF/spring.factories”中加载给定类型的工厂实现的完全限定类名放到map中，loadFactoryNames()根据SpringBoot的启动生命流程，当需要加载自动配置类时，就会传入org.springframework.boot.autoconfigure.EnableAutoConfiguration参数，从map中查找key为org.springframework.boot.autoconfigure.EnableAutoConfiguration的值，这些值通过反射加到容器中，从而实现自动配置。