Spring Boot 3中如何手动加载并按Profile合并自定义YAML文件？

一、PropertySource合并问题解决 #

既然已经能匹配到目标资源（如my-custom-file.yaml和my-custom-file-profile1.yaml），可以复用Spring Boot内置逻辑实现和官方一致的属性覆盖+嵌套合并：

核心实现思路 #

Spring的属性合并遵循「后加载的高优先级配置覆盖低优先级，嵌套属性递归合并」的规则，我们可以通过MutablePropertySources的优先级机制来实现：

1. 先加载默认无Profile后缀的配置，作为基础属性源
2. 再加载激活Profile对应的配置，将其添加到属性源列表的更高优先级位置，自动覆盖同名属性

具体代码实现 #

1. 自定义YAML属性加载器

import org.springframework.boot.env.YamlPropertySourceLoader;
import org.springframework.core.env.MutablePropertySources;
import org.springframework.core.env.PropertySource;
import org.springframework.core.io.Resource;

import java.io.IOException;
import java.util.List;

public class CustomYamlPropertyLoader {
    private final YamlPropertySourceLoader yamlLoader = new YamlPropertySourceLoader();

    public void loadAndMerge(MutablePropertySources propertySources, Resource defaultRes, Resource profileRes) throws IOException {
        // 加载默认配置，添加到属性源列表
        List<PropertySource<?>> defaultSources = yamlLoader.load("custom-default", defaultRes);
        defaultSources.forEach(propertySources::addLast);

        // 加载Profile配置，添加到更高优先级位置实现覆盖
        if (profileRes.exists()) {
            List<PropertySource<?>> profileSources = yamlLoader.load("custom-profile", profileRes);
            profileSources.forEach(propertySources::addFirst);
        }
    }
}

2. 启动时注入加载逻辑

实现EnvironmentPostProcessor，在Spring环境初始化阶段执行自定义配置加载：

import org.springframework.boot.SpringApplication;
import org.springframework.boot.env.EnvironmentPostProcessor;
import org.springframework.core.env.ConfigurableEnvironment;
import org.springframework.core.io.FileSystemResource;

import java.io.IOException;

public class CustomYamlEnvPostProcessor implements EnvironmentPostProcessor {
    @Override
    public void postProcessEnvironment(ConfigurableEnvironment env, SpringApplication app) {
        String customDir = "my-custom-folder";
        String baseName = "my-custom-file";
        String[] activeProfiles = env.getActiveProfiles();

        // 加载默认配置
        FileSystemResource defaultRes = new FileSystemResource(customDir + "/" + baseName + ".yaml");
        // 加载第一个激活的Profile配置（多Profile场景可循环处理）
        FileSystemResource profileRes = activeProfiles.length > 0 
                ? new FileSystemResource(customDir + "/" + baseName + "-" + activeProfiles[0] + ".yaml")
                : null;

        CustomYamlPropertyLoader loader = new CustomYamlPropertyLoader();
        try {
            loader.loadAndMerge(env.getPropertySources(), defaultRes, profileRes);
        } catch (IOException e) {
            throw new RuntimeException("加载自定义YAML配置失败", e);
        }
    }
}

最后在src/main/resources/META-INF/spring.factories中注册处理器：

org.springframework.boot.env.EnvironmentPostProcessor=com.yourpackage.CustomYamlEnvPostProcessor

二、更优实现方式 #

方式1：复用Spring Boot ConfigData体系（推荐） #

Spring Boot 3基于ConfigData实现配置加载，自定义ConfigDataLoader和ConfigDataLocationResolver，可以让自定义YAML完全融入官方配置流程：

• 实现ConfigDataLocationResolver，解析自定义配置标识（如custom:my-custom-folder/my-custom-file）
• 实现ConfigDataLoader，复用官方YAML解析和Profile匹配逻辑
• 最终可以在application.yml中通过spring.config.import: custom:xxx直接引入，自动支持Profile切换、属性合并、优先级管理，完全对齐官方配置逻辑

方式2：@PropertySource结合Profile条件（轻量场景） #

如果项目场景简单，可直接用@PropertySource配合@Profile，但需自定义YAML支持的PropertySourceFactory：

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Profile;
import org.springframework.context.support.PropertySourcesPlaceholderConfigurer;
import org.springframework.core.io.FileSystemResource;

@Configuration
public class CustomYamlConfig {
    @Bean
    @Profile("default")
    public PropertySourcesPlaceholderConfigurer defaultConfig() {
        PropertySourcesPlaceholderConfigurer configurer = new PropertySourcesPlaceholderConfigurer();
        configurer.setLocation(new FileSystemResource("my-custom-folder/my-custom-file.yaml"));
        return configurer;
    }

    @Bean
    @Profile("profile1")
    public PropertySourcesPlaceholderConfigurer profile1Config() {
        PropertySourcesPlaceholderConfigurer configurer = new PropertySourcesPlaceholderConfigurer();
        configurer.setLocations(
                new FileSystemResource("my-custom-folder/my-custom-file.yaml"),
                new FileSystemResource("my-custom-folder/my-custom-file-profile1.yaml")
        );
        configurer.setIgnoreResourceNotFound(true);
        return configurer;
    }
}

这种方式无需复杂扩展，但需手动维护不同Profile的配置加载逻辑，适合小型项目。

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