最新版 | 深入剖析SpringBoot3源码——分析自动装配原理(面试常考)

news2024/12/28 2:34:37

文章目录

  • 一、自动配置概念
  • 二、半自动配置(误~🙏🙏)
  • 三、源码分析
    • 1、验证DispatcherServlet的自动配置
    • 2、源码分析入口@SpringBootApplication
    • 3、@SpringBootConfiguration的@Configuration
    • 4、@EnableAutoConfiguration的@AutoConfigurationPackage和@Import
    • 5、AutoConfigurationImportSelector类
    • 6、selectImports()方法
    • 7、getAutoConfigurationEntry()方法
    • 8、getCandidateConfigurations()方法
    • 9、AutoConfiguration.imports配置文件
    • 10、DispatcherServletAutoConfiguration类
    • 11、@AutoConfiguration和@ConditionalOnClass
    • 12、DispatcherServletConfiguration内部类
  • 四、不同版本SpringBoot自动配置的区别
  • 五、面试话术:说一说SpringBoot自动配置原理?


SpringBoot的自动装配原理是现在面试中常考的一道面试题。本文基于最新的 SpringBoot 3.3.3 版本的源码来分析自动装配的原理,并在文末说明了SpringBoot2和SpringBoot3的自动装配源码中区别,以及面试回答的拿分核心话术。


一、自动配置概念

自动装配:遵循约定大约配置的原则,在boot程序启动后,起步依赖中的一些bean对象会自动注入到ioc容器。

  • 自动装配的例子:对于SpringBoot整合MyBatis时的自动配置效果,我们只需要引入MyBatis的起步依赖,这个时候像SqlSessionFactoryBean这样的bean对象就自动注入到ioc容器里面了,无需写响应的配置类。

二、半自动配置(误~🙏🙏)

首先我们来看一下下面的代码是自动装配吗?

可以看到在启动类中我们需要自己写配置类,并手动使用@Import注解导入配置类。因此,这显然没有达到自动配置的效果。

那么下面我们通过翻看源码的方式,看看自动装配是怎么回事?


三、源码分析

1、验证DispatcherServlet的自动配置

在分析自动配置源码之前,我们将以SpringMVC中的DispatcherServlet类为例,来展示SpringBoot的自动配置过程。首先验证一个问题:程序引入spring-boot-starter-web起步依赖,启动后,SpringBoot会自动往ioc容器中注入DispatcherServlet

这里我们在pom文件中仅引入了SpringBoot核心起步依赖spring-boot-starter,并没有引入web的起步依赖。

<dependencies>
    <!-- SpringBoot核心起步依赖 -->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter</artifactId>
    </dependency>

    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-test</artifactId>
        <scope>test</scope>
    </dependency>
</dependencies>

在启动类SpringbootAutoConfigApplication中,我们尝试从ioc容器中获取dispatcherServlet,输出一下。

@SpringBootApplication
public class SpringbootAutoConfigApplication {
    public static void main(String[] args) {
        // 获取run方法返回的ioc容器
        ApplicationContext context = SpringApplication.run(SpringbootAutoConfigApplication.class, args);
        // 尝试从ioc容器中获取dispatcherServlet
        System.out.println(context.getBean("dispatcherServlet"));
    }
}

结果如我们所想,Spring没有注册dispatcherServlet的bean对象,无法从ioc容器中获取该对象。

接下来我们引入spring-boot-starter-web起步依赖:

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
</dependency>

刷新maven后,再次运行发现可以获取到dispatcherServlet对象。

2、源码分析入口@SpringBootApplication

@SpringBootApplication是一个组合注解,它组合了@SpringBootConfiguration@EnableAutoConfiguration@ComponentScan三个核心注解。

@Target(ElementType.TYPE)	//注解的适用范围,Type表示注解可以描述在类、接口、注解或枚举中
@Retention(RetentionPolicy.RUNTIME)	//表示注解的生命周期,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注解的注解组成图:

其中@ComponentScan是bean扫描注解,我们主要来说一下 @SpringBootConfiguration@EnableAutoConfiguration

