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 。