1. `Spring application`中配置项的优先级

ApplicationPreparedEvent:[bootstrapProperties]                                  # 来自configServer的值
ApplicationPreparedEvent:[commandLineArgs]                                      # 命令行参数
ApplicationPreparedEvent:[servletConfigInitParams]
ApplicationPreparedEvent:[servletContextInitParams]
ApplicationPreparedEvent:[systemProperties]                                     # 系统配置参数
ApplicationPreparedEvent:[systemEnvironment]                                    # 系统环境变量
ApplicationPreparedEvent:[random]
ApplicationPreparedEvent:[applicationConfig: [classpath:/application-test.yml]] # 指定生效的`application-XX.yml`
ApplicationPreparedEvent:[applicationConfig: [classpath:/application.yml]]      # 本地的`application.yml`
ApplicationPreparedEvent:[springCloudClientHostInfo]
ApplicationPreparedEvent:[applicationConfig: [classpath:/bootstrap.yml]]        # 本地的`bootstrap.yml`
ApplicationPreparedEvent:[defaultProperties]                                    # 默认配置
ApplicationPreparedEvent:[Management Server]

Spring想要得到一个配置的值，就按照上面的顺序一个个去找，找到就直接返回。

由于ConfigServer处于最高优先级，本地项目不管怎么设置都不能覆盖（当然可以改变配置项的加载次序，但最好不要这样做，见参考资料）。

上面的排序是通过 implements ApplicationListener 然后打印出来的。测试程序如下：

@Component
public class ApplicationPreparedEventListener implements ApplicationListener<ApplicationPreparedEvent> {

    @Override
    public void onApplicationEvent(ApplicationPreparedEvent event) {

        // 初始化完成
        ConfigurableApplicationContext context = ((ApplicationPreparedEvent) event).getApplicationContext();
        ConfigurableEnvironment environment = context.getEnvironment();
        MutablePropertySources propertySources = environment.getPropertySources();
        if (propertySources != null) {
            Iterator<PropertySource<?>> iterator = propertySources.iterator();
            while (iterator.hasNext()) {
                PropertySource<?> propertySource = (PropertySource<?>) iterator.next();
                System.err.println("ApplicationPreparedEvent:[" + propertySource.getName() + "]");
            }
        }

    }
}

2. 我的解释

（1）Spring中属性的配置有多个来源，按照加载次序生效。也就是说，对于某个属性的值，哪个先出现，就以先出现的为准，后面出现的值不会覆盖之前的生效值。

（2）如果没有添加config相关依赖，则不能使用配置中心，因为bootstrap.yml不会被加载（与配置中心相关的某个配置只能放在bootstrap.yml中，见后文）。

<dependency>
		<groupId>org.springframework.cloud</groupId>
		<artifactId>spring-cloud-starter-config</artifactId>
</dependency>

或

<dependency>
  <groupId>org.springframework.cloud</groupId>
  <artifactId>spring-cloud-config-client</artifactId>
</dependency>

（3）如果使用配置中心，则需要添加添加config相关依赖。

（3.1）应用程序则会首先加载bootstrap.yml，读取关于配置中心的相关配置：

spring.cloud.config.name: this-is-your-application-name
spring.cloud.config.profile: pro
spring.cloud.config.label: master
spring.cloud.config.uri: http://127.0.0.1:8080

以上4个属性的加载非常有意思，只有这4个属性全部集齐，才能~~召唤神龙~~访问配置中心!

注意：

spring.cloud.config.uri配置只能放在bootstrap.yml中（所以必须添加config相关依赖，才能使用配置中心）
spring.cloud.config.label与spring.cloud.config.profile不一定要放在bootstrap.yml中，只要按照加载次序能加载到就行。
spring.cloud.config.name这个属性也不一定要放在bootstrap.yml中，只要按照加载次序能加载到就行。而且，如果该属性不配置，则以spring.application.name为准。也就是说，有乔选乔spring.cloud.config.name，无乔选鲨spring.application.name。

如果这4个属性不能全部加载到，则配置中心失效。

（3.2）然后从配置中心读取application.yml相关属性。

（3.3）之后再从本地读取application.yml相关属性。

（3.4）最后再从bootstrap.yml读取其他属性。

（4）如果使用--spring.profiles.active=XX参数，则指定生效的application-XX.yml在配置中心读取application.yml相关属性之后，本地读取application.yml相关属性之前加载。如果没有使用配置中心，则指定生效的application-XX.yml是最高优先级。

3. 我的总结

基本的加载次序为：

配置中心的application.yml
指定生效的application-XX.yml
本地的application.yml
本地的bootstrap.yml

相同的属性，不同的值，以第一次加载为准！

4. 我的建议

（1）如果项目组使用配置中心，则除了在配置中心的application.yml设置属性外，项目本地也保留一份与远端配置相同的本地的application.yml，这样是为了防止配置中心失效（概率极低）而不能启动项目

（2）如果项目组不使用配置中心，请将配置放在本地的application.yml中而不是bootstrap.yml中，因为读取bootstrap.yml文件需要额外添加config相关依赖

（3）如果项目组不使用配置中心，指定生效的application-XX.yml可用来同一个应用部署到不同环境，在启动时通过--spring.profiles.active=XX参数来指定生效的配置文件

示例：假如现在同一个应用需要部署到测试与生产，同时本地是第三套环境，则在资源路径添加 3 个文件：

application.yml（本地）
application-test.yml（测试）
application-pro.yml（生产）

本地启动时，不需要添加任何参数，使用的就是本地的配置；

在上测试时，指定--spring.profiles.active=test，则测试的配置生效；

在上生产时，指定--spring.profiles.active=pro，则生产的配置生效。

5. 配置中心如果不使用 config，而使用 Apollo

在 Apollo 的客户端，类：ApolloApplicationContextInitializer

实现的原理如下：在读取 Apollo 的配置之后，放入本地 Environment 头部，保证优先级比本地更高。

 /**
   * Initialize Apollo Configurations Just after environment is ready.
   *
   * @param environment
   */
  protected void initialize(ConfigurableEnvironment environment) {
    if (environment.getPropertySources().contains(PropertySourcesConstants.APOLLO_BOOTSTRAP_PROPERTY_SOURCE_NAME)) {
      //already initialized
      return;
    }
    String namespaces = environment.getProperty(PropertySourcesConstants.APOLLO_BOOTSTRAP_NAMESPACES, ConfigConsts.NAMESPACE_APPLICATION);
    logger.debug("Apollo bootstrap namespaces: {}", namespaces);
    List<String> namespaceList = NAMESPACE_SPLITTER.splitToList(namespaces);
    CompositePropertySource composite = new CompositePropertySource(PropertySourcesConstants.APOLLO_BOOTSTRAP_PROPERTY_SOURCE_NAME);
    for (String namespace : namespaceList) {
      Config config = ConfigService.getConfig(namespace);
      composite.addPropertySource(configPropertySourceFactory.getConfigPropertySource(namespace, config));
    }
    environment.getPropertySources().addFirst(composite);
  }

Apollo 的配置的优先级比命令行参数（commandLineArgs）低，但比本地配置要高。

6. 疑问：bootstrap.yaml 文件到底由谁加载的？

回答：spring-cloud-context

Spring Cloud 容器是靠 Bootstrap Context 引导上下文来启动的，对应的类是 BootstrapApplicationListener。

这在 2020.0 版本发生了改变，新版本的 Spring Cloud 不再依赖于此上下文而启动。因此默认情况下，将不再启动 Bootstrap 上下文。代码层面的改变发生在这里：

//之前
BootstrapApplicationListener：