3、@SpringBootConfiguration的@Configuration

  • @SpringBootConfiguration也是一个组合注解,组合了@Configuration,说明我们的启动类也是一个配置类。
@Target(ElementType.TYPE)	//元注解
@Retention(RetentionPolicy.RUNTIME)	//元注解
@Documented	//元注解

@Configuration	//核心注解
@Indexed	//spring5.0后新增的 索引注解,可以提高启动速度
public @interface SpringBootConfiguration {
	@AliasFor(annotation = Configuration.class)
	boolean proxyBeanMethods() default true;

}

4、@EnableAutoConfiguration的@AutoConfigurationPackage和@Import

  • @EnableAutoConfiguration是实现自动配置的核心注解,标识开启自动配置功能,是SpringBoot最重要的注解。同样作为组合注解,它组合了 @AutoConfigurationPackage@Import。其中@Import导入注解导入了一个AutoConfigurationImportSelector.class

从后缀可以看出,ImportSelector作为一个接口,@Import主要导入两种类,一种是配置类,一种是ImportSelector的实现类。

5、AutoConfigurationImportSelector类

接下来进入AutoConfigurationImportSelector类,它实现了DeferredImportSelector接口,而DeferredImportSelector接口继承了父接口ImportSelector

也就是说AutoConfigurationImportSelector类也实现了ImportSelector接口,也就必然要重写selectImports()方法。这里使用Ctrl+F12快捷键,输入selectImports搜索该类中的方法。

6、selectImports()方法

selectImports()方法会被Spring自动地调用,该方法的作用是得到返回的全类名字符串数组,把这些全类名的bean对象注册到ioc容器里面。

这里说明一下,由于AutoConfigurationImportSelector没有直接实现ImportSelector接口,而是实现的DeferredImportSelector接口,SpringBoot对于DeferredImportSelector接口的实现类有另外一组处理流程,这个流程中并不会去调用selectImports()方法。虽然SpringBoot不会自动地去调用,但是我们通过这个selectImports()方法去翻看自动配置的原理是没有问题的。

7、getAutoConfigurationEntry()方法

SpringBoot并不会直接硬编码写死返回字符串数组,而是通过从配置文件中读取的方式返回字符串数组。
接下来我们重点来看它读取的配置文件在哪里,最后一句中它将autoConfigurationEntry.getConfigurations()的结果作为参数转换为字符串数组。autoConfigurationEntry对象是通过上面的getAutoConfigurationEntry()方法得到的。

因此,我们猜想getAutoConfigurationEntry()方法里面应该需要知道配置文件在哪里,继续跟进这个方法。

这个方法的最后return了这个AutoConfigurationEntry对象,在构造这个对象时传入了两个参数configurationsexclusions,很明显configurations才和配置相关,而在上面通过getCandidateConfigurations()方法得到了configurations集合,所以我们继续观察getCandidateConfigurations()

8、getCandidateConfigurations()方法

getCandidateConfigurations()方法内部,ImportCandidates.load()方法加载了AutoConfiguration.class,下面还有一段断言,意思是加载后configurations不能为空,如果为空了就提示"No auto configuration classes found in META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports.",即要在AutoConfiguration.imports找一些自动配置类,但是没有找到。

protected List<String> getCandidateConfigurations(AnnotationMetadata metadata, AnnotationAttributes attributes) {
    List<String> configurations = ImportCandidates.load(AutoConfiguration.class, this.getBeanClassLoader()).getCandidates();
    Assert.notEmpty(configurations, "No auto configuration classes found in META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports. If you are using a custom packaging, make sure that file is correct.");
    return configurations;
}

9、AutoConfiguration.imports配置文件

那这个.imports配置文件在哪里找呢?答案是从pom文件中的SpringBoot核心起步依赖spring-boot-starter找,Ctrl+左键点击跟进。

在它里面又引入了一个spring-boot-autoconfigure,autoconfigure顾名思义是自动配置。

此时我们从项目左侧External Libraries点开找到Maven: org.springframework,boot:spring-boot-autoconfigure:3.3.3,里面提供了一个jar包,在META-INF目录下的spring文件夹下,存放这org.springframework.boot.autoconfigure.AutoConfiguration.imports配置文件。

