SpringBoot自动配置源码调试

简介: SpringBoot自动配置源码调试

之前对SpringBoot的自动配置原理进行了较为详细的介绍(https://www.cnblogs.com/stm32stm32/p/10560933.html),接下来就对自动配置进行源码调试,探究下这个配置过程中各参数的情况。


  这里对AutoConfigurationImportSelector类的selectImports()方法打了4处断点,将着重对这4处进行调试。



第一处断点:



该方法的源码如下:



这一步就是将META-INF/spring-autoconfigure-metadata.properties文件中的键值对放入AutoConfigurationMetadataLoader的内部类


PropertiesAutoConfigurationMetadata的Properties对象中,共有485个元素。



第二处断点:



这个方法的源码如下:


其中的name就是org.springframework.boot.autoconfigure.EnableAutoConfiguration类:



下面的方法中的metadata.getAnnotationAttributes(name, true)获取到的值如下:




这里还利用断言进行attributes是否为null判断,若为null,则提示No auto-configuration attributes found. Is com.SpringbootApplication annotated with EnableAutoConfiguration ?



最终得到的attributes为:



第三处断点:



getCandidateConfigurations方法定义如下:



其中的getSpringFactoriesLoaderFactoryClass()返回的是EnableAutoConfiguration.class。



进入loadFacotryNames()方法进行调试:



factoryClassName的值为org.springframework.boot.autoconfigure.EnableAutoConfiguration。

常量FACTORIES_RESOURCE_LOCATION = "META-INF/spring.factories"。


下面的方法通过类加载器获取jar包中所有META-INF/spring.factories并获取其中的内容:



最后的urls包含扫描到3个jar包中有spring.factories文件:



接下来对urls进行3次遍历:


第一次遍历的文件路径

url=jar:file:/C:/Users/Alan/.m2/repository/org/springframework/boot/spring-boot/1.5.17.RELEASE/spring-boot-1.5.17.RELEASE.jar!/META-INF/spring.factories

通过Properties properties = PropertiesLoaderUtils.loadProperties(new UrlResource(url));得到的properties对象的大小为7:



因为上述properties并不存在

org.springframework.boot.autoconfigure.EnableAutoConfiguration的key,

所以String factoryClassNames = properties.getProperty(factoryClassName);得到的factoryClassNames为null



此时存放自动配置类的list集合result的大小仍然为0。

第二次遍历的文件路径url=jar:file:/C:/Users/Alan/.m2/repository/org/springframework/boot/spring-boot-autoconfigure/1.5.17.RELEASE/spring-boot-autoconfigure-1.5.17.RELEASE.jar!/META-INF/spring.factories

该文件也有7个键值对,新生成的properties大小为7:



此时properties.getProperty(factoryClassName)将能找到key=org.springframework.boot.autoconfigure.EnableAutoConfiguration的属性键值对。

factoryClassNames此时包含了org.springframework.boot.autoconfigure.EnableAutoConfiguration对应的value值,最后全部添加到list集合里面,共有96个值(Arrays.asList转换得到):



第三次遍历jar:file:/C:/Users/Alan/.m2/repository/org/springframework/spring-beans/4.3.20.RELEASE/spring-beans-4.3.20.RELEASE.jar!/META-INF/spring.factories

但是里面仍然没有org.springframework.boot.autoconfigure.EnableAutoConfiguration的key,所以result里面并没有添加新元素。


总共进行了3次遍历,分别是下面3个jar包包含spring.factories文件:

1、spring-boot-1.5.17.RELEASE.jar

2、spring-boot-autoconfigure-1.5.17.RELEASE.jar

3、spring-beans-4.3.20.RELEASE.jar


而上述3个jar的spring.factories只有spring-boot-autoconfigure-1.5.17.RELEASE.jar中包含org.springframework.boot.autoconfigure.EnableAutoConfiguration的key,这样就把需要自动配置的候选类都找出并放入list集合中。


接着还会用断言判断configurations是否有元素,否则提示:No auto configuration classes found in META-INF/spring.factories. If you  are using a custom packaging, make sure that file is correct.



最后返回自动配置类的list集合对象configurations。


第四处断点:



filter方法传入了2个参数:


1、configurations:读取MEAT-INF/spring.factories文件得到的经过排除得到的自动配置类名的list集合



2、autoConfigurationMetadata:读取META-INF/spring-autoconfigure-metadata.properties文件得到的485个键值对。



候选自动配置类数组candidates 由configurations转数组而来:String[] candidates = configurations.toArray(new String[configurations.size()]);其值如下:



for循环中的getAutoConfigurationImportFilters定义如下:



里面的SpringFactoriesLoader.loadFactories()方法定义如下:



上述方法主要目的是找寻spring.factories文件中

key=org.springframework.boot.autoconfigure.AutoConfigurationImportFilter对应的值,


这里依然进行了3次遍历,分别是下面3个jar包包含spring.factories文件


1、spring-boot-1.5.17.RELEASE.jar

2、spring-boot-autoconfigure-1.5.17.RELEASE.jar

3、spring-beans-4.3.20.RELEASE.jar

而上述3个jar的spring.factories只有spring-boot-autoconfigure-1.5.17.RELEASE.jar中包含了org.springframework.boot.autoconfigure.AutoConfigurationImportFilter的key。


通过loadFactoryNames(factoryClass, classLoaderToUse)得到的factoryNames为org.springframework.boot.autoconfigure.condition.OnClassCondition类。



接着遍历factoryNames,调用instantiateFactory方法,利用反射生成condition.OnClassCondition的实例添加到result集合中:



最后对result进行排序并返回:AnnotationAwareOrderComparator.sort(result);


getAutoConfigurationImportFilters()分析完了,我们继续看for循环:



上面的invokeAwareMethods(filter)方法根据filter是否实现了相关接口,对其进行了设置:


filter满足instance instanceof Aware、instance instanceof BeanClassLoaderAware、instance instanceof BeanFactoryAware。


接下来我们着重看下match方法:



上述方法调用了OnClassCondition类的match方法:



传入的参数是之前排除过自动配置类,目前还有96个:



下面的方法利用autoConfigurationMetadata对象对autoConfigurationClasses进行处理,autoConfigurationMetadata是加载META-INF/spring-autoconfigure-metadata.properties得到的485个元素,autoConfigurationClasses是读取META-INF/spring.factories文件key为org.springframework.boot.autoconfigure.EnableAutoConfiguration得到值进行排除、排序、去重等操作得到的候选自动配置类(由于没有添加排除项,目前仍然有96个)。



getOutComes定义如下:



该方法将自动候选配置类分成2半进行条件判断处理,outcomes存入的是条件判断后的结果:



匹配结束后的ConditionEvaluationReport对象report存放了不匹配的结果,从结果中看到候选的96个自动配置类,有72个不满足条件而被过滤:



随便点开一个outcomes元素:


org.springframework.boot.autoconfigure.aop.AopAutoConfiguration -> key=org.springframework.boot.autoconfigure.aop.AopAutoConfiguration;

匹配失败原因@ConditionalOnClass did not find required classes 'org.aspectj.lang.annotation.Aspect', 'org.aspectj.lang.reflect.Advice'

由于项目没有引入Aop的相关依赖,导致类路径中没有Aspect和Advice类,因此AopAutoConfiguration这个自动配置类匹配失败,无法进行自动配置。


(1) META-INF/spring-autoconfigure-metadata.properties文件中的Aop内容:


org.springframework.boot.autoconfigure.aop.AopAutoConfiguration.Configuration=

org.springframework.boot.autoconfigure.aop.AopAutoConfiguration=

org.springframework.boot.autoconfigure.aop.AopAutoConfiguration.ConditionalOnClass=

org.springframework.context.annotation.EnableAspectJAutoProxy,org.aspectj.lang.annotation.Aspect,org.aspectj.lang.reflect.Advice


(2) META-INF/spring.factories中的Aop内容:


org.springframework.boot.autoconfigure.EnableAutoConfiguration=\

org.springframework.boot.autoconfigure.aop.AopAutoConfiguration,\

因此spring.factories中的key=org.springframework.boot.autoconfigure.EnableAutoConfiguration对应的值只是候选的自动配置类;

能否成功配置,关键还要看是否已经被排除以及是否满足spring-autoconfigure-metadata.properties中对对应配置类的加载条件。

若不满足,则该类是会从自动配置类列表中排除,这样能加快springboot的启动速度。spring官方文档(https://docs.spring.io/spring-boot/docs/current/reference/html/boot-features-developing-auto-configuration.html)对该文件的作用描述如下:

Spring Boot uses an annotation processor to collect the conditions on auto-configurations in a metadata file (META-INF/spring-autoconfigure-metadata.properties). If that file is present, it is used to eagerly filter auto-configurations that do not match, which will improve startup time.

然后根据匹配结果,将真正满足配置条件的配置类放入list集合中  boolean[] skip记录了对应的候选自动配置类是否需要跳过,true-不满足条件,需要跳过,false-满足条件,不需要跳过。



for循环结束,只有24个自动配置真正符合条件:




因此第四处断点走完,真正符合自动配置条件类的自动配置类只有24个了(根据项目配置情况会有所不同):



至此,SpringBoot自动配置源码调试告一段落,总结如下:


1、读取META-INF/spring-autoconfigure-metadata.properties文件中的内容;

2、获取需要排除的自动配置类;

3、读取spring-boot-autoconfigure-1.5.17.RELEASE.jar中的META-INF/spring.factories文件内容,作为候选自动配置类;

4、对候选自动配置类进行去重、排序、去除所有排除项;

5、利用META-INF/spring-autoconfigure-metadata.properties文件的配置对META-INF/spring.factories经历第四步处理后的候选自动配置类进行过滤,去除不满足加载条件的类,得到最终的自动配置类供SpringBoot加载。



相关文章
|
20天前
|
数据采集 监控 前端开发
二级公立医院绩效考核系统源码,B/S架构,前后端分别基于Spring Boot和Avue框架
医院绩效管理系统通过与HIS系统的无缝对接,实现数据网络化采集、评价结果透明化管理及奖金分配自动化生成。系统涵盖科室和个人绩效考核、医疗质量考核、数据采集、绩效工资核算、收支核算、工作量统计、单项奖惩等功能,提升绩效评估的全面性、准确性和公正性。技术栈采用B/S架构,前后端分别基于Spring Boot和Avue框架。
|
5天前
|
Java 开发者 微服务
手写模拟Spring Boot自动配置功能
【11月更文挑战第19天】随着微服务架构的兴起,Spring Boot作为一种快速开发框架,因其简化了Spring应用的初始搭建和开发过程,受到了广大开发者的青睐。自动配置作为Spring Boot的核心特性之一,大大减少了手动配置的工作量,提高了开发效率。
20 0
|
1月前
|
Java API 数据库
构建RESTful API已经成为现代Web开发的标准做法之一。Spring Boot框架因其简洁的配置、快速的启动特性及丰富的功能集而备受开发者青睐。
【10月更文挑战第11天】本文介绍如何使用Spring Boot构建在线图书管理系统的RESTful API。通过创建Spring Boot项目,定义`Book`实体类、`BookRepository`接口和`BookService`服务类,最后实现`BookController`控制器来处理HTTP请求,展示了从基础环境搭建到API测试的完整过程。
42 4
|
1月前
|
Java 数据库连接 Maven
springBoot:项目建立&配置修改&yaml的使用&resource 文件夹(二)
本文档介绍了如何创建一个基于Maven的项目,并配置阿里云仓库、数据库连接、端口号、自定义启动横幅及多环境配置等。同时,详细说明了如何使用YAML格式进行配置,以及如何处理静态资源和模板文件。文档还涵盖了Spring Boot项目的`application.properties`和`application.yaml`文件的配置方法,包括设置数据库驱动、URL、用户名、密码等关键信息,以及如何通过配置文件管理不同环境下的应用设置。
|
29天前
|
Java API 数据库
Spring Boot框架因其简洁的配置、快速的启动特性及丰富的功能集而备受开发者青睐
本文通过在线图书管理系统案例,详细介绍如何使用Spring Boot构建RESTful API。从项目基础环境搭建、实体类与数据访问层定义,到业务逻辑实现和控制器编写,逐步展示了Spring Boot的简洁配置和强大功能。最后,通过Postman测试API,并介绍了如何添加安全性和异常处理,确保API的稳定性和安全性。
36 0
|
9天前
|
缓存 IDE Java
SpringBoot入门(7)- 配置热部署devtools工具
SpringBoot入门(7)- 配置热部署devtools工具
20 2
 SpringBoot入门(7)- 配置热部署devtools工具
|
8天前
|
Java 数据库连接
SpringBoot配置多数据源实战
第四届光学与机器视觉国际学术会议(ICOMV 2025) 2025 4th International Conference on Optics and Machine Vision
35 8
|
6天前
|
Java 数据库连接 数据库
springboot启动配置文件-bootstrap.yml常用基本配置
以上是一些常用的基本配置项,在实际应用中可能会根据需求有所变化。通过合理配置 `bootstrap.yml`文件,可以确保应用程序在启动阶段加载正确的配置,并顺利启动运行。
12 2
|
17天前
|
Java Spring 容器
SpringBoot读取配置文件的6种方式,包括:通过Environment、@PropertySource、@ConfigurationProperties、@Value读取配置信息
SpringBoot读取配置文件的6种方式,包括:通过Environment、@PropertySource、@ConfigurationProperties、@Value读取配置信息
43 3
|
19天前
|
JavaScript Java 项目管理
Java毕设学习 基于SpringBoot + Vue 的医院管理系统 持续给大家寻找Java毕设学习项目(附源码)
基于SpringBoot + Vue的医院管理系统,涵盖医院、患者、挂号、药物、检查、病床、排班管理和数据分析等功能。开发工具为IDEA和HBuilder X,环境需配置jdk8、Node.js14、MySQL8。文末提供源码下载链接。