SpringBoot自动配置原理分析

分手后的思念是犯贱 2024-04-08 12:31 125阅读 0赞

> 基于上一篇：Springboot启动流程分析，里面比较重要的一个环节就是Springboot自动配置。Springboot的自动配置原理也是老八股文面试题了，对于自动配置的详细实现过程还需从源码层面剖析，这样对知识理解会更加深刻。Springboot实现自动配置其实是参照了Java SPI的思想，对于Java SPI，后面会写一篇文章详细总结。

## @SpringBootApplication ##

// java元注解 修饰自定义注解的注解
    @Target({
        ElementType.TYPE}) // 定义注解作用的范围 （类、属性、方法）
    @Retention(RetentionPolicy.RUNTIME) // 定义注解的生命周期（注解保留多久  编译期、运行期）
    @Documented // javadoc
    @Inherited // 修饰的自定义注解可被子类继承
    
    @SpringBootConfiguration
    @EnableAutoConfiguration
    @ComponentScan( excludeFilters = {
        @Filter(type = FilterType.CUSTOM, classes = {
        TypeExcludeFilter.class}), 
    				@Filter(type = FilterType.CUSTOM, classes = {
        AutoConfigurationExcludeFilter.class})})
    public @interface SpringBootApplication {

![@SpringBootApplication复合注解分析][SpringBootApplication]  
![自动配置全流程][de340d8f5aaa45a987bb153cf8b2de0e.png]

### @ComponentScan ###

@ComponentScan注解用于定义 Spring 的扫描路径，等价于在 xml 文件中配置 context:component-scan  
假如不配置扫描路径，那么 Spring 就会默认扫描当前类所在的包及其子包中的所有通过 @Component，@Service，@Controller 等注解修饰的类（相当于扫描自定义的配置类。Spring容器在启动的时候，加载配置类的顺序是：先扫描加载自定义配置类，后扫描加载自动配置类）

### @SpringBootConfiguration ###

@Target(ElementType.TYPE)
    @Retention(RetentionPolicy.RUNTIME)
    @Documented
    @Configuration // 保证bean的唯一性
    public @interface SpringBootConfiguration {
        
    
    	@AliasFor(annotation = Configuration.class)
    	boolean proxyBeanMethods() default true; // 默认使用CGLIB代理该类
    
    }

@SpringBootConfiguration 相当于 @Configuration  
可以简单理解：

*  @Configuration，加上这个注解就是为了让当前类作为一个配置类交由 Spring 的 IOC 容器进行管理，一般配合@Bean注解一起使用
 *  用于替代spring的配置文件，@Configuration 等价于< beans >标签，@Bean 等价于 < bean >标签。@Component，@Service，@Mapper，@Controller这些注解也都等价于< bean >标签

> @Configuration和@Component的区别

*  @Component：会当做配置类，但不会为其生成CGLIB代理class
 *  @Configuration：会当做配置类，会为其生成CGLIB代理class
 *  在获取当前类名时，使用@Component获取的是当前类名；而@Configuration获取的是当前类名+唯一标识(CGLIB代理)

### @EnableAutoConfiguration ###

是实现自动配置的关键，由 @AutoConfigurationPackage 和 @Import 注解组成的复合注解

@AutoConfigurationPackage
    @Import({
        AutoConfigurationImportSelector.class}) // 导入参数类到IOC
    public @interface EnableAutoConfiguration {
        
        String ENABLED_OVERRIDE_PROPERTY = "spring.boot.enableautoconfiguration";
    
        Class<?>[] exclude() default {
        };
    
        String[] excludeName() default {
        };
    }

#### @AutoConfigurationPackage ####

主要作用是保存扫描路径

@Import({
        Registrar.class}) // 保存扫描路径，提供给Spring-data-jpa查询
    public @interface AutoConfigurationPackage {
        
        String[] basePackages() default {
        };
    
        Class<?>[] basePackageClasses() default {
        };
    }

#### @Import ####

@Import是Springboot自动配置的核心注解，@Import注解导入类的方式分为三种：

1.  参数如果是 ImportBeanDefinitionRegistrar 的实现类，支持手工注册bean
2.  参数如果是 ImportSelector 的实现类，注册 selectImports 返回的数组（类的全路径）到IOC容器 批量注册
3.  参数如果是普通类，会将该类实例化，交给IOC容器管理 （除开上面两种，都是普通类）

而Springboot选择的是第二种导入类的方式，这种方式的特点是：无侵入

### SpringBoot自动配置核心方法 ###

Springboot启动类执行run()方法后，通过@Import(\{AutoConfigurationImportSelector.class\}) 会执行 AutoConfigurationImportSelector类中的selectImports方法

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

protected AutoConfigurationImportSelector.AutoConfigurationEntry getAutoConfigurationEntry(AnnotationMetadata annotationMetadata) {
        
    	if (!this.isEnabled(annotationMetadata)) {
        
    		return EMPTY_ENTRY;
    	} else {
        
    		// 1. 获取annotationMetadata的注解 @EnableAutoConfiguration 的属性
    		AnnotationAttributes attributes = this.getAttributes(annotationMetadata);
    		// 2. 从资源文件spring.factories中获取EnableAutoConfiguration对应的所有类
    		List<String> configurations = this.getCandidateConfigurations(annotationMetadata, attributes);
    		configurations = this.removeDuplicates(configurations); // 去重
    		// 3. 通过在@EnableAutoConfiguration设置的exclude相关属性，排除指定的自动配置类
    		Set<String> exclusions = this.getExclusions(annotationMetadata, attributes);
    		this.checkExcludedClasses(configurations, exclusions);
    		configurations.removeAll(exclusions);
    		// 4. 根据注解 @Conditional来判断是否需要排除某些自动配置类
    		configurations = this.getConfigurationClassFilter().filter(configurations);
    		// 5. 触发 AutoConfiguration导入的相关事件
    		this.fireAutoConfigurationImportEvents(configurations, exclusions);
    		// 6. 将经过去重，校验的候选bean封装成 AutoConfigurationEntry 对象返回
    		return new AutoConfigurationImportSelector.AutoConfigurationEntry(configurations, exclusions);
    	}
    }

protected List<String> getCandidateConfigurations(AnnotationMetadata metadata, AnnotationAttributes attributes) {
        
    	// 通过SpringFactories机制，从配置文件spring.factories中找出所有的自动配置类
    	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;
    }

![在这里插入图片描述][658753fb6a104f54bb08fd0c3cb16424.png]

@Conditional，是来自Spring框架的一个注解，它的作用是实现只有在特定条件满足的情况下，才会向IoC容器注册指定的组件。可以将其理解为某种if语句

![在这里插入图片描述][b235118ec9ad4598995b5320d9f3ea0e.png]

### 总结SpringBoot自动配置的全流程 ###

![在这里插入图片描述][16c8061a5b0c4753bce6acdb6d7aedba.png]

### 参考链接 ###

1.  [【B站目前讲的最透彻的SpringBoot自动配置，大厂面试必备知识点\#安员外很有码】 ][B_SpringBoot_]

[SpringBootApplication]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/08/dfed2ecb6fc74e55b9e26d3d243e07c9.png
[de340d8f5aaa45a987bb153cf8b2de0e.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/08/ba55a455f1b744879a04bea6555a5a80.png
[658753fb6a104f54bb08fd0c3cb16424.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/08/bb8951dd272f47a0a380afa3a047ed58.png
[b235118ec9ad4598995b5320d9f3ea0e.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/08/1475591c2aeb422e97ac4118650131eb.png
[16c8061a5b0c4753bce6acdb6d7aedba.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/08/3ec145cfde1c480bb5bec0e062f4299f.png
[B_SpringBoot_]: https://www.bilibili.com/video/BV1NY411P7VX?share_source=copy_web&vd_source=9a5e0b25634e26cf2e0ccc09fabf93ff