Spring Cloud Config Server环境下configtree配置不生效原因排查

核心原因 #

spring.config.import是Spring Boot启动早期必须处理的引导类配置——它用来告诉应用要加载哪些额外的配置源（比如configtree、Config Server本身），这个处理步骤发生在应用拉取Config Server配置之前。而你放在myapplication-dev.yml里的spring.config.import是从Config Server拉取的应用级配置，等应用读到这份配置时，加载配置源的窗口期已经过了，所以不会生效。

详细逻辑 #

Spring Boot加载配置的顺序是固定的，关键步骤如下：

1. 启动初期，先读取引导配置：包括启动参数、环境变量、本地的bootstrap.yml/properties，以及你本地application.yml里指定的configserver地址——这些配置用来确定应用要从哪里加载后续的配置；
2. 根据引导配置连接Config Server，拉取对应环境的应用配置（也就是你的myapplication-dev.yml）；
3. 最后加载应用配置里的业务参数。

你在myapplication-dev.yml里写的spring.config.import是在步骤2之后才被读取的，这时候应用已经完成了所有配置源的初始化工作，不会再回头处理这个配置项。而通过启动参数添加时，启动参数属于引导配置，会在步骤1被处理，所以configtree能正常被加载。

正确配置方案 #

要让configtree生效，必须把它放到引导配置层面，而不是从Config Server拉取的应用配置中：

1. 启动参数/环境变量：就像你已经验证的方式，在deployment的args里添加参数，或者通过env设置SPRING_CONFIG_IMPORT环境变量；
2. 本地bootstrap配置文件：在应用中创建对应环境的bootstrap-dev.yml，把spring.config.import写入：

   spring:
     config:
       import: optional:configtree:/usr/src/apps/secrets/database/postgresql/
   

   注意：如果用Spring Boot 2.4及以上版本，需要确保项目引入了spring-cloud-starter-bootstrap依赖，否则bootstrap系列的配置文件不会被自动加载。

内容的提问来源于stack exchange，提问作者Prashant