弹簧靴正常关机

java tomcat spring spring-boot

2022-09-03 13:28:07

我正在开发一个由嵌入式Tomcat支持的Spring Boot应用程序，我需要通过以下步骤开发一个优雅的关机：

停止处理新的 HTTP 请求（停止 Web 容器）
处理所有已接受的请求
关机弹簧应用语境

*按顺序执行上述步骤（逐个）

我怎样才能做到这一点？

附言 Spring Boot 1.5.20.RELEASE， Java 8

答案 1

Spring Boot 2.3（2020 年 5 月发布）中添加了正常关机支持。这允许在关闭上下文和关闭容器之前完成活动请求。

启用正常关机后，应用程序将在关机时按顺序执行以下步骤：

停止接受新请求
将等待一些可配置的时间来处理已接受的请求
停止容器
停止嵌入式服务器

来自发行说明：

所有四个嵌入式Web服务器（Jetty，Reactor Netty，Tomcat和Undertow）以及反应式和基于Servlet的Web应用程序都支持优雅关闭。如果使用启用，则在关机后，Web 服务器将不再允许新请求，并将等待一段宽限期以完成活动请求。可以使用配置宽限期。server.shutdown=gracefulspring.lifecycle.timeout-per-shutdown-phase

要启用正常关机，请添加到属性（默认情况下，它设置为）。server.shutdown=gracefulimmediate
可以使用属性（例如：）配置宽限期。spring.lifecycle.timeout-per-shutdown-phasespring.lifecycle.timeout-per-shutdown-phase=1m

对于 Spring Boot < 2.3，您将需要修改服务器的连接器以停止接受新请求，如本期春季 GitHub 问题中所述。

答案 2

我最终得到了：

import java.util.concurrent.Executor;
import java.util.concurrent.ThreadPoolExecutor;
import java.util.concurrent.TimeUnit;
import org.apache.catalina.connector.Connector;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.boot.context.embedded.tomcat.TomcatConnectorCustomizer;
import org.springframework.context.ApplicationListener;
import org.springframework.context.event.ContextClosedEvent;

public class GracefulShutdown implements TomcatConnectorCustomizer, ApplicationListener<ContextClosedEvent> {

  private static final Logger log = LoggerFactory.getLogger(GracefulShutdown.class);
  private volatile Connector connector;

  @Override
  public void customize(Connector connector) {
    this.connector = connector;
  }

  @Override
  public void onApplicationEvent(ContextClosedEvent contextClosedEvent) {
    log.info("Protocol handler is shutting down");

    this.connector.pause();
    Executor executor = this.connector.getProtocolHandler().getExecutor();
    if (executor instanceof ThreadPoolExecutor) {
      try {
        ThreadPoolExecutor threadPoolExecutor = (ThreadPoolExecutor) executor;
        threadPoolExecutor.shutdown();

        if (!threadPoolExecutor.awaitTermination(30, TimeUnit.SECONDS))
          log.warn("Tomcat thread pool did not shut down gracefully within 30 seconds. Proceeding with forceful shutdown");
        else
          log.info("Protocol handler shut down");

      } catch (InterruptedException e) {
        Thread.currentThread().interrupt();
      }
    }
  }
}

一些额外的豆子：

import org.springframework.boot.context.embedded.EmbeddedServletContainerFactory;
import org.springframework.boot.context.embedded.tomcat.TomcatEmbeddedServletContainerFactory;
...
  @Bean
  public GracefulShutdown gracefulShutdown() {
    return new GracefulShutdown();
  }

  @Bean
  public EmbeddedServletContainerFactory servletContainer(final GracefulShutdown gracefulShutdown) {
    TomcatEmbeddedServletContainerFactory factory = new TomcatEmbeddedServletContainerFactory();
    factory.addConnectorCustomizers(gracefulShutdown);
    return factory;
  }
...