SpringBoot源码之属性文件加载原理剖析

Posted 2022-01-26 波波烤鸭

SpringBoot源码之属性文件加载原理剖析

  首先我们来看一个问题。就是我们在创建SpringBoot项目的时候会在对应的application.properties或者application.yml文件中添加对应的属性信息，我们的问题是这些属性文件是什么时候被加载的？如果要实现自定义的属性文件怎么来实现呢？本文来给大家揭晓答案：

1.找到入口

  结合我们前面介绍的SpringBoot中的监听事件机制，我们首先看下SpringApplication.run()方法，在该方法中会针对SpringBoot项目启动的不同的阶段来发布对应的事件。

  处理属性文件加载解析的监听器是 ConfigFileApplicationListener ,这个监听器监听的事件有两个。

  而我们进入SpringApplication.prepareEnvironment()方法中发布的事件其实就是ApplicationEnvironmentPreparedEvent事件。进入代码查看。

进行进入

继续进入会看到对应的发布事件：ApplicationEnvironmentPreparedEvent

  结合上篇文件的内容，我们知道在initialMulticaster中是有ConfigFileApplicationListener这个监听器的。

  那么在此处触发了配置环境的监听器，后续的逻辑就应该进入对应的

2.ConfigFileApplicationListener

2.1 主要流程分析

  接下来我们看下ConfigFileApplicationListener中具体的如何来处理配置文件的加载解析的。

  根据逻辑我们直接进入onApplicationEnvironmentPreparedEvent()方法中。

  系统提供那4个不是重点，重点是 ConfigFileApplicationListener 中的这个方法处理.

  直接进入ConfigFileApplicationListener.postProcessEnvironment()方法。

  在进入addPropertySources()方法中会完成两个核心操作，1。创建Loader对象，2。调用Loader对象的load方法，

2.2 Loader构造器

  现在我们来看下在Loader构造器中执行了什么操作。

  通过源码我们可以发现在其中获取到了属性文件的加载器、从spring.factories文件中获取，对应的类型是 PropertySourceLoader类型。

  而且在loadFactories方法中会完成对象的实例化。

  到这Loader的构造方法执行完成了，然后来看下load()方法的执行。先把代码贴上

void load() 
			FilteredPropertySource.apply(this.environment, DEFAULT_PROPERTIES, LOAD_FILTERED_PROPERTY,
					(defaultProperties) -> 
						// 创建默认的profile 链表
						this.profiles = new LinkedList<>();
						// 创建已经处理过的profile 类别
						this.processedProfiles = new LinkedList<>();
						// 默认设置为未激活
						this.activatedProfiles = false;
						// 创建loaded对象
						this.loaded = new LinkedHashMap<>();
						// 加载配置 profile 的信息，默认为 default
						initializeProfiles();
						// 遍历 Profiles，并加载解析
						while (!this.profiles.isEmpty()) 
							// 从双向链表中获取一个profile对象
							Profile profile = this.profiles.poll();
							// 非默认的就加入，进去看源码即可清楚
							if (isDefaultProfile(profile)) 
								addProfileToEnvironment(profile.getName());
							
							load(profile, this::getPositiveProfileFilter,
									addToLoaded(MutablePropertySources::addLast, false));
							this.processedProfiles.add(profile);
						
						// 解析 profile
						load(null, this::getNegativeProfileFilter, addToLoaded(MutablePropertySources::addFirst, true));
						// 加载默认的属性文件 application.properties
						addLoadedPropertySources();
						applyActiveProfiles(defaultProperties);
					);
		

  然后我们进入具体的apply()方法中来查看。

  中间的代码都有注释，主要是处理profile的内容。

  首先是getSearchLocations()方法，在该方法中会查询默认的会存放对应的配置文件的位置，如果没有自定义的话，路径就是 file:./config/ file:./ classpath:/config/ classpath:/ 这4个

  然后回到load方法中，遍历4个路径，然后加载对应的属性文件。

  getSearchNames()获取的是属性文件的名称。如果自定义了就加载自定义的

  否则加载默认的application文件。

再回到前面的方法

进入load方法，会通过前面的两个加载器来分别加载application.properties和application.yml的文件。

loader.getFileExtensions()获取对应的加载的文件的后缀。

进入loadForFileExtension()方法，对profile和普通配置分别加载

继续进入load方法

开始加载我们存在的application.properties文件。

2.3 properties加载

  在找到了要加载的文件的名称和路径后，我们来看下资源加载器是如何来加载具体的文件信息的。

进入loadDocuments方法中，我们会发现会先从缓存中查找，如果缓存中没有则会通过对应的资源加载器来加载了。

此处是PropertiesPropertySourceLoader来加载的。

进入loadProperties方法

之后进入load()方法看到的就是具体的加载解析properties文件中的内容了。感兴趣的可以看下具体的逻辑，本文就给大家介绍到这里了。