SpringBoot 自动装配原理

刺骨的言语ヽ痛彻心扉 2023-09-23 14:10 147阅读 0赞

> 早期的`Spring`项目需要添加需要配置繁琐的`xml`,比如`MVC`、事务、数据库连接等繁琐的配置。`Spring Boot`的出现就无需这些繁琐的配置，因为`Spring Boot`基于**约定大于配置**的理念，在项目启动时候，将约定的配置类自动配置到`IOC`容器里。这些都因为`Spring Boot`有自动配置的特性。

# Sping Boot 如何实现自动配置 #

`Spring Boot`都需要创建一个`mian`启动类，而启动类都含有`@SpringBootApplication`注解，从启动类，一步步探索源码。

## @SpringBootApplication注解 ##

`Spring Boot` 启动类上都有一个 `@SpringBootApplication`注解：

![format_png][]

## @EnableAutoConfiguration注解 ##

`@SpringBootApplication` 里面有 `@EnableAutoConfiguration` 的注解：

![format_png 1][]

## AutoConfigurationImportSelector类 ##

`@EnableAutoConfiguration`注解导入`AutoConfigurationImportSelector`类：

![format_png 2][]

## selectImports()方法 ##

`AutoConfigurationImportSelector`类找到 `selectImports` 方法，里面有`getAutoConfigurationEntry`方法：

![format_png 3][]

## SpringFactoriesLoader.loadFactoryNames() 方法 ##

`getAutoConfigurationEntry`方法通过`SpringFactoriesLoader.loadFactoryNames()` 扫描所有含有`META-INF/spring.factories`的`jar`包：

![format_png 4][]

![format_png 5][]

![format_png 6][]

![format_png 7][]

`spring-boot-autoconfigure-xxx.jar`项目包含`META-INF/spring.factories`文件，`spring.factories`是一个键值对的形式，扫描该文件下`@EnableAutoConfiguration`对应类：

![format_png 8][]

> 自动配置主要由`@EnableAutoConfiguration`实现，添加了`@EnableAutoConfiguration`注解，会导入`AutoConfigurationImportSelector`类，里面的`selectImports`方法通过`SpringFactoriesLoader.loadFactoryNames()`扫描所有含有`META-INF/spring.factories`的`jar`包,将对应`key`为`@EnableAutoConfiguration`注解全名对应的`value`类全部装配到`IOC`容器中。

## Debug 验证 ##

打开`Debug`调式模式，在`getCandidateConfigurations`方法里面的`SpringFactoriesLoader.loadFactoryNames()`处设置断点，查看返回的`configurations`集合：

![format_png 9][]

第一个元素是`tk.mybatis.mapper.autoconfigure.MapperAutoConfiguration`是因为引入了`通用mapper`的依赖：

![format_png 10][]

# 自动配置原理 #

## 原理流程汇总 ##

从上面查看的源码，可以知道`Spring Boot`自动配置主要是`@EnableAutoConfiguration`实现的，`@EnableAutoConfiguration`注解导入`AutoConfigurationImportSelector`类,通过`selectImports`方法调用`SpringFactoriesLoader.loadFactoryNames()`扫描所有含有`META-INF/spring.factories`文件的`jar`包，将`spring.factories`文件中`@EnableAutoConfiguration`对应的类注入到`IOC`容器中。

这些属性自动配置到`IOC`之后就无需自己手动配置`bean`了，`Spring Boot`中的`约定大于配置`理念，约定是将需要的配置以约定的方式添加到`IOC`容器中。

## 自动配置生效条件 ##

那是不是`spring.factories`文件对应的配置都会加载到`IOC`容器中？比如下面的`Kafka`自动配置类：

