SpringBoot自动配置源码调试

简介: SpringBoot自动配置源码调试
+关注继续查看

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


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


image


第一处断点:


image


该方法的源码如下:


image


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


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


image


第二处断点:


image


这个方法的源码如下:

image


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


image


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


image


image


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


image


最终得到的attributes为:


image


第三处断点:


image


getCandidateConfigurations方法定义如下:


image


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


image


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


image


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

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


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


image


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


image


接下来对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:


image


因为上述properties并不存在

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

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


image


此时存放自动配置类的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:


image


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

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


image


第三次遍历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.


image


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


第四处断点:


image


 filter方法传入了2个参数:


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


image


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


image


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


image


for循环中的getAutoConfigurationImportFilters定义如下:


image


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


image


上述方法主要目的是找寻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类。


image


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


image


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

image


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


image


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

image


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


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


image


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


image


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


image


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


image


getOutComes定义如下:


image


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


image


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


image


随便点开一个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-满足条件,不需要跳过。


image


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


image


image


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


image


至此,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加载。


image


相关文章
|
3天前
|
存储 搜索推荐 前端开发
SpringBoot框架+原生HTML云端SaaS服务方式的电子病历编辑器源码
一体化电子病历系统基于云端SaaS服务的方式,采用B/S(Browser/Server)架构提供,覆盖了医疗机构电子病历模板制作到管理使用的整个流程。除实现在线制作内容丰富、图文并茂、功能完善的电子病历模板外,还可按照医疗机构的特色,根据不同业务的需求,使用该系统定制个性化、实用化、特色化电子病历模板。 该系统能对电子病历模板进行统一集中管理,通用的电子病历模板能直接提供给不同的医疗机构直接使用,避免重复制作;提供了功能齐备的控件元素,实现电子病历在业务使用中数据的自动获取功能,简化了人工的大量填报。
|
6天前
|
消息中间件 架构师 Java
华为十年架构师带你从源码到项目,开启你的springboot实战之旅
微服务一词相信对很多开发者来说已经耳熟能详了。在我曾经工作的公司,还是使用单体项目来部署时,无论是打包还是运行都耗时耗力,这一直让我很苦恼。同时,每次需要创建新应用、构建项目配置Spring的时候也十分麻烦。
|
9天前
|
消息中间件 运维 供应链
springboot云HIS医院信息综合管理平台源码
springboot云HIS医院信息综合管理平台源码
17 0
|
9天前
|
小程序 前端开发 Java
智慧校园电子班牌 智能互联家校互通源码 springboot
智慧校园电子班牌 智能互联家校互通源码 springboot
14 0
|
9天前
|
消息中间件 缓存 监控
Java版B/S架构云his医院信息管理系统源码(springboot框架)
Java版B/S架构云his医院信息管理系统源码(springboot框架)
23 0
|
9天前
|
运维 供应链 前端开发
云HIS医院信息化管理平台源码,SaaS模式、springboot框架
云HIS医院信息化管理平台源码,SaaS模式、springboot框架
21 0
|
9天前
|
运维 供应链 安全
springboot医院HIS信息管理系统源码:技术架构:Angular+Nginx+Java+Spring,SpringBoot
springboot医院HIS信息管理系统源码:技术架构:Angular+Nginx+Java+Spring,SpringBoot
9 0
|
9天前
|
人工智能 移动开发 小程序
【Java】医院智能导诊小程序源码,springboot框架
【Java】医院智能导诊小程序源码,springboot框架
20 0
|
9天前
|
XML 前端开发 JavaScript
【原生HTML+SpringBoot】电子病历编辑器源码
【原生HTML+SpringBoot】电子病历编辑器源码
11 0
|
9天前
|
运维 前端开发 Java
【springboot+云计算】B/S医院信息管理系统源码(云HIS)
【springboot+云计算】B/S医院信息管理系统源码(云HIS)
28 0
相关产品
云迁移中心
推荐文章
更多