这个AutoConfiguration.imports配置文件就是SpringBoot自动配置的核心配置文件。点开可以发现里面存放着很多自动配置类的全类名。其中就有关于DispatcherServlet的自动配置类DispatcherServletAutoConfiguration

10、DispatcherServletAutoConfiguration类

DispatcherServletAutoConfiguration这个类上添加了一个@AutoConfiguration,还有一个@ConditionalOnClass({DispatcherServlet.class})

11、@AutoConfiguration和@ConditionalOnClass

@AutoConfiguration注解内部也是一个组合注解,其中有@Configuration,也就是说明DispatcherServletAutoConfiguration是一个Spring的配置类。@Configuration封装在@AutoConfiguration中是为了更加见名知意,说明DispatcherServletAutoConfiguration这个类就是为了完成自动配置的。

另外,还有一个注册条件注解@ConditionalOnClass({DispatcherServlet.class}),意思是如果我们的环境里面有DispatcherServlet,则注入DispatcherServletAutoConfiguration的bean对象。反之如果是环境里面没有DispatcherServlet,DispatcherServletAutoConfiguration就不注入从而不生效。这也就是我们验证时为什么说只有引入了web起步依赖,SpringBoot才能帮我们自动注入DispatcherServlet。

12、DispatcherServletConfiguration内部类

源码我们再往下翻看,其中有一个内部类DispatcherServletConfiguration,@Configuration说明内部类也是一个配置类,它提供了一个方法,方法名为dispatcherServlet,返回值类型是DispatcherServlet,方法内部new了一个DispatcherServlet对象并返回,并且在方法上添加了@Bean注解。此时我们终于发现注入DispatcherServlet对象的地方在这里!

这里最核心的地方就在于,SpringBoot把这个自动配置类的全类名写到.imports文件里面了,SpringBoot就能够自动读取全类名,并把配置类对象注册到Spring的IOC容器里面。又由于配置类内部还有配置类,而且内部配置类里面还有一些方法添加了@Bean注解,Spring会继续解析,直到把这些有@Bean的方法都解析到并执行方法,最后把返回值注入到ioc容器里面。

以上就是通过深入分析SpringBoot源码,来理解自动装配的原理。


四、不同版本SpringBoot自动配置的区别

特别注意,当前网上的大部分自动装配原理的分析文章都是基于SpringBoot3以下,使用的是spring.factories作为配置文件进行自动装配,SpringBoot3以上的版本自动配置读取的核心配置文件为:AutoConfiguration.imports。

  • springboot2.7版本以前,自动配置使用的配置文件为:spring-factories,会从这个文件中读取自动配置类的全类名
  • springboot2.7到3.0以前,同时兼容了AutoConfiguration.imports和spring-factories文件
  • springboot3.0以后,自动配置只支持AutoConfiguration.imports文件

那么上图对于如何改造之前非自动装配的案例给出了基本的步骤。相信学习完上面的自动装配原理后,会思考如何将自己的模块改造成SpringBoot可以自动装配的模块,这也就是SpringBoot如何自定义starter。


五、面试话术:说一说SpringBoot自动配置原理?

在这里插入图片描述

SpringBoot自动装配的原理:首先在主启动类添加了@SpringBootApplication注解,这个注解组合了@EnableAutoConfiguration注解,而它又组合了@Import注解,导入了AutoConfigrationImportSelector类,这个类实现了selectImports方法,这个方法经过层层调用,最终会读取META-INF目录下的后缀名为.imports的文件,在文件中读取到了全类名之后,会解析注册条件,也就是@Conditional及其衍生注解,把满足注册条件的Bean对象自动注入到IOC容器中。


本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.coloradmin.cn/o/2113153.html

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈,一经查实,立即删除!

相关文章

猜测、实现 B 站在看人数

猜测、实现 B 站在看人数 猜测找到接口参数总结 实现 猜测 找到接口 浏览器打开一个 B 站视频&#xff0c;比如 《黑神话&#xff1a;悟空》最终预告 | 8月20日&#xff0c;重走西游_黑神话悟空 (bilibili.com) &#xff0c;打开 F12 开发者工具&#xff0c;经过观察&#xf…

