SpringBoot优雅停止服务的几种方法

作者 | 黄青石

来源 | https://www.cnblogs.com/huangqingshi/p/11370291.html

最近突然想到了优雅停止 SpringBoot 服务问题&＃xff0c;在使用 SpringBoot 的时候&＃xff0c;都要涉及到服务的停止和启动&＃xff0c;当我们停止服务的时候&＃xff0c;很多时候大家都是kill -9 直接把程序进程杀掉&＃xff0c;这样程序不会执行优雅的关闭。而且一些没有执行完的程序就会直接退出。

我们很多时候都需要安全的将服务停止&＃xff0c;也就是把没有处理完的工作继续处理完成。比如停止一些依赖的服务&＃xff0c;输出一些日志&＃xff0c;发一些信号给其他的应用系统&＃xff0c;这个在保证系统的高可用是非常有必要的。那么咱么就来看一下几种停止 SpringBoot 的方法。

第一种

第一种就是Springboot提供的actuator的功能&＃xff0c;它可以执行shutdown, health, info等&＃xff0c;默认情况下&＃xff0c;actuator的shutdown是disable的&＃xff0c;我们需要打开它。首先引入acturator的maven依赖。

org.springframework.bootspring-boot-starter-actuator



然后将shutdown节点打开&＃xff0c;也将/actuator/shutdown暴露web访问也设置上&＃xff0c;除了shutdown之外还有health, info的web访问都打开的话将management.endpoints.web.exposure.include&＃61;*就可以。将如下配置设置到application.properties里边。设置一下服务的端口号为3333。

server.port&＃61;3333management.endpoint.shutdown.enabled&＃61;truemanagement.endpoints.web.exposure.include&＃61;shutdown


接下来&＃xff0c;咱们创建一个springboot工程&＃xff0c;然后设置一个bean对象&＃xff0c;配置上PreDestroy方法。这样在停止的时候会打印语句。bean的整个生命周期分为创建、初始化、销毁&＃xff0c;当最后关闭的时候会执行销毁操作。在销毁的方法中执行一条输出日志。

package com.hqs.springboot.shutdowndemo.bean;import javax.annotation.PreDestroy;/*** &＃64;author huangqingshi* &＃64;Date 2019-08-17*/
public class TerminateBean {&＃64;PreDestroypublic void preDestroy() {System.out.println("TerminalBean is destroyed");}}


做一个configuration&＃xff0c;然后提供一个获取bean的方法&＃xff0c;这样该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;/*** &＃64;author huangqingshi* &＃64;Date 2019-08-17*/
&＃64;Configuration
public class ShutDownConfig {&＃64;Beanpublic TerminateBean getTerminateBean() {return new TerminateBean();}}


在启动类里边输出一个启动日志&＃xff0c;当工程启动的时候&＃xff0c;会看到启动的输出&＃xff0c;接下来咱们执行停止命令。

curl -X POST http://localhost:3333/actuator/shutdown


以下日志可以输出启动时的日志打印和停止时的日志打印&＃xff0c;同时程序已经停止。是不是比较神奇。

4月程序员工资统计出炉&＃xff1a;平均14596元&＃xff0c;南京程序员收入挤进一线。

第二种

第二种方法也比较简单&＃xff0c;获取程序启动时候的context&＃xff0c;然后关闭主程序启动时的context。这样程序在关闭的时候也会调用PreDestroy注解。如下方法在程序启动十秒后进行关闭。

/* method 2: use ctx.close to shutdown all application context */ConfigurableApplicationContext ctx &＃61; SpringApplication.run(ShutdowndemoApplication.class, args);try {TimeUnit.SECONDS.sleep(10);} catch (InterruptedException e) {e.printStackTrace();}ctx.close();


第三种

第三种方法&＃xff0c;在springboot启动的时候将进程号写入一个app.pid文件&＃xff0c;生成的路径是可以指定的&＃xff0c;可以通过命令 cat /Users/huangqingshi/app.id | xargs kill 命令直接停止服务&＃xff0c;这个时候bean对象的PreDestroy方法也会调用的。这种方法大家使用的比较普遍。写一个start.sh用于启动springboot程序&＃xff0c;然后写一个停止程序将服务停止。

