SpringBoot2.3.x 自动配置原理

短命女 2022-12-21 03:27 134阅读 0赞

下面关于SpringBoot2.3.x 自动配置原理的介绍，纯属自己的见解，如有不恰当之处，请留言指正。  
SpringBoot在启动时会去依赖的Starter包中寻找resources/META-INF/spring.factories文件，然后根据文件中配置的jar包去扫描项目所依赖的jar包。根据spring.factories配置加载AutoConfigure类，根据@Conditional注解的条件，进行自动配置并将Bean注入Spring Context中，供项目启动成功后使用。

# @SpringBootApplication 注解 #

在某个类上加上@SpringBootApplication注解，则说明：

*  这个类是 SpringBoot 的主配置类。
 *  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 { 
       //省略相关代码
    }

可以看到 SpringBootApplication 注解是一个组合注解，其主要组合了一下三个注解：

*  @SpringBootConfiguration：该注解表示这是一个 SpringBoot 的配置类，其实它就是一个 @Configuration 注解而已。
 *  @ComponentScan：开启组件扫描。
 *  @EnableAutoConfiguration：就是这个类开启的自动配置。

## @EnableAutoConfiguration 注解 ##

@EnableAutoConfiguration 注解的源码如下：

@Target(ElementType.TYPE)
    @Retention(RetentionPolicy.RUNTIME)
    @Documented
    @Inherited
    @AutoConfigurationPackage
    @Import(AutoConfigurationImportSelector.class)
    public @interface EnableAutoConfiguration { 
    
    	String ENABLED_OVERRIDE_PROPERTY = "spring.boot.enableautoconfiguration";
    
    	/** * Exclude specific auto-configuration classes such that they will never be applied. * @return the classes to exclude */
    	Class<?>[] exclude() default { };
    
    	/** * Exclude specific auto-configuration class names such that they will never be * applied. * @return the class names to exclude * @since 1.3.0 */
    	String[] excludeName() default { };
    
    }

可以看到@EnableAutoConfiguration 注解由@AutoConfigurationPackage和@Import(AutoConfigurationImportSelector.class)组合而成，通过打断点发现：先执行@Import(AutoConfigurationImportSelector.class)注解，然后执行@AutoConfigurationPackage注解。

### @Import(AutoConfigurationImportSelector.class) ###

下面看下AutoConfigurationImportSelector.class导入后是如何执行的，SpringBoot项目启动后，执行到下面的方法：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L21hbWVuZzE5ODg_size_16_color_FFFFFF_t_70_pic_center]  
我们看到获取自动配置类数组的方法是getAutoConfigurationEntry(annotationMetadata)：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L21hbWVuZzE5ODg_size_16_color_FFFFFF_t_70_pic_center 1]  
然后由getCandidateConfigurations(annotationMetadata, attributes)方法获取自动配置类的完整类路径并放入list中：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L21hbWVuZzE5ODg_size_16_color_FFFFFF_t_70_pic_center 2]  
我们看到了获取自动配置类的完整类路径的list是由SpringFactoriesLoader的loadFactoryNames(getSpringFactoriesLoaderFactoryClass(),  
getBeanClassLoader())方法来完成的，其中getSpringFactoriesLoaderFactoryClass()方法：  
![在这里插入图片描述][20201114162900940.png_pic_center]  
就是获取EnableAutoConfiguration这个注解。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L21hbWVuZzE5ODg_size_16_color_FFFFFF_t_70_pic_center 3]  
我们看到loadFactoryNames这个方法调用了loadSpringFactories(classLoader)：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L21hbWVuZzE5ODg_size_16_color_FFFFFF_t_70_pic_center 4]  
首先从缓存中获取自动配置类的完整类路径，如果为空，则通过classLoader.getResources(FACTORIES\_RESOURCE\_LOCATION)方法转成Properties后获取，最后再放入到缓存中，其中，FACTORIES\_RESOURCE\_LOCATION：  
“META-INF/spring.factories”。即：

*  从当前项目的类路径中获取所有 META-INF/spring.factories 这个文件下的信息。
 *  将上面获取到的信息封装成一个 Map 返回。
 *  从返回的 Map 中通过刚才传入的 EnableAutoConfiguration.class 参数，获取该 key 下的所有值。

#### META-INF/spring.factories ####

我们来看一下 META-INF/spring.factories 这类文件是什么。当然在很多第三方依赖中都会有这个文件，一般每导入一个第三方的依赖，除了本身的jar包以外，还会有一个 xxx-spring-boot-autoConfigure，这个就是第三方依赖自己编写的自动配置类。我们现在就以 spring-boot-autocongigure 这个依赖来说。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L21hbWVuZzE5ODg_size_16_color_FFFFFF_t_70_pic_center 5]  
可以看到 EnableAutoConfiguration 下面有很多类，这些就是我们项目进行自动配置的类。

到这里，AutoConfigurationImportSelector.class就完成了将类路径下 META-INF/spring.factories 里面配置EnableAutoConfiguration 的全路径类加入到 Spring 容器中。然后开始执行selectImports()：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L21hbWVuZzE5ODg_size_16_color_FFFFFF_t_70_pic_center 6]  
这个方法的作用就是查找导入的自动配置类并进行排序后返回。  
然后我们看看@AutoConfigurationPackage

### @AutoConfigurationPackage ###

