Spring boot源码深入学习（五） | 准备环境时application配置文件的加载优先级

回顾

上一篇：Spring boot源码深入学习（四） | prepareEnvironment准备环境
写到springboot中准备环境prepareEnvironment的实现逻辑，下面着重学习一下application.properties或者application.yaml的加载顺序

springboot配置文件加载优先级解析

properties或者yaml文件单独存在

由图可知，我们可以看到，会从4个路径下面分别去加载配置文件。下面我写了一个demo，看一下各个位置的加载优先级。

优先级从高到低依次为
file:./config/ ：项目根目录找config文件夹下找配置文件。图中：端口1111
file:./ ：根目录下找配置文件。图中：端口2222
classpath:/config/ ：resources下找cofnig文件夹下找配置文件。图中：端口3333
classpath:/ ：resources下找配置文件。图中端口4444
我们可以看到图中确实1111端口的file:./config/下的配置文件生效了。

properties和yaml文件同时存在

加载顺序如下：
1、config/application.properties
2、config/application.yml
3、application.properties
4、application.yml
5、resources/config/application.properties
6、resources/config/application.yml
7、resources/application.properties
8、resources/application.yml
结论：
1.在同一个目录，application.yml和application.properties同时存在，先读取application.properties
2.先读取到的配置文件，不会因为在后面其他目录再次读到同名的配置文件而被替换。以第一次读到的为准

有子模块的config目录加载文件失效

1.在springboot中，如果有子module，那么子module中的config目录里面的这个配置则不会加载。如下图



2.只会加载resources目录下的2种情况的配置，如下图

3.在最外层根目录下config才会被加载



看一看源码
一. 这里this.profiles为null和dufalut
1.先加载null的profile，加载没有指定profile的配置文件，比如：application.properties。 profiles 采用了 LIFO 队列，后进先出。所以会先加载profile为null的配置文件
加载顺序：properties，xml，yml，yaml
2.再加载默认环境：default。加载顺序：
application-default.properties
application.properties
application-default.xml
application.xml
application-default.yml
application.yml
application-default.yaml
application.yaml

			while (!this.profiles.isEmpty()) {
				Profile profile = this.profiles.poll();
				// 添加已激活配置文件到环境
				if (profile != null && !profile.isDefaultProfile()) {
					addProfileToEnvironment(profile.getName());
				}
				// 获取默认配置文件路径，循环加载配置文件（不检查是否已经存在）
				load(profile, this::getPositiveProfileFilter,
						addToLoaded(MutablePropertySources::addLast, false));
				this.processedProfiles.add(profile);
			}

二. 循环遍历4个目录去加载配置文件
每个目录下加载文件类型的顺序：
properties，xml，yml，yaml

		private void load(Profile profile, DocumentFilterFactory filterFactory,
				DocumentConsumer consumer) {
			// 获取默认的配置文件路径
			getSearchLocations().forEach((location) -> {
				boolean isFolder = location.endsWith("/");
				Set<String> names = isFolder ? getSearchNames() : NO_SEARCH_NAMES;
				names.forEach(
						// 根据yaml，properties的不同来解析配置文件
						(name) -> load(location, name, profile, filterFactory, consumer));
			});
		}

三. 根据yaml或者properties不同的解析器解析配置文件

		private void load(String location, String name, Profile profile,
				DocumentFilterFactory filterFactory, DocumentConsumer consumer) {
			if (!StringUtils.hasText(name)) {
				for (PropertySourceLoader loader : this.propertySourceLoaders) {
					if (canLoadFileExtension(loader, location)) {
						load(loader, location, profile,
								filterFactory.getDocumentFilter(profile), consumer);
						return;
					}
				}
			}
			Set<String> processed = new HashSet<>();
			// 根据yaml或者properties不同解析器解析
			for (PropertySourceLoader loader : this.propertySourceLoaders) {
				for (String fileExtension : loader.getFileExtensions()) {
					if (processed.add(fileExtension)) {
						loadForFileExtension(loader, location + name, "." + fileExtension,
								profile, filterFactory, consumer);
					}
				}
			}
		}

2个profile * 4个路径 * 2个PropertySourceLoader* 2个fileExtension = 32次。
所以加载32次

总结

1.加载目录优先级从高到低
file:./config/ ：项目根目录找config文件夹下找配置文件。
file:./ ：根目录下找配置文件
classpath:/config/ ：resources下找cofnig文件夹下找配置文件。
classpath:/ ：resources下找配置文件。

2.在同一个目录，application.yml和application.properties同时存在，先读取application.properties
文件优先级：properties > xml > yml > yaml

3.先读取到的配置文件，不会因为在后面其他目录再次读到同名的配置文件而被替换。以第一次读到的为准

4.有子module的工程，子module目录下的配置文件和子module目录下一层config目录的配置文件不会加载。只会加载resources下面的配置文件