Spring Boot服务完成指定任务后安全优雅停机的实现方案

问题背景 #

我有多款持续运行的Spring Boot服务，执行各类任务：

• 某服务通过Spring Cloud Stream读取Azure Service Bus队列消息，交由@Service类方法处理
• 还有执行定时数据库调用、对外提供接口接收任务的服务

希望收到Kubernetes的SIGTERM信号时，确保当前正在处理的任务完成后再停机，避免数据不一致。已配置spring.lifecycle.timeout-per-shutdown-phase=15s、server.shutdown=graceful，以及K8s PreStop钩子sleep 15，但无效；尝试ContextClosedEvent监听器，只能靠Thread.sleep等待，想找更合理的实现方式。

解决方案 #

一、Spring内置优雅停机适配 #

1. Spring Cloud Stream专属配置

当前配置无效的核心原因是Spring Cloud Stream绑定器默认不会自动感知Spring的优雅停机，需添加以下配置让绑定器停止接收新消息并等待现有任务完成：

# 限制并发数（根据实际场景调整，单线程更易跟踪任务状态）
spring.cloud.stream.bindings.readMessage-in-scope.consumer.max-concurrency=1
spring.cloud.stream.bindings.readMessage-in-scope.consumer.auto-startup=true
# 开启绑定器健康检查，让Spring感知绑定器状态
spring.cloud.stream.binding.health.enabled=true
spring.cloud.stream.binding.health.indicator.enabled=true

配合原有优雅停机配置，延长超时时间覆盖最长任务处理时长：

spring.lifecycle.timeout-per-shutdown-phase=30s
server.shutdown=graceful

2. 定时任务（@Scheduled）适配

Spring Boot 2.3+已支持定时任务的优雅停机，只需添加以下配置：

# 开启定时任务停机等待
spring.task.scheduling.shutdown.await-termination=true
# 等待超时时间
spring.task.scheduling.shutdown.await-termination-period=30s

注意：定时任务逻辑需保证可中断，否则Spring无法强制终止任务。

3. Web接口任务适配

server.shutdown=graceful会自动等待正在处理的Web请求完成，若使用异步接口（@Async），需添加异步任务的优雅停机配置：

spring.task.execution.shutdown.await-termination=true
spring.task.execution.shutdown.await-termination-period=30s

二、自定义通用实现（内置机制无法覆盖场景） #

如果内置配置无法满足精确跟踪任务状态的需求，可通过任务计数器实现全局任务监控：

1. 定义任务跟踪组件

创建全局计数器记录当前活跃任务数量：

@Component
public class TaskTracker {
    private final AtomicInteger activeTasks = new AtomicInteger(0);

    public void increment() {
        activeTasks.incrementAndGet();
    }

    public void decrement() {
        activeTasks.decrementAndGet();
    }

    public boolean hasActiveTasks() {
        return activeTasks.get() > 0;
    }

    // 等待任务完成，超时后强制退出
    public void waitForTasksCompletion(long timeoutMs) throws InterruptedException {
        long start = System.currentTimeMillis();
        while (hasActiveTasks() && (System.currentTimeMillis() - start) < timeoutMs) {
            Thread.sleep(100);
        }
    }
}

2. 在各类任务中注入计数器

• Spring Cloud Stream消息处理：修改Consumer方法，处理前后更新计数器

@Bean
public Consumer<String> readMessage(TaskTracker taskTracker, MessageService service) {
    return json -> {
        taskTracker.increment();
        try {
            long[] eventIds = new Gson().fromJson(json, long[].class);
            service.processMessage(eventIds);
        } catch (Exception ex) {
            throw new RuntimeException("Exception in processing message..." + ex.getMessage());
        } finally {
            taskTracker.decrement();
        }
    };
}

• 定时任务：在@Scheduled方法前后更新计数器

@Scheduled(fixedRate = 60000)
public void scheduledDbTask(TaskTracker taskTracker) {
    taskTracker.increment();
    try {
        // 执行数据库调用逻辑
    } finally {
        taskTracker.decrement();
    }
}

• Web接口：在Controller方法前后更新计数器（也可用AOP统一处理）

@RestController
public class TaskController {
    @Autowired
    private TaskTracker taskTracker;

    @PostMapping("/task")
    public ResponseEntity<Void> handleTask() {
        taskTracker.increment();
        try {
            // 处理接口任务逻辑
            return ResponseEntity.ok().build();
        } finally {
            taskTracker.decrement();
        }
    }
}

3. 自定义停机监听器

替换原有的固定sleep逻辑，使用计数器等待任务完成：

@Component
public class ShutdownListener {
    @Autowired
    private BindingsEndpoint bindingsEndpoint;
    @Autowired
    private TaskTracker taskTracker;

    @EventListener(ContextClosedEvent.class)
    public void onApplicationShutdown() throws InterruptedException {
        // 1. 停止接收新消息
        bindingsEndpoint.changeState("binding-name", State.STOPPED);
        // 2. 等待当前任务完成，超时时间与Spring配置一致
        taskTracker.waitForTasksCompletion(30000);
        // 3. 关闭应用上下文
        ThisApplication.ctx.close();
    }
}

4. Kubernetes PreStop钩子优化

将固定sleep改为轮询应用健康状态，直到无活跃任务再停机，避免资源浪费：

lifecycle:
  preStop:
    exec:
      command: ["sh", "-c", "while curl -s http://localhost:8080/actuator/health | grep -q 'UP'; do sleep 1; done"]

前提：开启Spring Boot Actuator健康检查，并自定义健康指标——当TaskTracker有活跃任务时健康状态为UP，无活跃任务时改为OUT_OF_SERVICE。

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