Spring Boot 2.5 新特性之优雅停机

古城微笑少年丶 2022-10-06 00:33 221阅读 0赞

## 什么是优雅停机 ##

先来一段简单的代码，如下：

@RestController
    public class DemoController {
    	@GetMapping("/demo")
    	public String demo() throws InterruptedException {
    	    // 模拟业务耗时处理流程
    		Thread.sleep(20 * 1000L);
    		return "hello";
    	}
    }

当我们流量请求到此接口执行业务逻辑的时候，若服务端此时执行关机 （kill），spring boot 默认情况会直接关闭容器（tomcat 等），导致此业务逻辑执行失败。在一些业务场景下：会出现数据不一致的情况，事务逻辑不会回滚。

## graceful shutdown ##

![b00d3e3603e2da7d02506c8703bf5a1a.png][]

在最新的 spring boot 2.3 版本，内置此功能，不需要再自行扩展容器线程池来处理， 目前 spring boot 嵌入式支持的 web 服务器（Jetty、Reactor Netty、Tomcat 和 Undertow）以及反应式和基于 Servlet 的 web 应用程序都支持优雅停机功能。 我们来看下如何使用:

当使用`server.shutdown=graceful`启用时，在 web 容器关闭时，web 服务器将不再接收新请求，并将等待活动请求完成的缓冲期。

## 配置体验 ##

![ebc86d35a1bd8fe33f74bed414206ecf.png][]

此处支持的 shutdown 行为，我们看下 源码枚举如下：

/**
     * Configuration for shutting down a {@link WebServer}.
     *
     * @www.fhadmin.org
     * @since 2.3.0
     */
    public enum Shutdown {
    
    	/**
    	 * 优雅停机 （限期停机）
    	 *
    	 */
    	GRACEFUL,
    
    	/**
    	 * 立即停机
    	 */
    	IMMEDIATE;
    
    }

缓冲期 `timeout-per-shutdown-phase` 配置

*  默认时间为 30S, 意味着最大等待 30S，超时候无论线程任务是否执行完毕都会停机处理，一定要合理合理设置。

效果体验

*  1.  请求服务端接口  
        ![de4d23ae0b0144efc4215eff35698afb.png][]
 *  1.  执行关闭应用
        
        ![c39382cb1e72817f4f5d6a628b9b61ab.png][]
 *  1.  服务端接到关闭指令

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

*  1.  接口请求执行完成

## 相关知识 ##

> 1.  关于此处执行**kill -2** 而不是 **kill -9**

*  kill -2 相当于快捷键 Ctrl + C 会触发 Java 的 ShutdownHook 事件处理（优雅停机或者一些后置处理可参考以下源码）

//ApplicationContext
        //www.fhadmin.org
    	@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

> 1.  通过 actuate 端点实现优雅停机

POST 请求 **/actuator/shutdown** 即可执行优雅关机。

源码解析

@Endpoint(id = "shutdown", enableByDefault = false)
    public class ShutdownEndpoint implements ApplicationContextAware {
    
        //www.fhadmin.org
    	@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();
    	}
    }

> 1.  不同 web 容器优雅停机行为区别

**容器停机行为取决于具体的 web 容器行为**

<table> 
 <tbody> 
  <tr> 
   <th>web 容器名称</th> 
   <th>行为说明</th> 
  </tr> 
 </tbody> 
 <tbody> 
  <tr> 
   <td>tomcat 9.0.33+</td> 
   <td>停止接收请求，客户端新请求等待超时。</td> 
  </tr> 
  <tr> 
   <td>Reactor Netty</td> 
   <td>停止接收请求，客户端新请求等待超时。</td> 
  </tr> 
  <tr> 
   <td>Undertow</td> 
   <td>停止接收请求，客户端新请求直接返回 503。</td> 
  </tr> 
 </tbody> 
</table>

[b00d3e3603e2da7d02506c8703bf5a1a.png]: /images/20221005/07da605ae7da4affb4e041250f26e74a.png
[ebc86d35a1bd8fe33f74bed414206ecf.png]: /images/20221005/235e5479ef2449648726bb8bd69af318.png
[de4d23ae0b0144efc4215eff35698afb.png]: /images/20221005/b09f8ce51f544c1aa09496c432026d1a.png
[c39382cb1e72817f4f5d6a628b9b61ab.png]: /images/20221005/90d37de403d74085bb33ac26426562e7.png