springboot優雅關機的一點想法
阿新 • • 發佈:2019-01-11
boot版本1.5.8
一、原始方法:boot自帶的shutdown
引入
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-actuator</artifactId>
</dependency>
設定
# POST 方法 endpoints: shutdown: enabled: true #禁用密碼驗證 sensitive: false
使用post訪問/shutdown 可以關閉容器
二、進階版本
如果有執行緒池在使用以上的方式/shutdown會報錯,同時也會影響執行緒池中正在進行的任務
針對tomcat的解決辦法,建專案nykj-cloud-shutdown
boot版本1.5.8、主類TomcatGracefulShutdown,在容器關閉時通過waitTime,設定容器關閉等待時間
package com.nykj.cloud.shutdown; import lombok.Data; import lombok.extern.slf4j.Slf4j; import org.apache.catalina.connector.Connector; import org.springframework.boot.context.embedded.tomcat.TomcatConnectorCustomizer; import org.springframework.context.ApplicationListener; import org.springframework.context.event.ContextClosedEvent; import java.time.Duration; import java.time.LocalDateTime; import java.util.concurrent.Executor; import java.util.concurrent.ThreadPoolExecutor; import java.util.concurrent.TimeUnit; /** * @Auther: * @description: * @Date: 18:10 2018/3/6 */ @Slf4j @Data public class TomcatGracefulShutdown implements TomcatConnectorCustomizer, ApplicationListener<ContextClosedEvent> { private Integer waitTime; private volatile Connector connector; public TomcatGracefulShutdown(Integer waitTime) { this.waitTime = waitTime; } @Override public void customize(Connector connector) { this.connector = connector; } @Override public void onApplicationEvent(final ContextClosedEvent event) { LocalDateTime startShutdown = LocalDateTime.now(); LocalDateTime stopShutdown = LocalDateTime.now(); try { log.info("We are now in down mode, please wait " + waitTime + " second(s)..."); if (connector == null) { log.info("We are running unit test ... "); Thread.sleep(waitTime * 1000); return; } connector.pause(); final Executor executor = connector.getProtocolHandler().getExecutor(); if (executor instanceof ThreadPoolExecutor) { log.info("executor is ThreadPoolExecutor"); final ThreadPoolExecutor threadPoolExecutor = (ThreadPoolExecutor) executor; threadPoolExecutor.shutdown(); if (!threadPoolExecutor.awaitTermination(waitTime, TimeUnit.SECONDS)) { log.warn("Tomcat thread pool did not shut down gracefully within " + waitTime + " second(s). Proceeding with force shutdown"); } else { log.debug("Tomcat thread pool is empty, we stop now"); } } stopShutdown = LocalDateTime.now(); } catch (final InterruptedException ex) { log.error("The await termination has been interrupted : " + ex.getMessage()); Thread.currentThread().interrupt(); } finally { final long seconds = Duration.between(startShutdown, stopShutdown).getSeconds(); log.info("Shutdown performed in " + seconds + " second(s)"); } } }
將主類初始化到spring 容器,預設waittime是30秒
package com.nykj.cloud.shutdown; import lombok.extern.slf4j.Slf4j; import org.springframework.beans.factory.annotation.Value; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; /** * @Auther: * @description: * @Date: 11:47 2018/3/12 */ @Configuration @Slf4j public class TomcatGracefulShutdownAutoConfiguration { @Value("${nykj.tomcat.shutdown.waitTime:30}") private Integer waitTime; @Bean public TomcatGracefulShutdown tomcatGracefulShutdown() { TomcatGracefulShutdown tomcatGracefulShutdown = new TomcatGracefulShutdown(waitTime); log.info("------------register tomcat graceful shutdown ... " + waitTime); return tomcatGracefulShutdown; } }
設定spring.factories
org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
com.nykj.cloud.shutdown.TomcatGracefulShutdownAutoConfiguration
在微服務pom中引入,在服務中根據執行緒池執行時間設定關閉容器的等待時間 nykj.tomcat.shutdown.waitTime: 100
<dependency>
<groupId>com.nykj.cloudutils</groupId>
<artifactId>nykj-cloud-shutdown</artifactId>
<version>1.0.0-SNAPSHOT</version>
</dependency>
使用/shutdown呼叫,先從註冊中心下線,指定時間後關閉
三、其他版本
可以讓服務先下線,此時服務還是存活的,可以從容處理完執行緒內任務。
1、DiscoveryManager.getInstance().shutdownComponent() 此方法已過時。
2、也可以在/health藉口上做文章、eureka通過健康檢查介面來判斷服務是否健康,可以追加檢查項,讓服務處於down的狀態。
如果有其他更優雅的方式歡迎溝通評論。
可以考慮把下線和關閉應用作為兩個功能,整合到後臺管理平臺,或者分散式配置中心,或者容器管理工具