Springboot 優雅停止服務的幾種方法
在使用Springboot的時候,都要涉及到服務的停止和啟動,當我們停止服務的時候,很多時候大家都是kill -9 直接把程式程序殺掉,這樣程式不會執行優雅的關閉。而且一些沒有執行完的程式就會直接退出。
我們很多時候都需要安全的將服務停止,也就是把沒有處理完的工作繼續處理完成。比如停止一些依賴的服務,輸出一些日誌,發一些訊號給其他的應用系統,這個在保證系統的高可用是非常有必要的。那麼咱麼就來看一下幾種停止springboot的方法。
第一種就是Springboot提供的actuator的功能,它可以執行shutdown, health, info等,預設情況下,actuator的shutdown是disable的,我們需要開啟它。首先引入acturator的maven依賴。
<dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-actuator</artifactId> </dependency>
然後將shutdown節點開啟,也將/actuator/shutdown暴露web訪問也設定上,除了shutdown之外還有health, info的web訪問都開啟的話將management.endpoints.web.exposure.include=*就可以。將如下配置設定到application.properties裡邊。設定一下服務的埠號為3333。
server.port=3333
management.endpoint.shutdown.enabled=true management.endpoints.web.exposure.include=shutdown
接下來,咱們建立一個springboot工程,然後設定一個bean物件,配置上PreDestroy方法。這樣在停止的時候會列印語句。bean的整個生命週期分為建立、初始化、銷燬,當最後關閉的時候會執行銷燬操作。在銷燬的方法中執行一條輸出日誌。
package com.hqs.springboot.shutdowndemo.bean; import javax.annotation.PreDestroy; /** * @author huangqingshi * @Date 2019-08-17 */ public class TerminateBean { @PreDestroy public void preDestroy() { System.out.println("TerminalBean is destroyed"); } }
做一個configuration,然後提供一個獲取bean的方法,這樣該bean物件會被初始化。
package com.hqs.springboot.shutdowndemo.config; import com.hqs.springboot.shutdowndemo.bean.TerminateBean; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; /** * @author huangqingshi * @Date 2019-08-17 */ @Configuration public class ShutDownConfig { @Bean public TerminateBean getTerminateBean() { return new TerminateBean(); } }
在啟動類裡邊輸出一個啟動日誌,當工程啟動的時候,會看到啟動的輸出,接下來咱們執行停止命令。
curl -X POST http://localhost:3333/actuator/shutdown
以下日誌可以輸出啟動時的日誌列印和停止時的日誌列印,同時程式已經停止。是不是比較神奇。
第二種方法也比較簡單,獲取程式啟動時候的context,然後關閉主程式啟動時的context。這樣程式在關閉的時候也會呼叫PreDestroy註解。如下方法在程式啟動十秒後進行關閉。
/* method 2: use ctx.close to shutdown all application context */ ConfigurableApplicationContext ctx = SpringApplication.run(ShutdowndemoApplication.class, args); try { TimeUnit.SECONDS.sleep(10); } catch (InterruptedException e) { e.printStackTrace(); } ctx.close();
第三種方法,在springboot啟動的時候將程序號寫入一個app.pid檔案,生成的路徑是可以指定的,可以通過命令 cat /Users/huangqingshi/app.id | xargs kill 命令直接停止服務,這個時候bean物件的PreDestroy方法也會呼叫的。這種方法大家使用的比較普遍。寫一個start.sh用於啟動springboot程式,然後寫一個停止程式將服務停止。
/* method 3 : generate a pid in a specified path, while use command to shutdown pid : 'cat /Users/huangqingshi/app.pid | xargs kill' */ SpringApplication application = new SpringApplication(ShutdowndemoApplication.class); application.addListeners(new ApplicationPidFileWriter("/Users/huangqingshi/app.pid")); application.run();
第四種方法,通過呼叫一個SpringApplication.exit()方法也可以退出程式,同時將生成一個退出碼,這個退出碼可以傳遞給所有的context。這個就是一個JVM的鉤子,通過呼叫這個方法的話會把所有PreDestroy的方法執行並停止,並且傳遞給具體的退出碼給所有Context。通過呼叫System.exit(exitCode)可以將這個錯誤碼也傳給JVM。程式執行完後最後會輸出:Process finished with exit code 0,給JVM一個SIGNAL。
/* method 4: exit this application using static method */ ConfigurableApplicationContext ctx = SpringApplication.run(ShutdowndemoApplication.class, args); exitApplication(ctx);
public static void exitApplication(ConfigurableApplicationContext context) { int exitCode = SpringApplication.exit(context, (ExitCodeGenerator) () -> 0); System.exit(exitCode); }
第五種方法,自己寫一個Controller,然後將自己寫好的Controller獲取到程式的context,然後呼叫自己配置的Controller方法退出程式。通過呼叫自己寫的/shutDownContext方法關閉程式:curl -X POST http://localhost:3333/shutDownContext。
package com.hqs.springboot.shutdowndemo.controller; import org.springframework.beans.BeansException; import org.springframework.context.ApplicationContext; import org.springframework.context.ApplicationContextAware; import org.springframework.context.ConfigurableApplicationContext; import org.springframework.web.bind.annotation.GetMapping; import org.springframework.web.bind.annotation.PostMapping; import org.springframework.web.bind.annotation.RestController; /** * @author huangqingshi * @Date 2019-08-17 */ @RestController public class ShutDownController implements ApplicationContextAware { private ApplicationContext context; @PostMapping("/shutDownContext") public String shutDownContext() { ConfigurableApplicationContext ctx = (ConfigurableApplicationContext) context; ctx.close(); return "context is shutdown"; } @GetMapping("/") public String getIndex() { return "OK"; } @Override public void setApplicationContext(ApplicationContext applicationContext) throws BeansException { context = applicationContext; } }
好了,springboot的優雅關閉方法也都實現好了,也有同學問,如何暴力停止呢,簡單,直接kill -9 相應的PID即可。
總結一下:
以上這幾種方法實現的話比較簡單,但是真實工作中還需要考慮的點還很多,比如需要保護暴露的點不被別人利用,一般要加一些防火牆,或者只在內網使用,保證程式安全。
在真實的工作中的時候第三種比較常用,程式中一般使用記憶體佇列或執行緒池的時候最好要優雅的關機,將記憶體佇列沒有處理的儲存起來或執行緒池中沒處理完的程式處理完。但是因為停機的時候比較快,所以停服務的時候最好不要處理大量的資料操作,這樣會影響程式停止。
好了,大家覺得還沒看全的話,可以訪問我的GIT程式碼:https://github.com/stonehqs/shutdowndemo.git 。