从字面意思理解就是自动配置包。点进去可以看到就是一个 @Import 注解：@Import(\{Registrar.class\})，导入了一个 Registrar 的组件。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L21hbWVuZzE5ODg_size_16_color_FFFFFF_t_70_pic_center 7]  
然后getPackageNames()方法点进去之后：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L21hbWVuZzE5ODg_size_16_color_FFFFFF_t_70_pic_center 8]  
可以看到返回了一个包名，该包名其实就是主配置类所在的包。然后点击register方法进去：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L21hbWVuZzE5ODg_size_16_color_FFFFFF_t_70_pic_center 9]  
打断点发现：BeanDefinitionRegistry就是DefaultListableBeanFactory，如果这里面的beanDefinitionMap不包含“org.springframework.boot.autoconfigure.AutoConfigurationPackages”，则new一个GenericBeanDefinition为beanDefinition，并将“主配置类所在的包路径”set进去，然后以“org.springframework.boot.autoconfigure.AutoConfigurationPackages”为beanName，刚才新建的beanDefinition为BeanDefinition放入到DefaultListableBeanFactory的beanDefinitionMap中。register方法执行结束后，可以看到：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L21hbWVuZzE5ODg_size_16_color_FFFFFF_t_70_pic_center 10]  
故@AutoConfigurationPackage 注解就是将主配置类（@SpringBootConfiguration标注的类）的所在包及下面所有子包里面的所有组件扫描到Spring容器中。  
register方法执行结束后，接着往下执行，可以看到：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L21hbWVuZzE5ODg_size_16_color_FFFFFF_t_70_pic_center 11]  
继续向下执行：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L21hbWVuZzE5ODg_size_16_color_FFFFFF_t_70_pic_center 12]  
继续执行，可以看到进入到了AbstractApplicationContext的refresh()方法中，即ServletWebServerApplicationContext的refresh()方法，  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L21hbWVuZzE5ODg_size_16_color_FFFFFF_t_70_pic_center 13]  
而这个refresh()方法最终是由SpringApplication的refresh方法调用：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L21hbWVuZzE5ODg_size_16_color_FFFFFF_t_70_pic_center 14]  
可以看到这里是AnnotationConfigServletWebServerApplicationContext的DefaultListableBeanFactory中的beanDefinitionMap里面由362(数字和你的项目有关)个beanDefinition。继续走：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L21hbWVuZzE5ODg_size_16_color_FFFFFF_t_70_pic_center 15]  
从上图中可以看到，是由SpringApplication的refreshContext()方法执行调用的，最终执行到了：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L21hbWVuZzE5ODg_size_16_color_FFFFFF_t_70_pic_center 16]  
到这SpringBoot的自动配置就结束了，即META-INF/spring.factories中的自动配置类和主配置类(@SpringBootConfiguration标注的类)的所在包及下面所有子包里面的所有类都加载到AnnotationConfigServletWebServerApplicationContext的DefaultListableBeanFactory中的beanDefinitionMap里面。

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L21hbWVuZzE5ODg_size_16_color_FFFFFF_t_70_pic_center]: /images/20221120/e1a800accddf4c64b8718f84327f86d3.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L21hbWVuZzE5ODg_size_16_color_FFFFFF_t_70_pic_center 1]: /images/20221120/8f17330fdd7c40d2adf29b405d078a81.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L21hbWVuZzE5ODg_size_16_color_FFFFFF_t_70_pic_center 2]: /images/20221120/2f33037d3efe4876ae33dc7af63bdbf8.png
[20201114162900940.png_pic_center]: /images/20221120/81811d3019a44290a843a9b7e76a9a4e.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L21hbWVuZzE5ODg_size_16_color_FFFFFF_t_70_pic_center 3]: /images/20221120/1b29b91bf0984acfb772680238330315.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L21hbWVuZzE5ODg_size_16_color_FFFFFF_t_70_pic_center 4]: /images/20221120/34b200963e574982a83b90ec3b2aacce.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L21hbWVuZzE5ODg_size_16_color_FFFFFF_t_70_pic_center 5]: /images/20221120/c6e677d20806417d9af4a45a3b5bc625.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L21hbWVuZzE5ODg_size_16_color_FFFFFF_t_70_pic_center 6]: /images/20221120/09c5634aa6a74e89baee62614459bbb5.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L21hbWVuZzE5ODg_size_16_color_FFFFFF_t_70_pic_center 7]: /images/20221120/bdff96d59a364941b1b1ab99c0be4ab0.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L21hbWVuZzE5ODg_size_16_color_FFFFFF_t_70_pic_center 8]: /images/20221120/edc8a4f5237f4b0f8dcf2b69200ae5d1.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L21hbWVuZzE5ODg_size_16_color_FFFFFF_t_70_pic_center 9]: /images/20221120/d2abcd6253dd4d31b0bd6ab8afc32160.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L21hbWVuZzE5ODg_size_16_color_FFFFFF_t_70_pic_center 10]: /images/20221120/4d3004dec2914378b2142aee5ac7325e.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L21hbWVuZzE5ODg_size_16_color_FFFFFF_t_70_pic_center 11]: /images/20221120/abc75766d8e14b5dbb4b24e68cf46b0b.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L21hbWVuZzE5ODg_size_16_color_FFFFFF_t_70_pic_center 12]: /images/20221120/2144038245e64e41815838b3ab31b972.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L21hbWVuZzE5ODg_size_16_color_FFFFFF_t_70_pic_center 13]: /images/20221120/a150a5032d994133ac381b9cd5c8fc4d.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L21hbWVuZzE5ODg_size_16_color_FFFFFF_t_70_pic_center 14]: /images/20221120/d8ce3606896c4bc2bdb871bba1789518.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L21hbWVuZzE5ODg_size_16_color_FFFFFF_t_70_pic_center 15]: /images/20221120/f8fc21eb65614656a211333a556edb8a.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L21hbWVuZzE5ODg_size_16_color_FFFFFF_t_70_pic_center 16]: /images/20221120/7e8b1a7ee04043dcb1278abbc8cd5b71.png