之前对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加载。

SpringBoot自动配置源码调试的更多相关文章

  1. springboot自动配置源码解析

    springboot版本:2.1.6.RELEASE SpringBoot 自动配置主要通过 @EnableAutoConfiguration, @Conditional, @EnableConfig ...

  2. SpringBoot源码学习1——SpringBoot自动装配源码解析+Spring如何处理配置类的

    系列文章目录和关于我 一丶什么是SpringBoot自动装配 SpringBoot通过SPI的机制,在我们程序员引入一些starter之后,扫描外部引用 jar 包中的META-INF/spring. ...

  3. Spring Boot 自动配置 源码分析

    Spring Boot 最大的特点(亮点)就是自动配置 AutoConfiguration 下面,先说一下 @EnableAutoConfiguration ,然后再看源代码,到底自动配置是怎么配置的 ...

  4. SpringBoot 源码解析 (五)----- Spring Boot的核心能力 - 自动配置源码解析

    在上一篇博客中分析了springBoot启动流程,大体的轮廓只是冰山一角.今天就来看一下springBoot的亮点功能:自动化装配功能. 先从@SpringBootApplication开始.在启动流 ...

  5. SpringBoot自动装配源码解析

    序:众所周知spring-boot入门容易精通难,说到底spring-boot是对spring已有的各种技术的整合封装,因为封装了所以使用简单,也因为封装了所以越来越多的"拿来主义" ...

  6. SpringBoot自动装配-源码分析

    1. 简介 通过源码探究SpringBoot的自动装配功能. 2. 核心代码 2.1 启动类 我们都知道SpringBoot项目创建好后,会自动生成一个当前模块的启动类.如下: import org. ...

  7. Spring Boot自动配置源码解析(基于Spring Boot 2.0.2.RELEASE)

    在Spring Boot官方介绍中,首一段话是这样的(如下图).我们可以大概了解到其所表达的含义:我们可以利用Spring Boot写很少的配置来创建一个非常方便的基于Spring整合第三方类库的单体 ...

  8. 原创001 | 搭上SpringBoot自动注入源码分析专车

    前言 如果这是你第二次看到师长的文章,说明你在觊觎我的美色!O(∩_∩)O哈哈~ 点赞+关注再看,养成习惯 没别的意思,就是需要你的窥屏^_^ 本系列为SpringBoot深度源码专车系列,第一篇发车 ...

  9. SpringBoot自动装配源码

    前几天,面试的时候被问到了SpringBoot的自动装配的原理.趁着五一的假期,就来整理一下这个流程. 我这里使用的是idea创建的最简单的SpringBoot项目. 我们都知道,main方法是jav ...

随机推荐

  1. [转]构建高性能MySQL体系

    来源:http://www.yunweipai.com/archives/21232.html 构建高性能MySQL系统涵盖从单机.硬件.OS.文件系统.内存到MySQL 本身的配置,以及schema ...

  2. Python开发——14.threading模块和multiprocess模块

    一.threading模块 1.threading类的两种创建方法 (1)直接创建 import time import threading def Hi(num): print("hell ...

  3. 20155205 郝博雅 Exp3 免杀原理与实践

    20155205 郝博雅 Exp3 免杀原理与实践 一.基础问题回答 (1)杀软是如何检测出恶意代码的? 答:++基于特征码的检测++<简单来说一段特征码就是一段或多段数据.如果一个可执行文件( ...

  4. Eclipse搭建服务器,实现与Android的简单通信

    ---恢复内容开始--- 目标:实现客户端(Android App)与服务器(PC)的简单通信 相关准备:eclipse_mars.tomcat8.Android Studio 实现: 1.java环 ...

  5. recyclerview刷新

    https://blog.csdn.net/leejizhou/article/details/51179233 RecyclerView之更新UI数据的高级用法 https://www.cnblog ...

  6. Ubuntu安装pyenv实现python多版本控制

    Ubuntu安装pyenv实现python多版本控制 git clone git://github.com/yyuu/pyenv.git ~/.pyenv echo 'export PYENV_ROO ...

  7. idea 中dao层自动生成接口

    1.在生成接口的类上右键 2.选中要生成的接口方法 3.点击Yes 4.出现(? reference in ? file)即生成成功

  8. java性能分析工具

    jcmd:向JVM发送诊断的命令,jvm未必会全部响应,有些需要在jvm开启相应功能才能响应.个人平时用的不是很多. SampleA: 添加        jcmd pid VM.native_mem ...

  9. github使用步骤

    首先需要注册一个github账号 1.认识github首页界面 2.如何新建一个自己的仓库 3.创建README文件 4.创建自己的文件 5.解析文件 6.生成地址 7.如何修改编辑文件

  10. 《Node.js高级编程》之Node 核心API基础

    Node 核心API基础 第三章 加载模块 第四章 应用缓冲区 第五章 事件发射器模式简化事件绑定 第六章 使用定时器制定函数执行计划 第三章 加载模块 本章提要 加载模块 创建模块 使用node_m ...