如何使自定义Spring配置文件支持基于Profile的多环境加载？

我们当前有一个application.properties文件，以及一个基于激活的Spring Profile加载的application-staging.properties文件，但该配置文件过于臃肿，因此希望按上下文拆分成多个配置文件，例如teams.properties和teams-staging.properties。

我们使用如下配置类加载该配置：

@Getter
@Configuration
@PropertySource("classpath:teams.properties")
public class TeamsProperties {

    @Value("${teams.some-team-a}")
    private String someTeamA;

    @Value("${teams.some-team-b}")
    private String someTeamB;

}

但该方式无法识别激活的Profile，导致teams-staging.properties文件被忽略。请问需要如何实现自定义配置文件拥有与application.properties相同的默认加载行为？

要让自定义配置文件实现和application.properties一致的Profile感知加载逻辑，有以下几种实用方案：

方案一：通过@PropertySources结合Profile占位符 #

Spring允许在@PropertySource的路径中使用${spring.profiles.active}占位符，同时配置忽略不存在的资源，就能自动加载对应环境的配置文件：

@Getter
@Configuration
@PropertySources({
    @PropertySource("classpath:teams.properties"),
    @PropertySource(value = "classpath:teams-${spring.profiles.active}.properties", ignoreResourceNotFound = true)
})
public class TeamsProperties {

    @Value("${teams.some-team-a}")
    private String someTeamA;

    @Value("${teams.some-team-b}")
    private String someTeamB;

}

• ignoreResourceNotFound = true：避免没有对应Profile的配置文件时启动报错
• 加载优先级：teams-${spring.profiles.active}.properties中的配置会覆盖teams.properties里的同名配置，和application系列配置的行为完全一致

方案二：复用application命名规则（最省心） #

如果可以调整配置文件名，直接使用application-teams.properties和application-teams-staging.properties命名，Spring会自动识别这类"分片"配置文件，无需在配置类中添加@PropertySource注解，直接注入属性即可：

@Getter
@Configuration
public class TeamsProperties {

    @Value("${teams.some-team-a}")
    private String someTeamA;

    @Value("${teams.some-team-b}")
    private String someTeamB;

}

这种方式完全复用Spring默认的配置加载逻辑，激活对应Profile时，application-teams-staging.properties会自动覆盖application-teams.properties的配置，和主配置文件的行为保持统一。

方案三：自定义EnvironmentPostProcessor（高级场景） #

如果需要更灵活的加载逻辑（比如动态指定配置路径、多Profile组合加载），可以自定义EnvironmentPostProcessor手动添加配置文件：

public class CustomEnvironmentPostProcessor implements EnvironmentPostProcessor {
    private final PropertiesPropertySourceLoader loader = new PropertiesPropertySourceLoader();

    @Override
    public void postProcessEnvironment(ConfigurableEnvironment environment, SpringApplication application) {
        // 获取激活的Profile，无激活Profile时为空
        String activeProfile = environment.getActiveProfiles().length > 0 
            ? environment.getActiveProfiles()[0] 
            : "";
        
        List<String> configLocations = new ArrayList<>();
        configLocations.add("classpath:teams.properties");
        if (!activeProfile.isEmpty()) {
            configLocations.add("classpath:teams-" + activeProfile + ".properties");
        }

        // 加载并添加配置文件到环境中
        for (String location : configLocations) {
            try {
                Resource resource = new ClassPathResource(location);
                if (resource.exists()) {
                    PropertySource<?> propertySource = loader.load("teams-config", resource).get(0);
                    environment.getPropertySources().addLast(propertySource);
                }
            } catch (IOException e) {
                throw new RuntimeException("加载teams配置文件失败", e);
            }
        }
    }
}

然后在META-INF/spring.factories中注册这个处理器：

org.springframework.boot.env.EnvironmentPostProcessor=com.your.package.CustomEnvironmentPostProcessor

这种方式适合有复杂加载规则的场景。

内容的提问来源于stack exchange，提问作者Marian Klühspies