SpringBoot自动配置原理

SpringBoot自动配置原理

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 {}

发现除元注解信息外，包含三个关键注解

1、@SpringBootConfiguration

其主要作用为标识此类为配置类（@Configuration）

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Configuration
@Indexed
public @interface SpringBootConfiguration {}

2、@ComponentScan

指定包扫描注解

3、@EnableAutoConfiguration

@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、@Import

@AutoConfigurationPackage

查看主要作用为给容器中导入Registrar组件

@Import({Registrar.class}) // 给容器中导入一个组件
public @interface AutoConfigurationPackage {}

Registrar组件的作用为：

利用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]));
    }

    public Set<Object> determineImports(AnnotationMetadata metadata) {
        return Collections.singleton(new AutoConfigurationPackages.PackageImports(metadata));
    }
}

我们对**(new AutoConfigurationPackages.PackageImport(metadata)).getPackageName()**，进行检索（idea工具可以圈出需要查询的值，使用快捷键“alt+F8”），看看其结果是什么？

因此可以得知使用@AutoConfigurationPackage注解就是将主程序类所在包及所有子包下的组件到扫描到spring容器中。

@Import({AutoConfigurationImportSelector.class})

导入AutoConfigurationImportSelector类，其关键点在于其selectImports方法。selectImports()方法返回一个String类型数组，数组里面放的是类的全限定名，Spring会把这个数组内全限定名表示的类全部都加载到Spring容器当中。

说的更明确些：@EnableAutoConfiguration就是借助@Import来收集所有符合自动配置条件的bean定义，并加载到IOC容器。

1、使用 getAutoConfigurationEntry 给容器批量导入自动配置组件

public String[] selectImports(AnnotationMetadata annotationMetadata) {
    if (!this.isEnabled(annotationMetadata)) {
        return NO_IMPORTS;
    } else {
        // 使用 getAutoConfigurationEntry 给容器批量导入自动配置组件
        AutoConfigurationImportSelector.AutoConfigurationEntry autoConfigurationEntry = this.getAutoConfigurationEntry(annotationMetadata);
        return StringUtils.toStringArray(autoConfigurationEntry.getConfigurations());
    }
}

2、使用 getCandidateConfigurations 获取所有候选的组件

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

3、使用 SpringFactories工厂加载 得到对应组件， this.getSpringFactoriesLoaderFactoryClass() 为 EnableAutoConfiguration.class自动配置类

protected List<String> getCandidateConfigurations(AnnotationMetadata metadata, AnnotationAttributes attributes) {
    List<String> configurations = 
        //  SpringFactoriesLoader 加载得到对应组件
        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;
}

public static List<String> loadFactoryNames(Class<?> factoryType, @Nullable ClassLoader classLoader) {
    String factoryTypeName = factoryType.getName();
    return (List)loadSpringFactories(classLoader).getOrDefault(factoryTypeName, Collections.emptyList());
}

loadSpringFactories 方法从程序依赖包中读取 META-INF/spring.factories位置的文件

如 spring-boot-autoconfigure-2.3.9.RELEASE.jar ，META-INF/spring.factories文件中写死了程序启动需要加载的所有自动配置类

4、按需加载对应bean

META-INF/spring.factories中所定义的自动配置类并不会全部加载到IOC容器中，其会按照条件@Condition装配的规则按需加载对应的bean。例如spring-boot-autoconfigure-2.3.9.RELEASE.jar 下的 RabbitAutoConfiguration rabbit自动加载类。

总结

springboot底层实现

自动配置的步骤

1、springboot主启动类启动；

2、主启动类注解 @SpringBootApplication 生效；

3、@EnableAutoConfiguration 开启自动配置注解生效；

4、@AutoConfigurationPackage 执行 @Import({Registrar.class})，通过 Registrar 类扫描主程序类所在包及所有子包下的组件注册到spring容器中；

5、@Import(AutoConfigurationImportSelector.class) ：导入AutoConfigurationImportSelector类，通过selectImports方法按需装配自定义配置类至spring容器中；

自动装配的总结

1、SpringBoot先加载所有的自动配置类 xxxxxAutoConfiguration

2、每个自动配置类按照条件进行生效，部分配置类会绑定配置文件xxxxProperties中指定的值。xxxxProperties和配置文件application.yml进行绑定。

3、生效的配置类会给容器中装配很多组件

4、只要容器中有这些组件，相当于这些功能就有了

5、定制化配置

​ 用户直接自己@Bean替换底层的组件

​ 用户去看这个组件是获取的配置文件什么值就去修改

on

2、每个自动配置类按照条件进行生效，部分配置类会绑定配置文件xxxxProperties中指定的值。xxxxProperties和配置文件application.yml进行绑定。

3、生效的配置类会给容器中装配很多组件

4、只要容器中有这些组件，相当于这些功能就有了

5、定制化配置

​ 用户直接自己@Bean替换底层的组件

​ 用户去看这个组件是获取的配置文件什么值就去修改

xxxxxAutoConfiguration --> 组件 --> xxxxProperties --> application.yml