SpringBoot配置文件加载顺序,spring中classpath和classpath*的区别

一、springboot配置文件的加载位置

springboot启动会扫描以下位置的application.properties或者application.yml作为默认的配置文件

工程根目录:./config/
工程根目录:./
classpath:/config/
classpath:/
加载的优先级顺序是从上向下加载,并且所有的文件都会被加载,高优先级的内容会覆盖底优先级的内容,形成互补配置。具体来说就是,获取属性时,按从上到下的顺序遍历由上述文件生成的属性资源对象PropertySource,如果遇到匹配的key直接返回。
总结一下:就是如果同一个key的属性只出现一次,则直接取该值即可。如果同一个key的属性出现多次,则取顺序靠前的属性资源对象。

也可以通过指定配置spring.config.location来改变默认配置,一般在项目已经打包后,我们可以通过指令
java -jar xxxx.jar --spring.config.location=D:/kawa/application.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 names = isFolder ? getSearchNames() : NO_SEARCH_NAMES;
                names.forEach(
                        (name) -> load(location, name, profile, filterFactory, consumer));
            });
        }

    private Set getSearchLocations() {
        if (this.environment.containsProperty(CONFIG_LOCATION_PROPERTY)) {
            return getSearchLocations(CONFIG_LOCATION_PROPERTY);
        }
        Set locations = getSearchLocations(
                CONFIG_ADDITIONAL_LOCATION_PROPERTY);
        locations.addAll(
                asResolvedSet(ConfigFileApplicationListener.this.searchLocations,
                        DEFAULT_SEARCH_LOCATIONS));
        return locations;
    }


    private Set 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);
    }
}

配置文件带profile的加载顺序如下:

优先加载带profile
jar包外部的application-{profile}.propertie或application.yml(带spring.profile)配置文件
jar包内部的application-{profile}.propertie或application.yml(带spring.profile)配置文件
再来加载不带profile
jar包外部的application.propertie或application.yml(不带spring.profile)配置文件
jar包内部的application.propertie或application.yml(不带spring.profile)配置文件

需要注意的一点是:如果在同一个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类的ucp属性里面第一个匹配到的值。如果对springboot自身的机制不满意,想获取所有的classpath:/路径下面的applicaiton.yml文件,可以使用下面的方法:

Enumeration urls = classLoader.getResources("classpath:/applicaiton.yml");
UrlResource resource = new UrlResource(url);
InputStream is = resource.getInputStream();

二、spring中classpath和classpath*的区别

SpringBoot配置文件加载顺序,spring中classpath和classpath*的区别_第1张图片
多模块项目

我司项目几乎全采用这结构,所有配置文件统一放到order-config这个module里面,order-web-boot、order-service-boot均会依赖它。默认情况下,springboot启动时并不会读取order-config里面的配置文件,因为默认情况下,只会在当前项目也就是order-web-boot或者order-service-boot的classpath中寻找配置文件。那它到底如何读取到order-config配置文件的呢?请看下面四个截图


SpringBoot配置文件加载顺序,spring中classpath和classpath*的区别_第2张图片
image.png

SpringBoot配置文件加载顺序,spring中classpath和classpath*的区别_第3张图片
image.png

SpringBoot配置文件加载顺序,spring中classpath和classpath*的区别_第4张图片
image.png

SpringBoot配置文件加载顺序,spring中classpath和classpath*的区别_第5张图片
image.png

总结一下:order-web-boot引入了spring的xml配置,可是这个xml并不在当前的jar,而在依赖的jar中即order-web,所以classpath注意是带的,这样,这使得order-web-boot会在当前的jar和依赖的jar中寻找该xml配置文件。而该xml配置文件间接的引入了property-config.xml,该配置如上图所示,这意味着order-web除了会在当前的jar寻找properties配置文件,还会在order-config的classpath中寻找。经过以上的配置,所以order-config的配置文件才能被读取到。

classpath 具体指哪个路径?
src 路径下的文件 在编译后都会放到 WEB-INF/classes 路径下。默认classpath 就是指这里。

也可以在项目中输出classpath路径
Test.class.getResource("/").toString();
看看打印的结果是什么就知道了

classpath 是指web-inf 下classes目录
classes 是一个定位资源入口, 目录下用来存放:
各种资源配置文件,eg.init.properties, log4j.properties, struts.xml
存放模板文件 eg.actionerror.ftl
编译后的class文件,对应的是项目开发时src目录编译文件
classpath* 不仅包含class路径,还包括jar文件中(class路径)进行查找

你可能感兴趣的:(SpringBoot配置文件加载顺序,spring中classpath和classpath*的区别)