Spring Boot按Profile加载额外配置文件及测试适配问题

文件结构 #

- main/resources
    - application.yml
    - externalApi.yml
    - application-dev.yml
    - externalApi-dev.yml
 - test/resources
    - application-test.yml
    - externalApi-test.yml

配置加载实现 #

为了让ApiWebClient类根据激活的Profile加载对应版本的externalApi.yml，在实现类上使用了@PropertySource注解：

@PropertySource(value = "classpath:externalApi-${spring.profiles.active}.yml", factory = YamlPropertySourceFactory.class)
public class ApiWebClientImpl implements ApiWebClient {

测试异常情况 #

应用启动运行正常，但执行测试时出现错误。测试类代码如下：

@SpringBootTest(classes = TestApplication.class)
@EnableConfigurationProperties
@ConfigurationPropertiesScan(basePackages = "com.xyz.testapplication")
@ActiveProfiles(value = "test")
public class ApiWebClientTest {

执行Maven命令 mvn clean install -Ptest 时，抛出以下异常：

java.lang.IllegalArgumentException: Could not resolve placeholder 'spring.profiles.active' in value "classpath:externalApi-${spring.profiles.active}.yml

手动在@SpringBootTest中添加properties = "spring.profiles.active=test"后测试可正常运行，但不想修改所有测试类，需要解决三个问题：

• 如何自动解决该测试异常？
• 为何@ActiveProfiles注解在此场景下不生效？
• 是否有办法去掉@PropertySource注解中的${spring.profiles.active}占位符？

1. @ActiveProfiles不生效的原因 #

@PropertySource的解析时机早于@ActiveProfiles的激活流程。Spring在处理类上的@PropertySource注解时，Profile的激活逻辑还未执行，此时spring.profiles.active这个占位符没有可解析的值，因此抛出异常。而手动添加properties = "spring.profiles.active=test"是直接设置了系统级属性，在@PropertySource解析时就能获取到对应值，所以可以正常运行。

2. 自动解决测试异常的方法 #

方法一：结合@Profile注解绑定不同Profile的配置文件 #

给每个Profile对应的externalApi.yml单独添加@PropertySource，并用@Profile限定其生效的Profile，同时保留默认配置的加载：

@PropertySource(value = "classpath:externalApi.yml", factory = YamlPropertySourceFactory.class)
@Profile("default")
@PropertySource(value = "classpath:externalApi-dev.yml", factory = YamlPropertySourceFactory.class)
@Profile("dev")
@PropertySource(value = "classpath:externalApi-test.yml", factory = YamlPropertySourceFactory.class)
@Profile("test")
public class ApiWebClientImpl implements ApiWebClient {

Spring会根据当前激活的Profile自动加载对应的配置文件，无需依赖占位符解析。

方法二：利用Spring Boot原生多Profile配置导入机制 #

Spring Boot本身支持多Profile配置的自动导入，无需在类上添加@PropertySource。只需在各环境的application-{profile}.yml中配置导入对应externalApi文件：

• 在application.yml（默认环境）中添加：

spring:
  config:
    import: classpath:externalApi.yml

• 在application-dev.yml中添加：

spring:
  config:
    import: classpath:externalApi-dev.yml

• 在application-test.yml中添加：

spring:
  config:
    import: classpath:externalApi-test.yml

这样Spring Boot会根据激活的Profile自动导入对应的配置文件，彻底规避占位符解析的时机问题。

3. 去掉${spring.profiles.active}占位符的方案 #

上述两种方法都可以去掉@PropertySource中的占位符：

• 方法一通过@Profile注解为不同环境绑定对应的配置文件，完全不需要占位符；
• 方法二直接利用Spring Boot原生的配置导入逻辑，无需使用@PropertySource注解，从根源上消除占位符。

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