【数据结构初阶】链表分类与双向带头循环链表接口实现

文章目录 1. 链表的分类2. 双向带头循环链表接口实现2. 1 结点声明2. 2 创建链表节点2. 3 初始化链表2. 4 打印链表2. 5 尾插2. 6 判空2. 7 尾删2. 8 头插2. 9 头删2. 10 查找2. 11 在指定位置删除与插入2. 12 销毁 3. 链表接口测试4. 单链表与双链表5. 顺序表与链表 1. 链表的…

Python安装:Mac 使用brew 安装Python2 和 Python3

安装python ## python2 brew install python ## python3 brew install python3出现错误 Error: An unexpected error occurred during the brew link step The formula built, but is not symlinked into /usr/local Permission denied dir_s_mkdir - /usr/local/Frameworks …

根据NVeloDocx Word模板引擎生成Word(一)

自从我们基于免费开放的E6开发平台&#xff0c;实现了根据Word模版生成Word文档的模版引擎后&#xff0c;也实实在在帮助到了一些有需要的朋友。但是由于制作Word模版的过程对于很多人会是一个很头疼的事情&#xff0c;虽然提供了详细的文档&#xff0c;但是我们也经常接到他们…

EcoPaste:重塑剪切板体验,让信息管理变得前所未有的高效

前言 科技&#xff0c;是连接梦想与现实的桥梁&#xff0c;它让人类的想象力得以飞翔&#xff0c;让未来的愿景变为现实。在它的引领下&#xff0c;我们跨越了时空的界限&#xff0c;打破了传统的束缚&#xff0c;以更加开放和包容的心态去迎接生活的挑战与机遇——在看似不相…

I2VGen-XL模型构建指南

一、介绍 VGen可以根据输入的文本、图像、指定的运动、指定的主体&#xff0c;甚至人类提供的反馈信号生成高质量的视频。它还提供了各类常用的视频生成模型工具&#xff0c;例如可视化、采样、训练、推理、使用图像和视频的联合训练&#xff0c;加速等各类工具和技术。 &quo…

图像处理基础篇-镜像仿射透视

一.图像镜像 图像镜像是图像旋转变换的一种特殊情况&#xff0c;通常包括垂直方向和水平方向的镜像。水平镜像通常是以原图像的垂直中轴为中心&#xff0c;将图像分为左右两部分进行堆成变换。如图7-1所示&#xff1a; 垂直镜像通常是以原图像的水平中轴线为中心&#xff0c;将…

快速搞定“照片调色”!50000+Lr预设滤镜模板,一键让你照片不再丑!

照片调色不仅仅是调整颜色&#xff0c;更是一种艺术表达。通过巧妙地运用 LR 预设&#xff0c;可以突出照片的主题&#xff0c;增强情感共鸣。比如&#xff0c;在风景照片中&#xff0c;使用特定的预设可以让天空更蓝、草地更绿&#xff0c;让大自然的美丽更加生动地展现出来。…

Java——踩坑Arrays.asList()

坑1&#xff1a;不能直接使用 Arrsys.asList() 来转换基本类型数据 public static void test1(){// 1、不能直接使用asList来转换基本类型数组int[] arr {1, 2, 3};List list Arrays.asList(arr);System.out.printf("list:%s size:%s class:%s", list, list.size(…

【卡码网C++基础课 18.开房门】

目录 题目描述与分析一、map的基本介绍二、map的使用三、代码编写四、范围for循环 题目描述与分析 题目描述&#xff1a; 假设你手里有一串钥匙&#xff0c;这串钥匙上每把钥匙都有一个编号&#xff0c;对应着一个房门的编号。现给你一个房门编号&#xff0c;你需要判断是否能…

【虚拟化】AIO主机安装PVE8,配置网络,安装win11(virtio,qcow2,scsi,oobe,adk)

