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 配置的 excludeexcludeName 用于排除相关类不自动装配
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

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 217,907评论 6 506
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,987评论 3 395
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 164,298评论 0 354
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,586评论 1 293
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,633评论 6 392
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,488评论 1 302
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,275评论 3 418
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,176评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,619评论 1 314
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,819评论 3 336
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,932评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,655评论 5 346
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,265评论 3 329
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,871评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,994评论 1 269
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,095评论 3 370
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,884评论 2 354

推荐阅读更多精彩内容