使用actuator优雅地停止SpringBoot应用
优雅如何定义?
简而言之,就是对应用进程发送停止指令之后,能够保证正在执行的业务操作不受影响,可以继续完成已有请求的处理,但是停止处理新来的请求。
在 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。
其中,优雅关闭内置Web容器的入口代码在
org.springframework.boot.web.embedded.tomcat 的 GracefulShutdown 里,大概逻辑就是先停止外部的所有新请求,然后再处理关闭前收到的请求,有兴趣的可以自己去看下。
内嵌的 Tomcat 容器平滑关闭的配置已经完成了,那么如何优雅关闭 Spring 容器了,就需要 Actuator 来实现 Spring 容器的关闭了。
然后加入 actuator 依赖,依赖如下所示:
1 2 3 4 |
|
然后接着再添加一些配置来暴露 actuator 的 shutdown 接口:
注意此处的坑,下面的配置中,一个是endpoint,一个是endpoints,多了个s,不一样的。
1 2 3 4 5 6 7 8 |
|
启动项目,此时访问http://localhost/actuator会显示支持的方法。
如果把上面配置中的shutdown换成*,会看到actuator支持的所有方法,如健康检查、统计、监控、审计等,这里不做介绍。
{
"_links": {
"self": {
"href": "http://localhost/actuator",
"templated": false
},
"shutdown": {
"href": "http://localhost/actuator/shutdown",
"templated": false
}
}
}
配置搞定后,然后创建一个DemoController控制器,并有一个 sayHi()方法,线程等待10s,用来模拟业务耗时处理,具体代码如下:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 |
|
启动项目,使用postman测试 ,会等待10s后显示请求成功,等待中......:
此时调用http://localhost/actuator/shutdown 就可以执行优雅地停止,返回结果如下:
{
"message": "Shutting down, bye..."
}
如果在这个时候,发起新的请求 http://localhost/sayHi,会没有反应,因为服务已经“停止”了:
再回头看第一个请求,返回了结果(10s后):success。
其中有几条服务日志如下:
2020-05-25 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-25 23:05:15.287 INFO 102724 --- [tomcat-shutdown] o.s.b.w.e.tomcat.GracefulShutdown : Graceful shutdown complete
2020-05-25 23:05:15.295 INFO 102724 --- [ Thread-253] o.s.s.concurrent.ThreadPoolTaskExecutor : Shutting down ExecutorService 'applicationTaskExecutor'
从日志中可以看出来,当调用 shutdown 接口的时候,会先等待请求处理完毕后再优雅地停止。
注意:
如果使用浏览器调用http://localhost/actuator/shutdown方法,会报405,要用POST请求。
原文链接: