Springboot 自动装配原理探索

简介: 官网介绍先来看看官网是怎么定义这个自动装配的~Spring Boot auto-configuration attempts to automatically configure your Spring application based on the jar dependencies that you have added可以看到这里说,当你引入了某个 jar 依赖包时,Springboot 会尝试根据这个依赖去自动配置 Spring 应用程序。

官网介绍



先来看看官网是怎么定义这个自动装配的~


Spring Boot auto-configuration attempts to automatically configure your Spring application based on the jar dependencies that you have added


可以看到这里说,当你引入了某个 jar 依赖包时,Springboot 会尝试根据这个依赖去自动配置 Spring 应用程序。


You need to opt-in to auto-configuration by adding the @EnableAutoConfiguration or @SpringBootApplication annotations to one of your @Configuration classes.


而且这里还说明了,你应该在 一个配置类 @Configuration 上选择 @EnableAutoConfiguration@SpringBootApplication 这其中的一个注解,来让自动配置生效.


网络异常,图片无法展示
|


那么,知道这些信息后,我们就开始愉快的看源码环节了~ 冲冲冲!😄


对了,探索的 Springboot 版本为 2.4.5


@SpringBootApplication


来到 @SpringBootApplication 注解中,可以发现它是一个组合注解,除了前面四个基本的元注解外,还有下面这三个 @SpringBootConfiguration@EnableAutoConfiguration@ComponentScan


源码如图


网络异常,图片无法展示
|


@SpringBootConfiguration


我们先来看这第一个注解,如图,可以发现它其实是一个 @Configuration 注解,

@Configuration 注解的作用是将其作为一个配置类,来配置 Spring 的上下文,相当于 SpringXML 配置文件中的 <beans>


源码如图


网络异常,图片无法展示
|


@ComponentScan


这个的作用就是 扫描指定路径下的组件,并加入到 IOC 容器 中,相当于

SpringXML 配置文件中的 <context:component-scan/>


源码如图


网络异常,图片无法展示
|


可以发现它里面有一个 @Repeatable(ComponentScans.class) 注解,表示可重复使用@ComponentScan 注解


网络异常,图片无法展示
|


注意,这里会按照我们自定义的方式去排除一些类,具体是通过实现 TypeFilter 接口并重写 match 方法来实现 。


小细节


这里还有个点要注意下~😄


AutoConfigurationExcludeFilter 会检查配置类,如果该配置类和 META-INF/spring.factories 文件中的 EnableAutoConfiguration 对应的配置类一样的话,会被排除掉~


@EnableAutoConfiguration


终于,来到本文的重点了  🐷


看到它的名字就知道它就是这个 自动配置 的主角了


源码如图


网络异常,图片无法展示
|


可以发现它是一个组合注解


先来看看这个注解1@AutoConfigurationPackage


@AutoConfigurationPackage


从名字就可以看出它是一个 自动配置包路径 的注解


源码如图


网络异常,图片无法展示
|


从这段注释我们可以发现,当没有配置这个 basePackages 或者

basePackageClasses 时,这个类就会自动将该注解所在的包作为基本路径进行注册

接着,我们再来看看这个框框里的内容~


@Import(AutoConfigurationPackages.Registrar.class) 🐷


@Import


先来看看这个注解的作用吧😋


源码如图


网络异常,图片无法展示
|


可以发现它的作用也很简单,就是导入组件,比如常见的 @Configuration 类或者ImportSelectorImportBeanDefinitionRegistrar实现类,或者其他一些常规的组件如 @Component@Service 等等


Registrar


继续看看这个 @Import(AutoConfigurationPackages.Registrar.class) ,可以发现该注解导入的是 Registrar 类 🐷 , 那么我们继续探索下,看看它干了什么~😄


源码如图


从该类的注解可以看出,它的作用是通过 ImportBeanDefinitionRegistrar **来保存这个基本包的路径的 **


网络异常,图片无法展示
|



那么,讲完第一点 ,我们简单了解到这个 @AutoConfigurationPackage  就是用来配置基本包 ,我们接着再来看看第二点,这个 @Import(AutoConfigurationImportSelector.class) 注解。


