首先来介绍下什么是优雅地停止,简而言之,就是对应用进程发送停止指令之后,能保证正在执行的业务操作不受影响,可以继续完成已有请求的处理,但是停止接受新请求。
在 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
,Spring Boot 2.3.0.RELEASE
版本内置的 Tomcat 为 9.0.35
。
然后需要在 application.yml
中添加一些配置来启用优雅停止的功能:
# 开启优雅停止 Web 容器,默认为 IMMEDIATE:立即停止 server: shutdown: graceful # 最大等待时间 spring: lifecycle: timeout-per-shutdown-phase: 30s
其中,平滑关闭内置的 Web 容器(以 Tomcat 为例)的入口代码在 org.springframework.boot.web.embedded.tomcat
的 GracefulShutdown
里,大概逻辑就是先停止外部的所有新请求,然后再处理关闭前收到的请求,有兴趣的可以自己去看下。
内嵌的 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