什么是優雅停機
先來一段簡單的代碼,如下:
@RestController
public class DemoController {
@GetMapping("/demo")
public String demo() throws InterruptedException {
// 模擬業務耗時處理流程
Thread.sleep(20 * 1000L);
return "hello";
}
}
當我們流量請求到此接口執行業務邏輯的時候,若服務端此時執行關機 (kill),spring boot 默認情況會直接關閉容器(tomcat 等),導致此業務邏輯執行失敗。在一些業務場景下:會出現數據不一致的情況,事務邏輯不會回滾。
graceful shutdown
在最新的 spring boot 2.3 版本,內置此功能,不需要再自行擴展容器線程池來處理,
目前 spring boot 嵌入式支持的 web 服務器(Jetty、Reactor Netty、Tomcat 和 Undertow)以及反應式和基於 Servlet 的 web 應用程序都支持優雅停機功能。 我們來看下如何使用:
當使用server.shutdown=graceful
啟用時,在 web 容器關閉時,web 服務器將不再接收新請求,並將等待活動請求完成的緩沖期。
配置體驗
此處支持的 shutdown 行為,我們看下 源碼枚舉如下:
/**
* Configuration for shutting down a {@link WebServer}.
*
* @author Andy Wilkinson
* @since 2.3.0
*/
public enum Shutdown {
/**
* 優雅停機 (限期停機)
*
*/
GRACEFUL,
/**
* 立即停機
*/
IMMEDIATE;
}
緩沖期 timeout-per-shutdown-phase
配置
- 默認時間為 30S, 意味着最大等待 30S,超時候無論線程任務是否執行完畢都會停機處理,一定要合理合理設置。
效果體驗
-
- 請求服務端接口
- 請求服務端接口
-
- 執行關閉應用
- 執行關閉應用
-
- 服務端接到關閉指令
2020-05-17 18:28:28.940 INFO 60341 --- [extShutdownHook] o.s.b.w.e.tomcat.GracefulShutdown : Commencing graceful shutdown. Waiting for active requests to complete
2020-05-17 18:28:45.923 INFO 60341 --- [tomcat-shutdown] o.s.b.w.e.tomcat.GracefulShutdown : Graceful shutdown complete
-
- 接口請求執行完成
相關知識
- 關於此處執行kill -2 而不是 kill -9
- kill -2 相當於快捷鍵 Ctrl + C 會觸發 Java 的 ShutdownHook 事件處理(優雅停機或者一些后置處理可參考以下源碼)
//ApplicationContext
@Override
public void registerShutdownHook() {
if (this.shutdownHook == null) {
// No shutdown hook registered yet.
this.shutdownHook = new Thread(SHUTDOWN_HOOK_THREAD_NAME) {
@Override
public void run() {
synchronized (startupShutdownMonitor) {
doClose();
}
}
};
Runtime.getRuntime().addShutdownHook(this.shutdownHook);
}
}
- kill -9,暴力美學強制殺死進程,不會執行 ShutdownHook
- 通過 actuate 端點實現優雅停機
POST 請求 /actuator/shutdown 即可執行優雅關機。
源碼解析
@Endpoint(id = "shutdown", enableByDefault = false)
public class ShutdownEndpoint implements ApplicationContextAware {
@WriteOperation
public Map<String, String> shutdown() {
Thread thread = new Thread(this::performShutdown);
thread.setContextClassLoader(getClass().getClassLoader());
thread.start();
}
private void performShutdown() {
try {
Thread.sleep(500L);
}
catch (InterruptedException ex) {
Thread.currentThread().interrupt();
}
// 此處close 邏輯和上邊 shutdownhook 的處理一樣
this.context.close();
}
}
- 不同 web 容器優雅停機行為區別
容器停機行為取決於具體的 web 容器行為
web 容器名稱 | 行為說明 |
---|---|
tomcat 9.0.33+ | 停止接收請求,客戶端新請求等待超時。 |
Reactor Netty | 停止接收請求,客戶端新請求等待超時。 |
Undertow | 停止接收請求,客戶端新請求直接返回 503。 |