我们可以发现它导入了 AutoConfigurationImportSelector 类。


AutoConfigurationImportSelector


看这个名称,可以大概知道它是一个 组件选择器


关键步骤介绍


process


这个方法在获取这些 Import 类时会被调用,具体可以看结尾的流程图~


网络异常,图片无法展示
|


getAutoConfigurationEntry


获取自动配置实体类 ,里面还有本文的重点~


网络异常,图片无法展示
|


getCandidateConfigurations


来到这里,可以发现它调用到这个 SpringFactoriesLoader ,这里就不得不提下这个 SpringbootSPI 机制了,另外它和我们上文(服务发现机制SPI居然是破坏者?! )中提到的 Java Spi 有什么不同呢 ?


再继续往下看一下~😝


网络异常,图片无法展示
|


Springboot SPI机制


老规矩,看一眼注释先 哈哈😄


网络异常,图片无法展示
|


spring.factories 文件


举个栗子😄


# Run Listeners
org.springframework.boot.SpringApplicationRunListener=\
org.springframework.boot.context.event.EventPublishingRunListener
复制代码


可以发现它加载的是  META-INF/spring.factories 这个文件 ,相比 java 的  META-INF/services ,有以下的不同点:


  1. 从名字上就可以发现很大的不同( 一个是 factories 文件,一个是以接口全名命名的文件 )。


  1. spring.factories  以一个聚合的作用,把相应的接口和实现类以  key = value 形式展现在 spring.factories 文件中。


  1. spring.factories  中的所有配置项会加载到我们的缓存中,以  Map<String,List<String>> 形式存储,但不是所有的都会被实例化,被加载到 IOC 容器中,除了必要的类外( EventPublishingRunListener 等 ),还有满足特定条件下的自动配置类会被加载到 IOC 容器中