【虚拟化】AIO主机安装PVE8&#xff0c;配置网络&#xff0c;安装win11&#xff08;virtio&#xff0c;qcow2&#xff0c;scsi&#xff0c;oobe&#xff0c;adk&#xff09; 文章目录 1、ESXI vs PVE&#xff0c;AIO主机系统二选一2、PVE网络配置&#xff08;DNS&#xff0c;换…

5G前传-介绍

1. 引用 知识分享系列一&#xff1a;5G基础知识-CSDN博客 5G前传的最新进展-CSDN博客 灰光和彩光_通信行业5G招标系列点评之二&#xff1a;一文读懂5G前传-光纤、灰光、彩光、CWDM、LWDM、MWDM...-CSDN博客 术语&#xff1a; 英文缩写描述‌BBU&#xff1a;Building Baseba…

3.门锁_STM32_矩阵按键设备实现

概述 需求来源&#xff1a; 门锁肯定是要输入密码&#xff0c;这个门锁提供了两个输入密码的方式&#xff1a;一个是蓝牙输入&#xff0c;一个是按键输入。对于按键输入&#xff0c;采用矩阵按键来实现。矩阵按键是为了模拟触摸屏的按键输入&#xff0c;后续如果项目结束前还…

关于 QImage原始数据格式与cv::Mat原始数据进行手码数据转换 的解决方法

若该文为原创文章&#xff0c;转载请注明原文出处 本文章博客地址&#xff1a;https://hpzwl.blog.csdn.net/article/details/141996117 长沙红胖子Qt&#xff08;长沙创微智科&#xff09;博文大全&#xff1a;开发技术集合&#xff08;包含Qt实用技术、树莓派、三维、OpenCV…

神经网络骨架nn.Module

文章目录 一、认识nn.Module二、nn.Module的基础加1操作 一、认识nn.Module nn.Module 是 PyTorch 中的一个核心类&#xff0c;它是所有神经网络模块的基类。在 PyTorch 中构建模型时&#xff0c;通常会继承这个类来创建自定义的网络结构。nn.Module 提供了一系列用于构建神经…

MyBatis-Plus拦截器接口InnerInterceptor失效?因MyBatis缓存机制而踩的一个深坑

InnerInterceptor 接口是 MyBatis-Plus 提供的一个拦截器接口&#xff0c;用于实现一些常用的 SQL 处理逻辑。例如某个组件运作在多系统的平台上&#xff0c;不同系统需要隔离&#xff0c;于是可以通过这个拦截器接口&#xff0c;给每一条要执行的sql末尾拼接一个AND systemId …

3个恢复方法详解:iPhone手机快速找回备忘录

当我们在工作或者是学习时&#xff0c;总会有一些灵光乍现的好想法&#xff0c;我们通常会将这些想法记录在iPhone手机备忘录中&#xff0c;以便随时查看。但是&#xff0c;如果出现不慎删除备忘录的情况&#xff0c;iPhone该如何找回备忘录呢&#xff1f;不用担心&#xff0c;…

[JAVA基础知识汇总-1] 创建线程的几种方式(含线程池相关)

文章目录 1. 继承Thread类2. 实现Runnable接口3. 实现Callable接口4. 线程池4.1 利用Executors工具类来创建线程池4.2 为什么不建议使用Executors来创建线程池&#xff1f;4.3 ThreadPoolExecutor是线程池的核心实现类&#xff0c;可以利用它来创建线程池4.4 线程池的状态 可以…

数字化转型的关键指南:《数字化专业知识体系》深度剖析应用策略

数字化浪潮下的企业生存法则 随着全球企业加速数字化转型&#xff0c;如何有效应对技术变革带来的挑战和机遇成为各行业关注的焦点。传统的IT管理模式已经无法满足日益复杂的数字化需求&#xff0c;亟需一种新型、综合的知识体系来引导企业迈向成功。《数字化专业知识体系》&a…

【MySQL】MySQL基础

目录 什么是数据库主流数据库基本使用MySQL的安装连接服务器服务器、数据库、表关系使用案例数据逻辑存储 MySQL的架构SQL分类什么是存储引擎 什么是数据库 mysql它是数据库服务的客户端mysqld它是数据库服务的服务器端mysql本质&#xff1a;基于C&#xff08;mysql&#xff09…