如何让Spring Boot在启动任务完成前禁止端点对外暴露？

在Spring Boot应用中，能否实现一种启动流程，在启动任务完成前阻止所有端点（及其他应用公共接口）对外暴露？

例如尝试通过ApplicationRunner实现：

@Component
public class MyBlockingStartupRunner implements ApplicationRunner {
    
    @Override
    public void run(ApplicationArguments args) {
        // 执行任务，调用外部API、处理返回值等
        startTask();
        // 此时应用应可接收REST请求、执行定时任务等
        someObject.appIsReadyToGo(); // 或者方法结束时应用就绪
    }
}

但使用ApplicationRunner的问题在于，此时Web服务器已经启动，可能有API请求进入但无法处理。用户不希望通过每个端点加检查或创建拦截器的方式解决，想了解Spring是否有原生实现方式。

Spring Boot提供了SmartLifecycle接口，可以通过它控制Bean的启动时机，从而实现在Web服务器启动前完成初始化任务，自然阻止端点对外暴露，无需额外的拦截或检查逻辑。

实现步骤 #

• 实现SmartLifecycle接口，通过getPhase()方法设置启动优先级，确保自定义的初始化任务在Web服务器启动前执行。
• 在start()方法中完成所有启动前任务，任务执行完毕后标记组件为运行状态，Spring会自动继续启动Web服务器。

代码示例 #

@Component
public class PreStartupInitializer implements SmartLifecycle {

    private boolean isRunning = false;

    @Override
    public void start() {
        // 执行启动前的核心任务：调用外部API、初始化数据等
        executePreStartupTasks();
        
        // 任务完成后标记为运行状态，触发后续Web服务器启动流程
        isRunning = true;
    }

    private void executePreStartupTasks() {
        // 替换为实际业务逻辑
        try {
            System.out.println("开始执行启动前任务...");
            Thread.sleep(5000);
            System.out.println("启动前任务执行完成，准备启动Web服务器");
        } catch (InterruptedException e) {
            Thread.currentThread().interrupt();
            throw new RuntimeException("启动前任务执行失败", e);
        }
    }

    @Override
    public void stop() {
        isRunning = false;
    }

    @Override
    public boolean isRunning() {
        return isRunning;
    }

    @Override
    public int getPhase() {
        // 设置优先级低于Web服务器启动组件（WebServerStartStopLifecycle的phase为Integer.MAX_VALUE - 1）
        // 确保当前组件的start()方法先执行
        return Integer.MAX_VALUE - 2;
    }
}

原理说明 #

Spring Boot的生命周期管理中，SmartLifecycle的getPhase()返回值越小，启动优先级越高。Web服务器的启动组件WebServerStartStopLifecycle的phase为Integer.MAX_VALUE - 1，我们设置自定义组件的phase为Integer.MAX_VALUE - 2，会优先执行其start()方法。只有当自定义组件标记为isRunning=true后，Spring才会继续启动Web服务器，此时所有端点才对外暴露。

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