在開發和部署 Spring Boot 應用程序時，除了關注其啟動和運行，理解如何實現**優雅停機（Graceful Shutdown）**也同樣至關重要。優雅停機意味著在應用程序關閉時，能夠有序地釋放資源、完成正在進行的任務，并避免數據丟失或損壞。本文將深入探討 Spring Boot 中與優雅停機相關的機制，特別是 JVM 關閉鉤子以及如何自定義清理邏輯。
1. 什么是 Spring Boot 的關閉鉤子？
在 Spring Boot 應用程序的啟動過程中，你可能會注意到類似以下的代碼片段（通常在 SpringApplication.class 中）：
// ... existing code ...
if (this.properties.isRegisterShutdownHook()) {SpringApplication.shutdownHook.enableShutdownHookAddition();
}
// ... existing code ...
這段代碼的核心在于 this.properties.isRegisterShutdownHook()。它對應于 Spring Boot 配置中的 spring.main.register-shutdown-hook 屬性。
spring.main.register-shutdown-hook: 這個配置屬性（默認為true）決定了 Spring Boot 應用程序是否會在 JVM 啟動時注冊一個關閉鉤子（Shutdown Hook）。SpringApplication.shutdownHook.enableShutdownHookAddition(): 當spring.main.register-shutdown-hook為true時，此方法會被調用，它負責向 JVM 運行時環境注冊一個鉤子。當 JVM 接收到外部的關閉信號（如Ctrl+C、kill <pid>命令等，而非強制終止的kill -9）時，這個鉤子就會被激活。
簡而言之，注冊關閉鉤子的目的是讓 Spring Boot 有機會在 JVM 正常關閉前，執行一系列預定義的清理操作，從而確保應用程序的優雅停機。 這些操作可能包括關閉數據庫連接池、釋放文件句柄、停止后臺線程等。
2. 如何自定義關閉時的清理邏輯？
Spring Boot 提供了靈活的機制來允許開發者在應用程序關閉時執行自定義的清理邏輯。主要有兩種常用且推薦的方式：監聽 ContextClosedEvent 和使用 @PreDestroy 注解。
2.1 監聽 ContextClosedEvent
這是最推薦的方式，因為它與 Spring 應用程序上下文的生命周期事件緊密集成。當 Spring 應用程序上下文完成其所有 Bean 的銷毀并準備關閉時，會發布 ContextClosedEvent。
如何定義：
- 創建一個實現
org.springframework.context.ApplicationListener<ContextClosedEvent>接口的類。 - 在
onApplicationEvent方法中編寫你的全局清理邏輯。 - 使用
@Component注解將其注冊為 Spring Bean。
示例：
// src/main/java/com/dosun/demo01/listener/MyCleanupListener.java
package com.dosun.demo01.listener;import org.springframework.context.ApplicationListener;
import org.springframework.context.event.ContextClosedEvent;
import org.springframework.stereotype.Component;@Component
public class MyCleanupListener implements ApplicationListener<ContextClosedEvent> {@Overridepublic void onApplicationEvent(ContextClosedEvent event) {System.out.println("應用程序上下文已關閉。執行自定義清理邏輯...");// 在這里編寫你的自定義清理邏輯，例如：// 1. 關閉數據庫連接// 2. 釋放文件句柄// 3. 停止線程池// 4. 清理緩存等System.out.println("自定義清理邏輯執行完畢。");}
}
當應用程序正常關閉時，onApplicationEvent 方法會被調用，從而執行你在其中定義的清理代碼。
2.2 使用 @PreDestroy 注解
對于 Spring 容器管理的特定 Bean，你可以使用 @PreDestroy 注解來標記一個方法。這個方法會在該 Bean 被銷毀之前執行。這對于 Bean 級別的資源清理非常有用。
如何定義：
在任何 Spring 管理的 Bean 中，在你希望執行 Bean 特定清理邏輯的方法上添加 @PreDestroy 注解。
示例：
package com.dosun.demo01.service;import org.springframework.stereotype.Service;
import jakarta.annotation.PreDestroy;@Service
public class MyService {public MyService() {System.out.println("MyService Bean 已創建。");}@PreDestroypublic void cleanup() {System.out.println("MyService Bean 即將被銷毀。執行 Bean 級別的清理邏輯...");// 在這里編寫 MyService 特定的清理邏輯，例如關閉 MyService 內部的連接System.out.println("MyService Bean 級別的清理邏輯執行完畢。");}public void doSomething() {System.out.println("MyService 正在執行一些操作。");}
}
2.3 如何選擇？
ContextClosedEvent: 適用于需要在整個應用程序關閉時執行的全局清理任務。它在所有 Bean 都被銷毀之后，但在 JVM 真正退出之前執行。例如，全局的日志系統清理、一些共享資源的釋放等。@PreDestroy: 適用于特定 Bean 的清理任務。它在該 Bean 被銷毀之前執行。例如，某個 Bean 內部持有的數據庫連接、線程池、文件句柄等資源的釋放。
在大多數情況下，監聽 ContextClosedEvent 會是更靈活和通用的選擇，因為你可以在一個地方集中管理所有應用程序級別的關閉邏輯。
3. spring.main.register-shutdown-hook 為 false 的影響
現在我們來討論一個關鍵問題：如果 spring.main.register-shutdown-hook 被設置為 false，清理鉤子是不是就不生效了？
答案是：是的，在大多數情況下，自定義的清理鉤子將不會生效，或者說無法在應用程序接收到正常關閉信號時被優雅地觸發。
具體影響如下：
-
對于監聽
ContextClosedEvent的自定義清理邏輯：
如果spring.main.register-shutdown-hook為false，Spring Boot 將不會向 JVM 注冊關閉鉤子。這意味著當 JVM 收到Ctrl+C或kill <pid>等正常的關閉信號時，Spring Boot 應用程序將無法通過其內部的關閉鉤子機制來優雅地關閉 Spring 應用程序上下文。因此，你的MyCleanupListener中監聽ContextClosedEvent的onApplicationEvent方法將不會被觸發。 -
對于使用
@PreDestroy注解的方法：
@PreDestroy注解的方法是在 Spring Bean 被銷毀之前調用的，這是 Spring 容器生命周期的一部分。- 如果 Spring 應用程序上下文能夠被正常關閉（例如，你在代碼中手動調用了
SpringApplication.exit()或ApplicationContext.close()），那么即使spring.main.register-shutdown-hook為false，@PreDestroy方法仍然會被調用。 - 但是，在通常的場景下，如果
spring.main.register-shutdown-hook為false，并且你期望通過操作系統信號（如Ctrl+C）來關閉應用程序，那么 JVM 不會通知 Spring 執行其關閉邏輯。Spring 容器就無法執行其正常的銷毀流程，包括調用@PreDestroy方法。應用程序可能會突然終止，導致資源未釋放，數據不一致等問題。
- 如果 Spring 應用程序上下文能夠被正常關閉（例如，你在代碼中手動調用了
總結來說：
spring.main.register-shutdown-hook 配置是 Spring Boot 實現應用程序優雅停機的關鍵。
- 如果設置為
true（默認值且推薦）：Spring 會注冊 JVM 關閉鉤子，確保在應用程序因外部信號而關閉時，ContextClosedEvent監聽器和@PreDestroy方法都能得到執行，從而進行必要的清理。 - 如果設置為
false：Spring 將不會注冊這個 JVM 關閉鉤子。這意味著當應用程序收到Ctrl+C或kill等信號時，Spring 應用程序上下文將不會被優雅關閉。那些依賴 Spring 正常關閉流程的清理邏輯（包括ContextClosedEvent和通常情況下的@PreDestroy）將不會生效。這可能導致應用程序資源未釋放、數據不一致等問題。
因此，在大多數生產環境中，強烈建議將 spring.main.register-shutdown-hook 保持為 true，以確保應用程序能夠以健壯和可靠的方式關閉并清理資源。這將極大地提高應用程序的穩定性和數據完整性。
)
)
)
