首先來介紹下什麼是優雅地停止，簡而言之，就是對應用程序傳送停止指令之後，能保證 正在執行的業務操作不受影響，可以繼續完成已有請求的處理，但是停止接受新請求 。

在 Spring Boot 2.3 中增加了新特性 優雅停止 ，目前 Spring Boot 內建的四個嵌入式 Web 伺服器（ Jetty、Reactor Netty、Tomcat 和 Undertow ）以及反應式和基於 Servlet 的 Web 應用程式都支援優雅停止。

下面，我們先用新版本嘗試下：

Spring Boot 2.3 優雅停止

首先建立一個 Spring Boot 的 Web 專案，版本選擇 2.3.0.RELEASE

然後需要在 application.yml 中新增一些配置來啟用優雅停止的功能：

# 開啟優雅停止 Web 容器，預設為 IMMEDIATE：立即停止
server:
 shutdown: graceful

# 最大等待時間
spring:
 lifecycle:
  timeout-per-shutdown-phase: 30s

其中，平滑關閉內建的 Web 容器（以 Tomcat 為例）的入口程式碼在 org.springframework.boot.web.embedded.tomcat

內嵌的 Tomcat 容器平滑關閉的配置已經完成了，那麼如何優雅關閉 Spring 容器了，就需要 Actuator 來實現 Spring 容器的關閉了。

然後加入 actuator 依賴，依賴如下所示：

 <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-actuator</artifactId>
    </dependency>

然後接著再新增一些配置來暴露 actuator 的 shutdown 介面：

# 暴露 shutdown 介面
management:
 endpoint:
  shutdown:
   enabled: true
 endpoints:
  web:
   exposure:
    include: shutdown

其中通過 Actuator 關閉 Spring 容器的入口程式碼在 org.springframework.boot.actuate.context 包下 ShutdownEndpoint 類中，主要的就是執行 doClose() 方法關閉並銷燬 applicationContext ，有興趣的可以自己去看下。

配置搞定後，然後在 controller 包下建立一個 WorkController 類，並有一個 work 方法，用來模擬複雜業務耗時處理流程，具體程式碼如下：

@RestController
public class WorkController {

  @GetMapping("/work")
  public String work() throws InterruptedException {
    // 模擬複雜業務耗時處理流程
    Thread.sleep(10 * 1000L);
    return "success";
  }
}

然後，我們啟動專案，先用 Postman 請求 http://localhost:8080/work 處理業務：

然後在這個時候，呼叫 http://localhost:8080/actuator/shutdown 就可以執行優雅地停止，返回結果如下：

{
  "message": "Shutting down,bye..."
}

如果在這個時候，發起新的請求 http://localhost:8080/work ，會沒有反應：

再回頭看第一個請求，返回了結果： success 。

其中有幾條服務日誌如下：

2020-05-20 23:05:15.163 INFO 102724 --- [ Thread-253] o.s.b.w.e.tomcat.GracefulShutdown : Commencing graceful shutdown. Waiting for active requests to complete
2020-05-20 23:05:15.287 INFO 102724 --- [tomcat-shutdown] o.s.b.w.e.tomcat.GracefulShutdown : Graceful shutdown complete
2020-05-20 23:05:15.295 INFO 102724 --- [ Thread-253] o.s.s.concurrent.ThreadPoolTaskExecutor : Shutting down ExecutorService 'applicationTaskExecutor'

從日誌中也可以看出來，當呼叫 shutdown 介面的時候，會先等待請求處理完畢後再優雅地停止。

到此為止，Spring Boot 2.3 的優雅關閉就講解完了，是不是很簡單呢？如果是在之前不支援優雅關閉的版本如何去做呢？

Spring Boot 舊版本優雅停止

在這裡介紹 GitHub 上 issue 裡 Spring Boot 開發者提供的一種方案：

選取的 Spring Boot 版本為 2.2.6.RELEASE ，首先要實現 TomcatConnectorCustomizer 介面，該介面是自定義 Connector 的回撥介面：

@FunctionalInterface
public interface TomcatConnectorCustomizer {

	void customize(Connector connector);
}

除了定製 Connector 的行為，還要實現 ApplicationListener<ContextClosedEvent> 介面，因為要監聽 Spring 容器的關閉事件，即當前的 ApplicationContext 執行 close() 方法，這樣我們就可以在請求處理完畢後進行 Tomcat 執行緒池的關閉，具體的實現程式碼如下：

 @Bean
  public GracefulShutdown gracefulShutdown() {
    return new GracefulShutdown();
  }

  private static 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 event) {
      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");
          }
        } catch (InterruptedException ex) {
          Thread.currentThread().interrupt();
        }
      }
    }
  }

有了定製的 Connector 回撥，還需要在啟動過程中新增到內嵌的 Tomcat 容器中，然後等待監聽到關閉指令時執行， addConnectorCustomizers 方法可以把定製的 Connector 行為新增到內嵌的 Tomcat 中，具體程式碼如下：

  @Bean
  public ConfigurableServletWebServerFactory tomcatCustomizer() {
    TomcatServletWebServerFactory factory = new TomcatServletWebServerFactory();
    factory.addConnectorCustomizers(gracefulShutdown());
    return factory;
  }

到此為止，內建的 Tomcat 容器平滑關閉的操作就完成了，Spring 容器優雅停止上面已經說過了，再次就不再贅述了。

通過測試，同樣可以達到上面那樣優雅停止的效果。

總結

本文主要講解了 Spring Boot 2.3 版本和舊版本的優雅停止，避免強制停止導致正在處理的業務邏輯會被中斷，進而導致產生業務異常的情形。

另外使用 Actuator 的同時要注意安全問題，比如可以通過引入 security 依賴，開啟安全限制並進行身份驗證，設定單獨的 Actuator 管理埠並配置只對內網開放等。

本文的完整程式碼在 https://github.com/wupeixuan/SpringBoot-Learn 的 graceful-shutdown 目錄下。

參考

https://github.com/spring-projects/spring-boot/issues/4657

https://github.com/wupeixuan/SpringBoot-Learn

到此這篇關於淺談如何優雅地停止Spring Boot應用的文章就介紹到這了,更多相關Spring Boot停止應用內容請搜尋我們以前的文章或繼續瀏覽下面的相關文章希望大家以後多多支援我們！