满足特定条件 ☞ 比如有没有使用到这个依赖( pom 中的 starter


自动配置类 ☞ 指以 AutoConfiguration 结尾的那些类


可以发现这种按需实现的机制比java的一股脑实现灵活多了~  😄


实例解析


比如 这里从 spring.factories  文件中加载了130个自动配置类


网络异常,图片无法展示
|


但是实际使用中,经过过滤后只有这 30 个了


网络异常,图片无法展示
|


这里还根据 优先级 做了一些排序~ 🐷


网络异常,图片无法展示
|


自动装配流程图



这里只摘了一些关键步骤~ ,具体流程太长了 ,得从 SpringApplication 源码中的 refreshContext(context);   这里就先不介绍啦,后面有时间再写一下分享下这个 [[Springboot源码的启动过程]]


网络异常,图片无法展示
|


同颜色的类名和方法块对应~


图中左下角的 processImports 方法,就是将这些自动配置类进行实例化,包括配置类里面的 @Import@Bean 等  ,一步步加载到 SpringIOC 容器中。


总结


一. Springboot 的自动装配很重要的一点就是,就是要在配置类上开启 @EnableAutoConfiguration 或者 @SpringBootApplication  注解,来让自动配置生效


二. 自动配置的核心是 SpringbootSPI 机制 ,以及组件选择器AutoConfigurationImportSelector,具体是通过其中的 getAutoConfigurationEntry 方法来获取 SPI 中的自动配置类并进行过滤,最后通过 processImports 将配置类加载到 IOC 容器中,完成自动配置



目录
相关文章
|
3月前
|
人工智能 Java 开发者
【Spring】原理解析:Spring Boot 自动配置
Spring Boot通过“约定优于配置”的设计理念,自动检测项目依赖并根据这些依赖自动装配相应的Bean,从而解放开发者从繁琐的配置工作中解脱出来,专注于业务逻辑实现。
1396 0
|
5月前
|
Java Spring 容器
SpringBoot自动配置的原理是什么?
Spring Boot自动配置核心在于@EnableAutoConfiguration注解,它通过@Import导入配置选择器,加载META-INF/spring.factories中定义的自动配置类。这些类根据@Conditional系列注解判断是否生效。但Spring Boot 3.0后已弃用spring.factories,改用新格式的.imports文件进行配置。
967 0
|
2月前
|
JavaScript Java Maven
【SpringBoot(二)】带你认识Yaml配置文件类型、SpringMVC的资源访问路径 和 静态资源配置的原理!
SpringBoot专栏第二章,从本章开始正式进入SpringBoot的WEB阶段开发,本章先带你认识yaml配置文件和资源的路径配置原理,以方便在后面的文章中打下基础
336 3
|
2月前
|
XML Java 应用服务中间件
【SpringBoot(一)】Spring的认知、容器功能讲解与自动装配原理的入门,带你熟悉Springboot中基本的注解使用
SpringBoot专栏开篇第一章,讲述认识SpringBoot、Bean容器功能的讲解、自动装配原理的入门,还有其他常用的Springboot注解!如果想要了解SpringBoot,那么就进来看看吧!
443 2
|
5月前
|
前端开发 Java 数据库连接
SpringBoot参数校验底层原理和实操。深度历险、深度解析(图解+秒懂+史上最全)
SpringBoot参数校验底层原理和实操。深度历险、深度解析(图解+秒懂+史上最全)
SpringBoot参数校验底层原理和实操。深度历险、深度解析(图解+秒懂+史上最全)
|
9月前
|
Java Spring
SpringBoot自动配置原理
本文深入解析了SpringBoot的核心功能——自动配置,重点探讨了`org.springframework.boot.autoconfigure`及相关注解的工作机制。通过分析`@SpringBootApplication`、`@EnableAutoConfiguration`等注解,揭示了SpringBoot如何基于类路径和条件自动装配Bean
480 8
|
11月前
|
Dart 前端开发 JavaScript
springboot自动配置原理
Spring Boot 自动配置原理:通过 `@EnableAutoConfiguration` 开启自动配置,扫描 `META-INF/spring.factories` 下的配置类,省去手动编写配置文件。使用 `@ConditionalXXX` 注解判断配置类是否生效,导入对应的 starter 后自动配置生效。通过 `@EnableConfigurationProperties` 加载配置属性,默认值与配置文件中的值结合使用。总结来说,Spring Boot 通过这些机制简化了开发配置流程,提升了开发效率。
329 17
springboot自动配置原理
|
9月前
|
Java
SpringBoot自动装配的原理
在SpringBoot项目的启动引导类上都有一个注解@SpringBootApplication 这个注解是一个复合注解, 其中有三个注解构成 , 分别是 ● @SpringBootConfiguration : 是@Configuration的派生注解 , 标注当前类是一个SpringBoot的配置类 ● @ComponentScan : 开启组件扫描, 默认扫描的是当前启动引导了所在包以及子包 ● @EnableAutoConfiguration : 开启自动配置(自动配置核心注解) 2.在@EnableAutoConfiguration注解的内容使用@Import注解导入了一个AutoC
|
9月前
|
JavaScript 前端开发 Java
Idea启动SpringBoot程序报错:Veb server failed to start. Port 8082 was already in use;端口冲突的原理与解决方案
本文解决了Idea启动SpringBoot程序报错:Veb server failed to start. Port 8082 was already in use的问题,并通过介绍端口的使用原理和操作系统的端口管理机制,可以更有效地解决端口冲突问题,并确保Web服务器能够顺利启动和运行。 只有锻炼思维才能可持续地解决问题,只有思维才是真正值得学习和分享的核心要素。如果这篇博客能给您带来一点帮助,麻烦您点个赞支持一下,还可以收藏起来以备不时之需,有疑问和错误欢迎在评论区指出~
|
10月前
|
Java 数据库 开发者
详细介绍SpringBoot启动流程及配置类解析原理
通过对 Spring Boot 启动流程及配置类解析原理的深入分析,我们可以看到 Spring Boot 在启动时的灵活性和可扩展性。理解这些机制不仅有助于开发者更好地使用 Spring Boot 进行应用开发,还能够在面对问题时,迅速定位和解决问题。希望本文能为您在 Spring Boot 开发过程中提供有效的指导和帮助。
1271 12