SpringCloud-服务优雅下线

一、服务版本

java 1.8
springcloud版本 Finchley.SR1
springboot版本 2.0.5.RELEASE

二、服务配置

1、新建java配置类GracefulShutdownTomcat

package com.xxx.config;
 
import org.apache.catalina.connector.Connector;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.boot.web.embedded.tomcat.TomcatConnectorCustomizer;
import org.springframework.context.ApplicationListener;
import org.springframework.context.event.ContextClosedEvent;
import org.springframework.stereotype.Component;
 
import java.util.concurrent.Executor;
import java.util.concurrent.ThreadPoolExecutor;
import java.util.concurrent.TimeUnit;
 
/**
 * 优雅关闭 Spring Boot tomcat
 */
@Component
public class GracefulShutdownTomcat implements TomcatConnectorCustomizer, ApplicationListener<ContextClosedEvent> {
    private final Logger log = LoggerFactory.getLogger(GracefulShutdownTomcat.class);
    private volatile Connector connector;
    private final int waitTime = 30;
 
    @Override
    public void customize(Connector connector) {
        this.connector = connector;
    }
 
    @Override
    public void onApplicationEvent(ContextClosedEvent contextClosedEvent) {
        this.connector.pause();
        Executor executor = this.connector.getProtocolHandler().getExecutor();
        if (executor instanceof ThreadPoolExecutor) {
            try {
                ThreadPoolExecutor threadPoolExecutor = (ThreadPoolExecutor) executor;
                threadPoolExecutor.shutdown();
                if (!threadPoolExecutor.awaitTermination(waitTime, TimeUnit.SECONDS)) {
                    log.warn("Tomcat thread pool did not shut down gracefully within " + waitTime + " seconds. Proceeding with forceful shutdown");
                }
            } catch (InterruptedException ex) {
                Thread.currentThread().interrupt();
            }
        }
    }
}

2、启动类中注入

@Autowired
private GracefulShutdownTomcat gracefulShutdownTomcat;
 
@Bean
public ServletWebServerFactory servletContainer() {
    TomcatServletWebServerFactory tomcat = new TomcatServletWebServerFactory();
    tomcat.addConnectorCustomizers(gracefulShutdownTomcat);
    return tomcat;
}

三、进程下线

运维脚本配置：使用kill / kill -15 命令结束进程

netstat -ntulp | grep 9090
kill -15 2485

四、原理分析

当发起kill命令后，当前服务流量摘除，服务在eureka控制台立即下线，服务接口不可访问，但是服务不停止，现有线程还能正常执行下去，直到线程结束，服务进程关闭。最长等待时间根据配置而定，如30s