/* method 3 : generate a pid in a specified path, while use command to shutdown pid :&＃39;cat /Users/huangqingshi/app.pid | xargs kill&＃39; */SpringApplication application &＃61; new SpringApplication(ShutdowndemoApplication.class);application.addListeners(new ApplicationPidFileWriter("/Users/huangqingshi/app.pid"));application.run();


第四种

第四种方法&＃xff0c;通过调用一个SpringApplication.exit(&＃xff09;方法也可以退出程序&＃xff0c;同时将生成一个退出码&＃xff0c;这个退出码可以传递给所有的context。这个就是一个JVM的钩子&＃xff0c;通过调用这个方法的话会把所有PreDestroy的方法执行并停止&＃xff0c;并且传递给具体的退出码给所有Context。通过调用System.exit(exitCode)可以将这个错误码也传给JVM。程序执行完后最后会输出&＃xff1a;Process finished with exit code 0&＃xff0c;给JVM一个SIGNAL。

/* method 4: exit this application using static method */ConfigurableApplicationContext ctx &＃61; SpringApplication.run(ShutdowndemoApplication.class, args);exitApplication(ctx);
public static void exitApplication(ConfigurableApplicationContext context) {int exitCode &＃61; SpringApplication.exit(context, (ExitCodeGenerator) () -> 0);System.exit(exitCode);}


有没有搞错&＃xff1f;Java 对象不使用时&＃xff0c;要赋值为 null&＃xff1f;

第五种

第五种方法&＃xff0c;自己写一个Controller&＃xff0c;然后将自己写好的Controller获取到程序的context&＃xff0c;然后调用自己配置的Controller方法退出程序。通过调用自己写的/shutDownContext方法关闭程序&＃xff1a;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;/*** &＃64;author huangqingshi* &＃64;Date 2019-08-17*/
&＃64;RestController
public class ShutDownController implements ApplicationContextAware {private ApplicationContext context;&＃64;PostMapping("/shutDownContext")public String shutDownContext() {ConfigurableApplicationContext ctx &＃61; (ConfigurableApplicationContext) context;ctx.close();return "context is shutdown";}&＃64;GetMapping("/")public String getIndex() {return "OK";}&＃64;Overridepublic void setApplicationContext(ApplicationContext applicationContext) throws BeansException {context &＃61; applicationContext;}
}


好了&＃xff0c;springboot的优雅关闭方法也都实现好了&＃xff0c;也有同学问&＃xff0c;如何暴力停止呢&＃xff0c;简单&＃xff0c;直接kill -9 相应的PID即可。

总结一下

以上这几种方法实现的话比较简单&＃xff0c;但是真实工作中还需要考虑的点还很多&＃xff0c;比如需要保护暴露的点不被别人利用&＃xff0c;一般要加一些防火墙&＃xff0c;或者只在内网使用&＃xff0c;保证程序安全。

在真实的工作中的时候第三种比较常用&＃xff0c;程序中一般使用内存队列或线程池的时候最好要优雅的关机&＃xff0c;将内存队列没有处理的保存起来或线程池中没处理完的程序处理完。但是因为停机的时候比较快&＃xff0c;所以停服务的时候最好不要处理大量的数据操作&＃xff0c;这样会影响程序停止。

好了&＃xff0c;大家觉得还没看全的话&＃xff0c;可以访问我的GIT代码&＃xff1a;

https://github.com/stonehqs/shutdowndemo.git 。


往期推荐

4月程序员工资统计出炉&＃xff1a;平均14596元&＃xff0c;南京程序员收入挤进一线。

使用 IDEA 解决 Java8 的数据流问题&＃xff0c;极大提升生产力&＃xff01;&＃xff01;

牛逼哄哄的 BitMap&＃xff0c;到底牛逼在哪&＃xff1f;

当MyBatis 3.5.X遇上JDK8竟然出现了性能问题&＃xff0c;全项目组都得加班~

SQL 语句中 left join 后用 on 还是 where&＃xff0c;区别大了&＃xff01;

如果你喜欢本文&＃xff0c;欢迎关注我&＃xff0c;订阅更多精彩内容

关注我回复「加群」&＃xff0c;加入Spring技术交流群

免费领取&＃xff1a;字节跳动高阶算法大全

喜欢的这里报道

↘↘↘