如何程序化加载Spring环境专属YML并绑定到@ConfigurationProperties类

1. 核心思路 #

借助Spring的Binder工具类，手动把已加载好的PropertySource内容绑定到ApplicationConfig实例上，绕开Spring自动配置的上下文逻辑，实现自定义的配置映射流程。

2. 基础绑定代码实现 #

假设你已经通过代码（比如YamlPropertySourceLoader）拿到了目标配置对应的PropertySource对象，直接用以下代码完成映射：

import org.springframework.boot.context.properties.bind.Binder;
import org.springframework.core.env.PropertySource;
import org.springframework.core.env.MutablePropertySources;

// 已加载完成的目标配置源（比如从application-dev.yml读取的结果）
PropertySource<?> targetPropertySource = ...;

// 创建可修改的属性源集合，将目标配置源加入
MutablePropertySources propertySources = new MutablePropertySources();
propertySources.addFirst(targetPropertySource);

// 绑定配置到ApplicationConfig实例
ApplicationConfig config = Binder.get(propertySources)
        .bind("sdlc", ApplicationConfig.class)
        .orElseThrow(() -> new IllegalArgumentException("无法将配置绑定到ApplicationConfig"));

// 后续直接调用getter获取属性，例如config.getTenantId()

3. 结合Rest Controller的完整流程示例 #

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.boot.context.properties.bind.Binder;
import org.springframework.core.env.MutablePropertySources;
import org.springframework.core.env.PropertySource;
import org.springframework.core.io.ClassPathResource;
import org.springframework.boot.env.YamlPropertySourceLoader;

import java.io.IOException;

@RestController
public class ConfigController {

    @GetMapping("/fetch-config")
    public ApplicationConfig fetchConfig(@RequestParam String gitlabBranch) throws IOException {
        // 根据传入的分支匹配对应配置文件名
        String configFileName = switch (gitlabBranch) {
            case "develop" -> "application-dev.yml";
            case "master" -> "application-uat.yaml";
            default -> throw new IllegalArgumentException("不支持的分支：" + gitlabBranch);
        };

        // 加载指定配置文件为PropertySource
        YamlPropertySourceLoader loader = new YamlPropertySourceLoader();
        PropertySource<?> propertySource = loader.load(configFileName, new ClassPathResource(configFileName))
                .get(0);

        // 绑定配置到ApplicationConfig并返回
        MutablePropertySources propertySources = new MutablePropertySources();
        propertySources.addFirst(propertySource);
        return Binder.get(propertySources)
                .bind("sdlc", ApplicationConfig.class)
                .orElseThrow(() -> new RuntimeException("配置绑定失败"));
    }
}

4. 关键注意事项 #

• 确保ApplicationConfig类的字段与配置文件中sdlc.*开头的键一一对应，且具备正确的getter/setter方法（可使用Lombok的@Data注解简化代码）
• 如果配置文件不在classpath下，需替换ClassPathResource为对应路径的资源类（比如FileSystemResource）
• 异常处理可根据业务场景调整，比如返回标准化的错误响应而非直接抛出异常

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