springboot本身支持多种灵活的配置方式，为开发springboot程序带来了很大的灵活性和扩展性，但是同时由于太灵活，经常会导致明明配置了相关属性，却没有生效。
本文总结了springboot配置文件的原理以及多个配置文件生效的顺序。
springboot配置文件原理
springboot配置文件支持灵活的路径，以及灵活的文件名，用一个变量表达式总结如下：
{location}[{configName}[-{profile}].{fileType}]
-
location表示配置文件的路径
springboot默认的配置文件搜索路径是classpath:/,classpath:/config/,file:./,file:./config/，但是如果指定了spring.config.location属性，则只会去读该属性指定的文件搜索路径，但是如果指定了spring.config.additional-location属性的话，可以额外配置单独的文件路径。可以参考ConfigFileApplicationListener#getSearchLocations方法
-
configName表示配置文件的名字
默认的配置文件名是
application，如果指定了spring.config.name属性，则使用该属性。可以参考ConfigFileApplicationListener#getSearchNames方法
-
profile表示环境标识
profile变量则是通过spring.profiles.active来指定，如果没有配置对应的属性，则spring.profiles.active的值为default。profile一般作用是用来区分开发，测试，生产等不同的环境
-
fileType表示不同类型的文件
springboot支持多种类型的文件，并且在PropertySourceLoader指定，默认支持两种PropertiesPropertySourceLoader和YamlPropertySourceLoader，可以在spring.factories文件里面指定，其中PropertiesPropertySourceLoader支持xml和properties两种文件类型，后缀分别是xml和properties，YamlPropertySourceLoader支持读取yaml文件，后缀可以是yml或者yaml.
- [ ]表示可选
第一个[ ]表示:
支持两种文件：
1. 如果location是个目录，即以/结尾，则最终表达式为{location}{configName}[-{profile}].{fileType}
2. 如果location是个文件，即不以/结尾，则最终表达式为{location}
第二个[ ]表示:
支持两种文件名的文件：
1. 一种不包含-profile，则最终表达式为{location}{configName}.{fileType}，比如application.yml
2. 一种包含profile，和application-dev.yml
部分源码如下：
class ConfigFileApplicationListener {
public static final String CONFIG_LOCATION_PROPERTY = "spring.config.location";
public static final String CONFIG_ADDITIONAL_LOCATION_PROPERTY = "spring.config.additional-location";
private static final String DEFAULT_SEARCH_LOCATIONS = "classpath:/,classpath:/config/,file:./,file:./config/";
private static final String DEFAULT_NAMES = "application";
public static final String CONFIG_NAME_PROPERTY = "spring.config.name";
// ...
public static final String CONFIG_NAME_PROPERTY = "spring.config.name";
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(
(name) -> load(location, name, profile, filterFactory, consumer));
});
}
private Set<String> getSearchLocations() {
if (this.environment.containsProperty(CONFIG_LOCATION_PROPERTY)) {
return getSearchLocations(CONFIG_LOCATION_PROPERTY);
}
Set<String> locations = getSearchLocations(
CONFIG_ADDITIONAL_LOCATION_PROPERTY);
locations.addAll(
asResolvedSet(ConfigFileApplicationListener.this.searchLocations,
DEFAULT_SEARCH_LOCATIONS));
return locations;
}
private Set<String> getSearchNames() {
if (this.environment.containsProperty(CONFIG_NAME_PROPERTY)) {
String property = this.environment.getProperty(CONFIG_NAME_PROPERTY);
return asResolvedSet(property, null);
}
return asResolvedSet(ConfigFileApplicationListener.this.names, DEFAULT_NAMES);
}
}
多个配置文件的顺序
当满足上述变量表达式的配置文件有多个时，会有一个配置的优先级。假设
configName取默认值application；
location只有classpath:/和classpath:/config/；
profile取dev；
fileType在PropertiesPropertySourceLoader和YamlPropertySourceLoader里面指定。
上面每个条件组合起来，则最多有配置文件如下，且顺序从上到下：
application-dev.properties
application-dev.xml
application-dev.yml
application-dev.yaml
application.properties
application.xml
application.yml
application.yaml
config/application-dev.properties
config/application-dev.xml
config/application-dev.yml
config/application-dev.yaml
config/application.properties
config/application.xml
config/application.yml
config/application.yaml
获取属性时，按从上到下的顺序遍历由上述文件生成的属性资源对象PropertySource，如果遇到匹配的key直接返回。
总结一下：就是如果同一个key的属性只出现一次，则直接取该值即可。如果同一个key的属性出现多次，则取顺序靠前的属性资源对象。另外其中每个文件都是可选的。
需要注意的一点是：如果在同一个location下配置了多个文件名一样的文件，则只会取一个，比如在classpath:/，有如下两个文件application.yml：
jar:file:/target/demo-1.0.0-SNAPSHOT.jar!/BOOT-INF/classes!/application.yml
jar:file:/target/demo-1.0.0-SNAPSHOT.jar!/BOOT-INF/lib/demo-common-config-1.0.jar!/application.yml
则只会根据classloader的classpath列表，选取第一个出现的文件。因为springboot加载配置文件时最底层是使用的下面的方法：
String path = "classpath:/application.yml";
// 获取文件
URL url = this.classLoader.getResource(path);
// 获取文件流
InputStream is = this.classLoader.getResourceAsStream(path);
这两个方法只会获取classloader类的ucp属性里面第一个匹配到的值。如果对springboot自身的机制不满意，想获取所有的classpath:/路径下面的applicaiton.yml文件，可以使用下面的方法：
Enumeration<URL> urls = classLoader.getResources("classpath:/applicaiton.yml");
UrlResource resource = new UrlResource(url);
InputStream is = resource.getInputStream();
总结
本文总结了springboot配置文件的原理以及多个配置文件生效的顺序。如果存在增加了配置文件或者在配置文件里面增加了属性却没有生效，可以参考上面的springboot配置文件表达式和配置文件生效顺序进行排查。
后面还会有一篇文章讨论基于springboot配置原理如何实现自定义的配置读取方式。
德尔沃的车站
网友评论