优雅关闭Spring Boot应用

最新的Spring Boot添加了一个新特性 — 优雅停机。

官方介绍

官方文档地址：https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#boot-features-graceful-shutdown

这个机制会有一个超时时间，该超时时间提供一个宽限期，在此宽限期内，现有请求将被允许完成，而新请求将不被允许。 不允许新请求的确切方式因所使用的Web服务器而异。 Jetty，Reactor Netty和Tomcat将停止在网络层接受请求。 Undertow将接受请求，但会立即以服务不可用（503）响应进行响应。

本文使用的是Tomcat容器测试，Tomcat版本不低于9.0.33时这个机制才会生效。

按照官方文档的描述，这个特性用起来很简单，直接在application.properties中添加server.shutdown=graceful即可。还可以通过spring.lifecycle.timeout-per-shutdown-phase=30s来配置超时时间。
接下来我们创建一个Spring Boot项目，验证下这个优雅停机的效果。

代码测试

代码在github上： https://github.com/hanbin/learn-spring-boot/tree/main/graceful-shutdown

主要的代码就是提供一个简单的接口，每秒打印一行日志，打印20个。

/**
 * @author han_bin@outlook.com
 * @Description TODO
 */
@RestController
@Slf4j
public class TestController {

    @GetMapping("/test")
    public String test() throws InterruptedException {
        for(int index=0; index<20; index++){
            Thread.sleep(1000L);
            log.info("线程{}正在执行-{}", Thread.currentThread().getName(), index);
        }
        return "循环结束" + Thread.currentThread().getName();
    }
}

在查看效果之前，需要先了解在Idea中，使用Run模式启动项目，点击下图中的按钮等同于发送kill -15 xxx的命令。

1.在不开启优雅停机的时候查看效果。

可以看到，应用会直接中断当前正在运行的服务。

2.添加配置server.shutdown=graceful开启优雅停机查看结果。

可以看到，效果确实如官方所描述的一样，应用在等待服务执行完毕后才退出。且从Commencing graceful shutdown. Waiting for active requests to complete之后，客户端请求接口已经直接失败了，也就是说这个时候应用已经不接受客户端新的请求了。

3.添加配置

server.shutdown=graceful
spring.lifecycle.timeout-per-shutdown-phase=30s

开启优雅停机，查看结果。

可以看到，服务在运行结束后就退出了，并没有坚持等到30s才彻底关闭进程。

4.添加配置

server.shutdown=graceful
spring.lifecycle.timeout-per-shutdown-phase=3s

开启优雅停机，查看结果。

可以看到，当服务还在执行，但是已经到了配置的超时时间时，应用会尝试关闭，但是因为有服务还没处理完，所以关闭失败，接下来优雅停机就被中断进行强制停机了。

小结

之前的时候，我们为了实现微服务的优雅下线，有手动实现过类似的功能。不过官方有提供终归是好事情。开启这个功能很方便，但是这个超时时间的配置还是要根据具体业务来进行配置。以免造成服务长时间不能终止或者服务过早终止，导致后台业务没有处理完成。