优雅关闭Spring Boot应用

18-07-27 banq
              

优雅关闭Spring Boot应用程序

发表于2018年6月27日

本指南介绍了正常关闭Spring Boot 应用程序的过程。许多开发人员和架构师总是讨论SpringBoot的应用设计、流量负载、框架和应用模式,但很少有人讨论关闭阶段。生命周期意识可以说一个真正资深程序员应该具有的素质,空间上的领地领域意识和时间上生命周期意识其实都是一种边界意识,只不过在时空上表现不同而已,对于重资源对象,包括线程池 连接池等都要有始有终,不能只顾创建,不顾关闭,其实在早期EJB2强迫程序实现对象几个生命周期如postcontruct 钝化和激活以及销毁等等,虽然重量了点,但是能培养这方面意识。

让我们考虑一下这个场景,有一个应用程序,其中有一个很长的阻塞过程,这个应用程序需要关闭以替换为更新的版本。如果不是杀死所有连接而是优雅等待其完成再优雅地关闭,不是更好吗?

这就是我们将在本指南中介绍的内容!

第一步是实现TomcatConnectorCustomizer。

public class GracefulShutdown implements TomcatConnectorCustomizer, ApplicationListener<ContextClosedEvent> {

    private static final Logger log = LoggerFactory.getLogger(GracefulShutdown.class);

    private static final int TIMEOUT = 30;

    private volatile Connector connector;

    @Override
    public void customize(Connector connector) {
        this.connector = connector;
    }

    @Override
    public void onApplicationEvent(ContextClosedEvent event) {
        this.connector.pause();
        Executor executor = this.connector.getProtocolHandler().getExecutor();
        if (executor instanceof ThreadPoolExecutor) {
            try {
                ThreadPoolExecutor threadPoolExecutor = (ThreadPoolExecutor) executor;
                threadPoolExecutor.shutdown();
                if (!threadPoolExecutor.awaitTermination(TIMEOUT, TimeUnit.SECONDS)) {
                    log.warn("Tomcat thread pool did not shut down gracefully within "
                            + TIMEOUT + " seconds. Proceeding with forceful shutdown");

                    threadPoolExecutor.shutdownNow();

                    if (!threadPoolExecutor.awaitTermination(TIMEOUT, TimeUnit.SECONDS)) {
                        log.error("Tomcat thread pool did not terminate");
                    }
                }
            } catch (InterruptedException ex) {
                Thread.currentThread().interrupt();
            }
        }
    }

}
<p>[/url]
在上面的实现中,ThreadPoolExecutor将等待30几秒钟才能进入关机状态,非常简单,对吧?有了这个,现在需要将这个bean注册到application context并注入它Tomcat。

为此,只需创建以下Spring @Bean。
<p>[code]
@Bean
public GracefulShutdown gracefulShutdown() {
    return new GracefulShutdown();
}

@Bean
public ConfigurableServletWebServerFactory webServerFactory(final GracefulShutdown gracefulShutdown) {
    TomcatServletWebServerFactory factory = new TomcatServletWebServerFactory();
    factory.addConnectorCustomizers(gracefulShutdown);
    return factory;
}
<p>

两个步骤全部完成了优雅关闭SpringBoot。

测试

为了测试这个实现,我刚刚创建了LongProcessController,里面的Thread.sleep有10几秒钟暂停等待。

@RestController
public class LongProcessController {

    @RequestMapping("/long-process")
    public String pause() throws InterruptedException {
        Thread.sleep(10000);
        return "Process finished";
    }

}
<p>

现在只需要运行你的spring启动应用程序,向/long-process端点发出请求,然后用杀死这个进程,看看情况是否符合预期?

首先,找到进程ID,在启动SpringBoot应用程序时,可以在日志中找到其进程ID,这里是6578。

2018-06-28 20:37:28.292  INFO 6578 --- [           main] o.s.b.w.embedded.tomcat.TomcatWebServer  : Tomcat started on port(s): 8080 (http) with context path ''
2018-06-28 20:37:28.296  INFO 6578 --- [           main] c.m.wd.gracefulshutdown.Application      : Started Application in 2.158 seconds (JVM running for 2.591)
<p>

然后,进行REST请求和关闭,对/long-process端点执行请求,可以curl调用:

$ curl -i localhost:8080/long-process

然后杀死这个运行的SpringBoot进程:

$ kill 6578

再次curl请求仍会响应如下:

HTTP/1.1 200

Content-Type: text/plain;charset=UTF-8

Content-Length: 14

Date: Thu, 28 Jun 2018 18:39:56 GMT

Process finished

恭喜!你刚学会了如何优雅地关闭Spring Boot应用程序。

Graceful Shutdown Spring Boot Applications