@Configuration
    @ConditionalOnClass(KafkaTemplate.class)
    @EnableConfigurationProperties(KafkaProperties.class)
    @Import({ KafkaAnnotationDrivenConfiguration.class, KafkaStreamsAnnotationDrivenConfiguration.class })
    public class KafkaAutoConfiguration {
    
    	private final KafkaProperties properties;
    
    	private final RecordMessageConverter messageConverter;
    
    	public KafkaAutoConfiguration(KafkaProperties properties, ObjectProvider<RecordMessageConverter> messageConverter) {
    		this.properties = properties;
    		this.messageConverter = messageConverter.getIfUnique();
    	}
    
    	@Bean
    	@ConditionalOnMissingBean(KafkaTemplate.class)
      public KafkaTemplate<?, ?> kafkaTemplate(ProducerFactory<Object, Object> kafkaProducerFactory,
    			ProducerListener<Object, Object> kafkaProducerListener) {
          ....
          }
    复制代码

其中有几个注解：

@ConditionalOnClass
    @ConditionalOnMissingBean
    复制代码

*  `@ConditionalOnClass`表示在类路径中存在类才会配置该配置类。只有引入相关依赖才会自动配置该配置类。
 *  `@ConditionalOnMissingBean`表示只有不存在对应的类的`bean`才会自动配置该类。

所以`spring.factories`里面并不是所有的`bean`都会装配到`IOC`容器中，只会按需配置对应的`bean`。

# 总结 #

*  `Spring Boot`自动配置原理
    
     *  1、`@EnableAutoConfiguration`注解导入`AutoConfigurationImportSelector`类。
     *  2、执行`selectImports`方法调用`SpringFactoriesLoader.loadFactoryNames()`扫描所有`jar`下面的对应的`META-INF/spring.factories`文件.
     *  3、限定为`@EnableAutoConfiguration`对应的`value`，将这些装配条件的装配到`IOC`容器中。
 *  自动装配简单来说就是自动将第三方的组件的`bean`装载到`IOC`容器内，不需要再去写`bean`相关的配置，符合**约定大于配置**理念。
 *  `Spring Boot`基于**约定大于配置**的理念，配置如果没有额外的配置的话，就给按照默认的配置使用约定的默认值，按照约定配置到`IOC`容器中，无需开发人员手动添加配置，加快开发效率。

[format_png]: https://img-blog.csdnimg.cn/img_convert/144edeb17aa40b722f0dda707aa0200c.webp?x-oss-process=image/format,png
[format_png 1]: https://img-blog.csdnimg.cn/img_convert/03a4c26cdf75d13c100c45f901d94401.webp?x-oss-process=image/format,png
[format_png 2]: https://img-blog.csdnimg.cn/img_convert/30ecaa20565f7896b8c7d5e50308509e.webp?x-oss-process=image/format,png
[format_png 3]: https://img-blog.csdnimg.cn/img_convert/683d299d9cea6430c16a964615914fd3.webp?x-oss-process=image/format,png
[format_png 4]: https://img-blog.csdnimg.cn/img_convert/222a72e76d57877315c393949cb74d6f.webp?x-oss-process=image/format,png
[format_png 5]: https://img-blog.csdnimg.cn/img_convert/ab345bab480596225cf277072ab0f0f1.webp?x-oss-process=image/format,png
[format_png 6]: https://img-blog.csdnimg.cn/img_convert/9f2fcc0f8cf803cb6dd95c2edd0438c3.webp?x-oss-process=image/format,png
[format_png 7]: https://img-blog.csdnimg.cn/img_convert/e4d80ee8eeb1ee1e6a67963dc2ff5fac.webp?x-oss-process=image/format,png
[format_png 8]: https://img-blog.csdnimg.cn/img_convert/b9ab2c7027900087748743311f503de8.webp?x-oss-process=image/format,png
[format_png 9]: https://img-blog.csdnimg.cn/img_convert/9d6e764f73cc8dad7c03d5ebeda27748.webp?x-oss-process=image/format,png
[format_png 10]: https://img-blog.csdnimg.cn/img_convert/87b5169aaa17377512a7843749951561.webp?x-oss-process=image/format,png