@Override
public void onApplicationEvent(ApplicationEnvironmentPreparedEvent event) {
  ConfigurableEnvironment environment = event.getEnvironment();
  if (!environment.getProperty("spring.cloud.bootstrap.enabled", Boolean.class,
      true)) {
    return;
  }


//之后
BootstrapApplicationListener：

 @Override
 public void onApplicationEvent(ApplicationEnvironmentPreparedEvent event) {
  ConfigurableEnvironment environment = event.getEnvironment();
  // 在方法开头加了这麽个判断
  if (!bootstrapEnabled(environment) && !useLegacyProcessing(environment)) {
   return;
  }
  ...
 }

PropertyUtils：

 // BOOTSTRAP_ENABLED_PROPERTY = spring.cloud.bootstrap.enabled
 public static boolean bootstrapEnabled(Environment environment) {
  return environment.getProperty(BOOTSTRAP_ENABLED_PROPERTY, Boolean.class, false) || MARKER_CLASS_EXISTS;
 }
 // USE_LEGACY_PROCESSING_PROPERTY = spring.config.use-legacy-processing
 public static boolean useLegacyProcessing(Environment environment) {
  return environment.getProperty(USE_LEGACY_PROCESSING_PROPERTY, Boolean.class, false);
 }

若你需要开启 Bootstrap 上下文，有两种办法可以实现：

设置值 spring.cloud.bootstrap.enabled=true 或者 spring.config.use-legacy-processing=true 即可。注意：这些个属性值必须确保其能放进环境里才能生效。比如靠谱的方式是：系统属性、环境变量、命令行等

引入一个 Jar：org.springframework.cloud:spring-cloud-starter-bootstrap，然后什么都不用做了

说明：这个 jar 里面有且仅有一个 Marker 类，作用你懂的，此处不做过多解释

7. bootstrap.yml 不生效问题解决方案

2020 版本以后，添加 spring-cloud-context 是没有用的，因为官方重构了 bootstrap 引导配置的加载方式

见官方描述

Spring Boot 2.4 introduced a new way to import configuration data via the spring.config.import property. This is now the default way to bind to Config Server.

官方解决方案

To use the legacy bootstrap way of connecting to Config Server, bootstrap must be enabled via a property or the spring-cloud-starter-bootstrap starter. The property is spring.cloud.bootstrap.enabled=true. It must be set as a System Property or environment variable.

即：

（1）引入 spring-cloud-starter-bootstrap

<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-bootstrap</artifactId>
</dependency>

（2）设置 JVM 参数（系统配置或环境变量）

-Dspring.cloud.bootstrap.enabled=true

8. SpringBoot 加载多个配置文件

（1）spring.config.import

application.yml 中使用 spring.config.import，有 2 个效果：

一是配置按次序加载；

二是同名配置可被覆盖；

可配置多个（按次序，可被覆盖）：

spring.config.import: application-nacos.yaml,application-apollo.yaml

（2）spring.profiles.include

可配置多个（以第一个为准）：

spring.profiles.include: apollo,nacos

（3）spring.profiles.active

可配置多个（以第一个为准）：

spring.profiles.active: apollo,nacos

参考资料

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

SpringBoot配置优先级.md

SpringBoot配置优先级.md

1. `Spring application`中配置项的优先级

2. 我的解释

3. 我的总结

4. 我的建议

5. 配置中心如果不使用 config，而使用 Apollo

6. 疑问：bootstrap.yaml 文件到底由谁加载的？

7. bootstrap.yml 不生效问题解决方案

8. SpringBoot 加载多个配置文件

参考资料

1. 【SpringBoot】SpringCloud Config Server 实践

2. 基于 SpringBoot bootstrap.yml 配置未生效的解决

3. The Bootstrap Application Context

4. SpringCloud 入门之常用的配置文件 application.yml 和 bootstrap.yml 区别

5. SpringCloud 2020.x.x 工程 bootstrap 引导配置不生效的解决方案

6. SpringBoot 加载多个配置文件

7. spring boot 加载多个配置文件，yml 或 properties 类型

Files

SpringBoot配置优先级.md

Latest commit

History

SpringBoot配置优先级.md

File metadata and controls

1. Spring application中配置项的优先级

2. 我的解释

3. 我的总结

4. 我的建议

5. 配置中心如果不使用 config，而使用 Apollo

6. 疑问：bootstrap.yaml 文件到底由谁加载的？

7. bootstrap.yml 不生效问题解决方案

8. SpringBoot 加载多个配置文件

参考资料

1. 【SpringBoot】SpringCloud Config Server 实践

2. 基于 SpringBoot bootstrap.yml 配置未生效的解决

3. The Bootstrap Application Context

4. SpringCloud 入门之常用的配置文件 application.yml 和 bootstrap.yml 区别

5. SpringCloud 2020.x.x 工程 bootstrap 引导配置不生效的解决方案

6. SpringBoot 加载多个配置文件

7. spring boot 加载多个配置文件，yml 或 properties 类型

1. `Spring application`中配置项的优先级