如何显式检查Spring Profile？实现启动前校验并抛出明确错误

可以实现，而且有多种方式能在Bean初始化之前完成Profile校验，直接抛出明确错误终止应用启动，避免不必要的资源消耗。以下是几种实用方案：

方案一：使用EnvironmentPostProcessor #

这是Spring Boot提供的扩展点，会在环境准备完成后、应用上下文创建前执行，时机非常早。

1. 实现EnvironmentPostProcessor接口，编写校验逻辑：

import org.springframework.boot.SpringApplication;
import org.springframework.boot.env.EnvironmentPostProcessor;
import org.springframework.core.env.ConfigurableEnvironment;
import java.util.Set;

public class ProfileValidationPostProcessor implements EnvironmentPostProcessor {

    // 定义允许的Profile集合
    private static final Set<String> ALLOWED_PROFILES = Set.of("dev", "test", "prod");

    @Override
    public void postProcessEnvironment(ConfigurableEnvironment environment, SpringApplication application) {
        String[] activeProfiles = environment.getActiveProfiles();
        
        // 校验是否有激活的Profile
        if (activeProfiles.length == 0) {
            throw new IllegalStateException("未激活任何Profile，请指定允许的Profile：" + ALLOWED_PROFILES);
        }
        
        // 校验每个激活的Profile是否在允许列表内
        for (String profile : activeProfiles) {
            if (!ALLOWED_PROFILES.contains(profile)) {
                throw new IllegalStateException("不允许使用Profile：" + profile + "，仅支持：" + ALLOWED_PROFILES);
            }
        }
    }
}

2. 在项目的src/main/resources/META-INF/spring.factories文件中注册这个处理器：

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

方案二：使用SpringApplicationRunListener #

这个扩展点能监听应用启动的各个阶段，我们可以在environmentPrepared阶段完成校验。

1. 实现SpringApplicationRunListener接口：

import org.springframework.boot.SpringApplication;
import org.springframework.boot.SpringApplicationRunListener;
import org.springframework.context.ConfigurableApplicationContext;
import org.springframework.core.env.ConfigurableEnvironment;
import java.util.Set;

public class ProfileCheckRunListener implements SpringApplicationRunListener {

    private static final Set<String> ALLOWED_PROFILES = Set.of("dev", "test", "prod");

    // 必须包含该构造方法
    public ProfileCheckRunListener(SpringApplication application, String[] args) {}

    @Override
    public void environmentPrepared(ConfigurableEnvironment environment) {
        String[] activeProfiles = environment.getActiveProfiles();
        
        if (activeProfiles.length == 0) {
            throw new IllegalStateException("未激活任何Profile，请指定允许的Profile：" + ALLOWED_PROFILES);
        }
        
        for (String profile : activeProfiles) {
            if (!ALLOWED_PROFILES.contains(profile)) {
                throw new IllegalStateException("不允许使用Profile：" + profile + "，仅支持：" + ALLOWED_PROFILES);
            }
        }
    }

    // 其他未用到的方法留空实现即可
    @Override
    public void starting() {}
    @Override
    public void contextPrepared(ConfigurableApplicationContext context) {}
    @Override
    public void contextLoaded(ConfigurableApplicationContext context) {}
    @Override
    public void started(ConfigurableApplicationContext context) {}
    @Override
    public void running(ConfigurableApplicationContext context) {}
    @Override
    public void failed(ConfigurableApplicationContext context, Throwable exception) {}
}

2. 同样在spring.factories中注册：

org.springframework.boot.SpringApplicationRunListener=com.yourpackage.ProfileCheckRunListener

方案三：启动前手动校验 #

如果是自己编写main方法启动应用，可以在调用run()之前手动加载环境并完成校验：

import org.springframework.boot.SpringApplication;
import org.springframework.core.env.ConfigurableEnvironment;
import org.springframework.core.env.StandardEnvironment;
import java.util.Set;

public class Application {

    private static final Set<String> ALLOWED_PROFILES = Set.of("dev", "test", "prod");

    public static void main(String[] args) {
        // 创建环境实例并加载配置
        ConfigurableEnvironment environment = new StandardEnvironment();
        SpringApplication application = new SpringApplication(Application.class);
        application.setEnvironment(environment);
        application.prepareEnvironment(environment, args);

        // 执行Profile校验
        String[] activeProfiles = environment.getActiveProfiles();
        if (activeProfiles.length == 0) {
            throw new IllegalStateException("未激活任何Profile，请指定允许的Profile：" + ALLOWED_PROFILES);
        }
        for (String profile : activeProfiles) {
            if (!ALLOWED_PROFILES.contains(profile)) {
                throw new IllegalStateException("不允许使用Profile：" + profile + "，仅支持：" + ALLOWED_PROFILES);
            }
        }

        // 校验通过后启动应用
        application.run(args);
    }
}

以上三种方案都能在Bean初始化前完成校验，一旦发现不符合要求的Profile，会立即抛出明确的异常信息，直接终止应用启动。

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