18张图,详解SpringBoot解析yml全流程
背景
前几天的时候,项目里有一个需求,需要一个开关控制代码中是否执行一段逻辑,于是理所当然的在yml
文件中配置了一个属性作为开关,再配合nacos
就可以随时改变这个值达到我们的目的,yml文件中是这样写的:
switch:turnOn: on
程序中的代码也很简单,大致的逻辑就是下面这样,如果取到的开关字段是on
的话,那么就执行if
判断中的代码,否则就不执行:
@Value("${switch.turnOn}")
private String on;@GetMapping("testn")
public void test(){if ("on".equals(on)){//TODO}
}
但是当代码实际跑起来,有意思的地方来了,我们发现判断中的代码一直不会被执行,直到debug一下,才发现这里的取到的值居然不是on
而是true
。
看到这,是不是感觉有点意思,首先盲猜是在解析yml的过程中把on
作为一个特殊的值进行了处理,于是我干脆再多测试了几个例子,把yml中的属性扩展到下面这些:
switch:turnOn: onturnOff: offturnOn2: 'on'turnOff2: 'off'
再执行一下代码,看一下映射后的值:
可以看到,yml中没有带引号的on
和off
被转换成了true
和false
,带引号的则保持了原来的值不发生改变。
到这里,让我忍不住有点好奇,为什么会发生这种现象呢?于是强忍着困意翻了翻源码,硬磕了一下SpringBoot加载yml配置文件的过程,终于让我看出了点门道,下面我们一点一点细说!
因为配置文件的加载会涉及到一些SpringBoot启动的相关知识,所以如果对这一块不是很熟悉的同学,可以先提前先看一下Hydra在古早时期写过一篇文章预热一下。下面的介绍中,只会摘出一些对加载和解析配置文件比较重要的步骤进行分析,对其他无关部分进行了省略。
加载监听器
当我们启动一个SpringBoot程序,在执行SpringApplication.run()
的时候,首先在初始化SpringApplication
的过程中,加载了11个实现了ApplicationListener
接口的拦截器。
这11个自动加载的ApplicationListener
,是在spring.factories
中定义并通过SPI
扩展被加载的:
这里列出的10个是在spring-boot
中加载的,还有剩余的1个是在spring-boot-autoconfigure
中加载的。其中最关键的就是ConfigFileApplicationListener
,它和后面要讲到的配置文件的加载相关。
执行run方法
在实例化完成SpringApplication
后,会接着往下执行它的run
方法。
可以看到,这里通过getRunListeners
方法获取的SpringApplicationRunListeners
中,EventPublishingRunListener
绑定了我们前面加载的11个监听器。但是在执行starting
方法时,根据类型进行了过滤,最终实际只执行了4个监听器的onApplicationEvent
方法,并没有我们希望看到的ConfigFileApplicationListener
,让我们接着往下看。
当run
方法执行到prepareEnvironment
时,会创建一个ApplicationEnvironmentPreparedEvent
类型的事件,并广播出去。这时所有的监听器中,有7个会监听到这个事件,之后会分别调用它们的onApplicationEvent
方法,其中就有了我们心心念念的ConfigFileApplicationListener
,接下来让我们看看它的onApplicationEvent
方法中做了什么。
在方法的调用过程中,会加载系统自己的4个后置处理器以及ConfigFileApplicationListener
自身,一共5个后置处理器,并执行他们的postProcessEnvironment
方法,其他4个对我们不重要可以略过,最终比较关键的步骤是创建Loader
实例并调用它的load
方法。
加载配置文件
这里的Loader
是ConfigFileApplicationListener
的一个内部类,看一下Loader
对象实例化的过程:
在实例化Loader
对象的过程中,再次通过SPI扩展的方式加载了两个属性文件加载器,其中的YamlPropertySourceLoader
就和后面的yml文件的加载、解析密切关联,而另一个PropertiesPropertySourceLoader
则负责properties
文件的加载。创建完Loader
实例后,接下来会调用它的load
方法。
在load
方法中,会通过嵌套循环方式遍历默认配置文件存放路径,再加上默认的配置文件名称、以及不同配置文件加载器对应解析的后缀名,最终找到我们的yml配置文件。接下来,开始执行loadForFileExtension
方法。
在loadForFileExtension
方法中,首先将classpath:/application.yml
加载为Resource
文件,接下来准备正式开始,调用了之前创建好的YamlPropertySourceLoader
对象的load
方法。
封装Node
在load
方法中,开始准备进行配置文件的解析与数据封装:
load
方法中调用了OriginTrackedYmlLoader
对象的load
方法,从字面意思上我们也可以理解,它的用途是原始追踪yml的加载器。中间一连串的方法调用可以忽略,直接看最后也是最重要的是一步,调用OriginTrackingConstructor
对象的getData
接口,来解析yml并封装成对象。
在解析yml的过程中实际使用了Composer
构建器来生成节点,在它的getNode
方法中,通过解析器事件来创建节点。通常来说,它会将yml中的一组数据封装成一个MappingNode
节点,它的内部实际上是一个NodeTuple
组成的List
,NodeTuple
和Map
的结构类似,由一对对应的keyNode
和valueNode
构成,结构如下:
好了,让我们再回到上面的那张方法调用流程图,它是根据文章开头的yml文件中实际内容内容绘制的,如果内容不同调用流程会发生改变,大家只需要明白这个原理,下面我们具体分析。
首先,创建一个MappingNode
节点,并将switch
封装成keyNode
,然后再创建一个MappingNode
,作为外层MappingNode
的valueNode
,同时存储它下面的4组属性,这也是为什么上面会出现4次循环的原因。如果有点困惑也没关系,看一下下面的这张图,就能一目了然了解它的结构。
在上图中,又引入了一种新的ScalarNode
节点,它的用途也比较简单,简单String类型的字符串用它来封装成节点就可以了。到这里,yml中的数据被解析完成并完成了初步的封装,可能眼尖的小伙伴要问了,上面这张图中为什么在ScalarNode
中,除了value
还有一个tag
属性,这个属性是干什么的呢?
在介绍它的作用前,先说一下它是怎么被确定的。这一块的逻辑比较复杂,大家可以翻一下ScannerImpl
类fetchMoreTokens
方法的源码,这个方法会根据yml中每一个key
或value
是以什么开头,来决定以什么方式进行解析,其中就包括了{
、[
、'
、%
、?
等特殊符号的情况。以解析不带任何特殊字符的字符串为例,简要的流程如下,省略了一些不重要部分:
在这张图的中间步骤中,创建了两个比较重要的对象ScalarToken
和ScalarEvent
,其中都有一个为true
的plain
属性,可以理解为这个属性是否需要解释,是后面获取Resolver
的关键属性之一。
上图中的yamlImplicitResolvers
其实是一个提前缓存好的HashMap,已经提前存储好了一些Char
类型字符与ResolverTuple
的对应关系:
当解析到属性on
时,取出首字母o
对应的ResolverTuple
,其中的tag
就是tag:yaml.org.2002:bool
。当然了,这里也不是简单的取出就完事了,后续还会对属性进行正则表达式的匹配,看与regexp
中的值是否能对的上,检查无误时才会返回这个tag
。
到这里,我们就解释清楚了ScalarNode
中tag
属性究竟是怎么获取到的了,之后方法调用层层返回,返回到OriginTrackingConstructor
父类BaseConstructor
的getData
方法中。接下来,继续执行constructDocument
方法,完成对yml文档的解析。
调用构造器
在constructDocument
中,有两步比较重要,第一步是推断当前节点应该使用哪种类型的构造器,第二步是使用获得的构造器来重新对Node
节点中的value
进行赋值,简易流程如下,省去了循环遍历的部分:
推断构造器种类的过程也很简单,在父类BaseConstructor
中,缓存了一个HashMap,存放了节点的tag
类型到对应构造器的映射关系。在getConstructor
方法中,就使用之前节点中存入的tag
属性来获得具体要使用的构造器:
当tag
为bool
类型时,会找到SafeConstruct
中的内部类 ConstructYamlBool
作为构造器,并调用它的construct
方法实例化一个对象,来作为ScalarNode
节点的value
的值:
在construct
方法中,取到的val就是之前的on
,至于下面的这个BOOL_VALUES
,也是提前初始化好的一个HashMap,里面提前存放了一些对应的映射关系,key是下面列出的这些关键字,value则是Boolean
类型的true
或false
:
到这里,yml中的属性解析流程就基本完成了,我们也明白了为什么yml中的on
会被转化为true
的原理了。
思考
那么,下一个问题来了,既然yml文件解析中会做这样的特殊处理,那么如果换成properties
配置文件怎么样呢?
sw.turnOn=on
sw.turnOff=off
执行一下程序,看一下结果:
可以看到,使用properties
配置文件能够正常读取结果,看来是在解析的过程中没有做特殊处理,至于解析的过程,有兴趣的小伙伴可以自己去阅读一下源码。
推荐
主流Java进阶技术(学习资料分享)
Java面试题宝典
加入Spring技术开发社区
PS:因为公众号平台更改了推送规则,如果不想错过内容,记得读完点一下“在看”,加个“星标”,这样每次新文章推送才会第一时间出现在你的订阅列表里。点“在看”支持我们吧!
18张图,详解SpringBoot解析yml全流程相关推荐
- 123 张图详解 177 个计算机网络名词
大家好,我是小弗.上篇<60 张图详解 98 个常见网络概念>有一段时间了,现在重新汇总整理,把最近提到的网络名词也加上.同时为了方便阅读,增加了大量的配图,让网络小白也能轻松理解.考虑到 ...
- 36 张图详解应用层协议:网络世界的最强王者
上帝视角 应用层 我们前面介绍过 TCP/IP 模型的下三层,分别是网络接入层.网络层和传输层.它们都是为应用层服务的,传输应用层的各种数据,现在我们就来看看最高层的应用层. 应用层 在 TCP/IP ...
- 71张图详解IP地址、IP 路由、三层转发、ARP、ICMP
71张图详解IP地址.IP 路由.三层转发.ARP.ICMP 架构师之道2021-04-07 13:51:24 https://www.toutiao.com/i6948285918986027531 ...
- 一张图详解项目经理PMO应用波士顿矩阵的步骤和流程
一张图详解项目经理&PMO应用波士顿矩阵的步骤和流程
- 71张图详解IP 地址、IP 路由、分片和重组、三层转发、ARP、ICMP
目录 有小伙伴问:为什么没有配置 IP 地址就无法上网?IP 协议又是啥? 这要从 TCP/IP 协议说起,互联网使用的是 TCP/IP 协议,其中 IP 协议又是最重要的协议之一.IP 协议是基于 ...
- 通过一张图详解微服务各个组件
SpringCloud为开发人员提供了快速构建分布式系统架构的工具,例如配置管理,服务发现,断路器,智能路由,微代理,控制总线,一次性令牌,全局锁定,领导选举,分布式会话,集群状态等.作为开发人员,我 ...
- 36 张图详解 ARP :网络世界没有我,你哪也别想去
上帝视角 初识 ARP 从网络分层上看,我们知道二层网络中,使用 MAC 地址进行传输,MAC 地址做为数据链路层的设备标识符. 二层网络 三层网络中,使用 IP 地址进行传输,IP 地址做为网络层的 ...
- 36 张图详解 DNS :网络世界的导航
上帝视角 我们平时在访问网站时,不使用 IP 地址,而是网站域名.但是抓包发现:交互报文是以 IP 地址进行的.那么 IP 地址是从哪来的呢?这是因为 DNS 把网站域名自动转换为 IP 地址. 报文 ...
- 十二张图详解Redis的数据结构和对象系统
回顾:大数据平台技术栈 (ps:可点击查看),今天就来说说其中的Redis! 本文来自:张狗蛋的技术之路 Redis是一个开源的 key-value 存储系统,它使用六种底层数据结构构建了包含字符串对 ...
最新文章
- 计算机病毒实践汇总五:搭建虚拟网络环境
- VB 输入超出文件尾(错误62)(转)
- [Hive_11] Hive 的高级聚合函数
- java类库帮助文档,薪资翻倍
- C++ 11 深度学习(三)范围for、new内存动态分配、nullptr
- [渝粤教育] 西南科技大学 质量与可靠性管理 在线考试复习资料
- 线性表:链栈算法实现
- 运动会成绩管理系统python_基于Eclipse+Mysql+Tomcat+MVC开发得大学运动会管理系统
- 65 年来,全英国向他道歉三次,图灵,计算机人不能忘记的男人
- java jdomxml 换行_jdom处理的XML Document 和String 之间的相互转化
- Dbf文件转Excel
- 利用CNN进行面部表情识别
- Enigma密码机初步解析
- eclipse上svn创建分支、合并、切换
- java设计模式之单例模式详解
- 配置zigbee模块
- 【51单片机】DS1302时钟芯片
- 关于 Android Studio 鼠标中键的一些技巧
- MySQL专题系统归纳快速上手(常用cmd命令,常用函数汇总,SQL语句精讲带示例)适用初学、用法速查
- 超级爆笑小学生作文大全,这孩子太搞了
热门文章
- 月费10元起!中国移动推年轻人的第一张5G元素电话卡
- 荣耀折叠屏手机发布日期曝光?将主打年轻用户
- Android图片加载之初步认识bitmap
- element upload预览_vue2.0 使用element-ui里的upload组件实现图片预览效果方法
- sql 查询 tag_Askgit:给git增加个翅膀,用sql挖掘仓库的信息
- r语言调用python_python3调用R语言干货
- linux在python的虚拟环境下运行程序_在win10和linux上分别安装Python虚拟环境的方法步骤...
- 【kafka】Kafka中的动态配置源码分析
- 【es】es 分布式一致性原理剖析 节点篇
- 60-100-032-使用-MySQL大小写敏感的解决方法