如何阻止Spring Boot自动将ReadinessState设为ACCEPTING_TRAFFIC？

在Spring Boot 2.3及以上版本中，默认会在所有Bean初始化完成后将ReadinessState设为ACCEPTING_TRAFFIC。如果需要在ContextRefreshedEvent监听器中完成大量数据加载后再开放流量，可以通过以下两种方式实现：

方法一：直接操作ReadinessStateManager #

通过注入ReadinessStateManager，在数据加载前后手动切换Readiness状态：

@Component
public class DataLoadingListener implements ApplicationListener<ContextRefreshedEvent> {

    private final ReadinessStateManager readinessStateManager;

    // 构造函数注入ReadinessStateManager
    public DataLoadingListener(ReadinessStateManager readinessStateManager) {
        this.readinessStateManager = readinessStateManager;
    }

    @Override
    public void onApplicationEvent(ContextRefreshedEvent event) {
        // 初始化完成后立即拒绝流量
        readinessStateManager.setReadinessState(ReadinessState.REFUSING_TRAFFIC);
        
        // 执行大量数据加载逻辑
        loadLargeDataSet();
        
        // 加载完成后恢复接收流量
        readinessStateManager.setReadinessState(ReadinessState.ACCEPTING_TRAFFIC);
    }

    private void loadLargeDataSet() {
        // 这里编写你的数据加载代码，比如从数据库、文件或外部接口拉取数据
    }
}

方法二：自定义Readiness健康指示器 #

通过实现ReadinessHealthIndicator，让Spring Boot根据数据加载状态自动调整ReadinessState：

1. 自定义健康指示器：

@Component
public class DataLoadReadinessIndicator implements ReadinessHealthIndicator {

    private boolean dataLoadCompleted = false;

    @Override
    public Health health() {
        if (!dataLoadCompleted) {
            return Health.down()
                    .withDetail("status", "data loading in progress")
                    .build();
        }
        return Health.up().build();
    }

    // 提供方法更新加载状态
    public void markDataLoadCompleted() {
        this.dataLoadCompleted = true;
    }
}

2. 在监听器中调用状态更新方法：

@Component
public class DataLoadingListener implements ApplicationListener<ContextRefreshedEvent> {

    private final DataLoadReadinessIndicator readinessIndicator;

    public DataLoadingListener(DataLoadReadinessIndicator readinessIndicator) {
        this.readinessIndicator = readinessIndicator;
    }

    @Override
    public void onApplicationEvent(ContextRefreshedEvent event) {
        // 执行数据加载
        loadLargeDataSet();
        
        // 标记加载完成，触发Readiness状态切换
        readinessIndicator.markDataLoadCompleted();
    }

    private void loadLargeDataSet() {
        // 数据加载逻辑
    }
}

两种方法对比：

• 方法一更直接，状态切换时机完全由代码控制，适合对流程有明确掌控需求的场景。
• 方法二更贴合Spring Boot健康检查的设计理念，通过健康状态间接控制Readiness，适合需要对外暴露加载状态的场景。

内容的提问来源于stack exchange，提问作者Fábio