Spring Boot 自动装配原理，你知道吗？

前言

假如你在面试过程中被问到 Spring Boot 自动装配原理，你该如何回答？
没有深入了解的小伙伴一下子就被问蒙了，这还是我认识的 Spring Boot 吗？心想说：我不会。但是对于简历上写着掌握 Spring Boot 却又有点说不过去，于是进入尴尬的境地。
所以为了避免上述问题，请认真阅读本篇文章，我将通过以下三个方面来解答该问题。

1、什么是 Spring Boot 自动装配？
2、Spring Boot 自动装配如何实现？
3、如何自己动手创建一个Spring Boot Starter？

有木有觉得这三个问题有点熟悉？确实，像人生的“灵魂三问” - “你是谁？”“你来自哪？”“你要去哪儿？”,
这个问题虽在哲学界是自古到今无解的难题，但在我们学习一个新知识点时，却是要走的三步 - 这是什么？它用在哪？该怎么用？即使在有些文章中没有提及，我们也要认真思考下这三步走，才能更深入的学会一个新的知识点。

啥？你讲知识就讲知识，谈什么人生哲学！哼~

好了废话不多讲，带着三问，直接开整~

1、什么是 Spring Boot 自动装配？

Spring Boot 自己定义的一套接口规范，这套规范规定：Spring Boot 在启动时会扫描外部应用 jar 包中的 META-INF/spring.factories 文件，然后将文件中配置的类加载到 Spring 容器。
有没有觉得是 SPI 的方式，感兴趣的小伙伴可以去深入了解，这里就不深入探讨。

2、Spring Boot 自动装配如何实现？

需要注意：此处使用的版本是 Spring Boot 2.7.4 ，不同版本之间可能源码会有所不同。

细心的小伙伴可能会发现，我们在创建 Spring Boot 项目时，在启动类上都有一个注解 @SpringBootApplication，没错我们的问题从这里展开。

进入 @SpringBootApplication 之后，我们把焦点放到 @EnableAutoConfiguration，它的作用就是启动 Spring Boot 的自动配置。

继续进入 @EnableAutoConfiguration 注解

可以看到，他有两个重要的注解：
@AutoConfigurationPackage：将添加该注解的类所在的package 作为 自动配置 package 进行管理，也就说包下的所有组件自动注册到容器中
@Import({AutoConfigurationImportSelector.class})：加载自动装配类

我们把焦点放到 AutoConfigurationImportSelector 类上

可以看到，该类实现了 DeferredImportSelector 接口，也就实现了里面的 selectImports 方法

isEnabled(annotationMetadata)：是否启用自动配置，默认开启。
getAutoConfigurationEntry(annotationMetadata)：获取所有需要自动装配的类

紧接着，我们继续查看 getAutoConfigurationEntry() 方法，看它内部是如何实现的。

1、获取 @EnableAutoConfiguration 配置的 exclude 和 excludeName 用于排除相关类不自动装配
2、获取所有 Spring Boot Starter META-INF/spring.factories 文件所有自动装配类
然后进行一去重、排除、过滤，剩下的配置类将会被加载到 Spring 容器中。

此处可能有小伙伴会有疑问：所有配置类都会生效吗？

答案是否定的，在 过滤 里 getConfigurationClassFilter().filter(configurations) ，它会通过类似 @ConditionalOnXX注解去过滤出满足条件的类。就拿 @ConditionalOnMissingBean 来说，当容器里没有指定 Bean 时才会装载，也可以说是按需加载。你已经有了，那就用你的，没有的话就用我的。

以下配上 spring.factories 文件内容

1、文件位置以及我用的版本为 2.7.4，此版本相对于 2.7 之前的版本会有所改动。

这里引用官方版本更新描述：

Spring Boot 2.7 已不推荐使用 spring.factories

自动配置更改为：多加了一级 spring 目录，并创建红框命名文件

Spring Boot 3.0 将删除 Spring Boot 2.x 不推荐类、方法、和属性。

可能有小伙伴会有疑问，spring.factories 都快删掉了，还在跟我讲~
这里我解释下：因为 Spring Boot 2.7.x 是这个文件的过渡版本，它同时存在两个文件，起到兼顾 2.7 版本之前的小伙伴们，也可以通过对比看出其中的变化。

3、如何自己动手创建一个Spring Boot Starter？

spring-boot-starter 目录结构：

│  pom.xml
│
├─src
│  └─main
│      ├─java
│      │  └─com
│      │      └─cpz
│      │          └─starter
│      │              ├─bean
│      │              │      MyBean.java
│      │              │
│      │              └─config
│      │                  │  BeanConfig.java
│      │                  │
│      │                  └─props
│      │                          BeanProperties.java
│      │
│      └─resources
│          └─META-INF
│                  spring.factories

核心类：BeanConfig.java

解析：
1、@EnableConfigurationProperties(BeanProperties.class)：启用读取配置文件配置，其中BeanProperties 包含两个属性 enable 是否启用被注解类 和 name 用于测试输出不同名字。
2、@ConditionalOnClass(MyBean.class)：确保 MyBean.class 存在。
3、@ConditionalOnProperty(prefix = "bean", name = "enable", matchIfMissing = true)：配置文件中
bean.enable 属性为 true 时加载，缺失为 true。
4、@ConditionalOnMissingBean(MyBean.class)：容器中没有 MyBean.class 时创建。

自动装配：spring.factories

最后，在新项目中使用：
pom.xml

<dependency>
    <groupId>com.cpz</groupId>
    <artifactId>spring-boot-starter</artifactId>
    <version>${revision}</version>
</dependency>

application.yml

bean:
  enable: true
  name: 我的第一个 Spring Boot Starter

IndexController.java

private final MyBean myBean;

@Operation(summary = "测试自定义 Spring Boot Starter")
@GetMapping("/bean/test")
public String beanTest() {
    return myBean.sayHi();
}

输出结果：

总结

Spring Boot 通过 @EnableAutoConfiguration开启自动装配，通过加载文件 META-INF/spring.factories（Spring Boot 2.7 以上版本 META-INF/spring/%s.imports） 中的配置类实现自动装配，通过
@ConditionalOnXX 按需加载。

示例代码

「学习交流」

可以扫下面二维码，关注「我的极简博客」公众号。

一直在追求思路的传递而非代码的COPY