Spring Boot应用初始化前读取属性设置遗留环境配置的技术问询

我来帮你实现这个在Spring Boot应用初始化前，读取指定配置文件来配置遗留环境的需求，结合你给出的代码框架，咱们一步步来完善：

1. 先完善基础的@PropertySource配置 #

你给出的类框架已经有了雏形，首先我们要确保指定的配置文件能被正确加载，同时避免因为某个文件不存在导致启动失败，加上ignoreResourceNotFound = true就很稳妥：

@SpringBootApplication
@PropertySource(
    value = {"classpath:app.properties", "classpath:presentation-api.properties", "classpath:various_other.properties"},
    ignoreResourceNotFound = true
)
public class MainApp extends SpringBootServletInitializer {

    @Override
    protected SpringApplicationBuilder configure(SpringApplicationBuilder application) {
        return application.sources(MainApp.class);
    }

    public static void main(String[] args) {
        SpringApplication.run(MainApp.class, args);
    }
}

不过这里要注意：@PropertySource是在Spring上下文初始化阶段才加载配置的，如果你的遗留环境配置需要在启动更早的阶段（比如激活profiles的时候）生效，那这个方式就不够了，得用下面的进阶方案。

2. 启动前加载配置（适配Legacy Profiles） #

如果你的遗留配置是用来设置profiles这类需要在上下文初始化前生效的内容，那我们得自定义EnvironmentPostProcessor，它能在Spring Boot的环境准备阶段就加载配置：

第一步：写个自定义的EnvironmentPostProcessor #

这个处理器会在启动早期加载咱们指定的配置文件，并且把它放到环境属性的最前面，保证优先级：

public class LegacyConfigEnvironmentPostProcessor implements EnvironmentPostProcessor {

    // 定义要加载的配置文件路径
    private static final String[] LEGACY_CONFIGS = {
            "classpath:app.properties",
            "classpath:presentation-api.properties"
    };

    private final PropertiesPropertySourceLoader loader = new PropertiesPropertySourceLoader();

    @Override
    public void postProcessEnvironment(ConfigurableEnvironment environment, SpringApplication application) {
        for (String configPath : LEGACY_CONFIGS) {
            try {
                ClassPathResource resource = new ClassPathResource(configPath);
                if (resource.exists()) {
                    // 加载配置文件并添加到环境属性中
                    List<PropertySource<?>> propertySources = loader.load("legacy-env-config", resource);
                    propertySources.forEach(ps -> environment.getPropertySources().addFirst(ps));
                }
            } catch (IOException e) {
                throw new IllegalStateException("加载遗留配置文件失败：" + configPath, e);
            }
        }
    }
}

第二步：让Spring Boot发现这个处理器 #

在classpath:META-INF/spring.factories文件里添加下面的配置，Spring Boot启动时就会自动调用咱们的处理器：

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

（记得把com.your.package换成你实际的包路径）

3. 用加载的配置配置遗留Profiles #

现在配置已经在启动早期加载好了，咱们可以在处理器里直接读取属性来设置遗留环境的profiles：

修改上面的postProcessEnvironment方法，加一段逻辑：

@Override
public void postProcessEnvironment(ConfigurableEnvironment environment, SpringApplication application) {
    // 先加载配置文件（上面的代码）
    for (String configPath : LEGACY_CONFIGS) {
        // ... 省略加载逻辑
    }
    
    // 读取遗留profiles配置并激活
    String legacyProfiles = environment.getProperty("legacy.profiles");
    if (legacyProfiles != null && !legacyProfiles.trim().isEmpty()) {
        String[] profilesArray = legacyProfiles.split(",");
        environment.setActiveProfiles(profilesArray);
    }
}

这样，在Spring上下文初始化前，遗留的profiles就已经被激活了。

4. 验证配置是否生效 #

可以写个简单的Controller来验证配置是否被正确加载：

@RestController
public class ConfigCheckController {

    @Autowired
    private Environment env;

    @GetMapping("/check-legacy-config")
    public String checkConfig() {
        String appProp = env.getProperty("app.some.key");
        String presentationProp = env.getProperty("presentation.api.some.key");
        return String.format("app配置：%s，Presentation API配置：%s", appProp, presentationProp);
    }
}

启动应用后访问这个接口，就能看到配置是否加载成功了。

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