如何优雅的停止SpringBoot服务

在使用 SpringBoot 的时候 , 都要涉及到服务的停止和启动 , 当我们停止服务的时候 , 很多时候大家都是kill -9 直接把程序进程杀掉 , 这样程序不会执行优雅的关闭 。 而且一些没有执行完的程序就会直接退出 。
我们很多时候都需要安全的将服务停止 , 也就是把没有处理完的工作继续处理完成 。 比如停止一些依赖的服务 , 输出一些日志 , 发一些信号给其他的应用系统 , 这个在保证系统的高可用是非常有必要的 。 那么咱么就来看一下几种停止 SpringBoot 的方法 。
第一种就是 SpringBoot 提供的actuator的功能 , 它可以执行shutdown, health, info等 , 默认情况下 , actuator的shutdown是disable的 , 我们需要打开它 。 首先引入acturator的maven依赖 。
org.springframework.bootspring-boot-starter-actuator然后将shutdown节点打开 , 也将/actuator/shutdown暴露web访问也设置上 , 除了shutdown之外还有health, info的web访问都打开的话将management.endpoints.web.exposure.include=*就可以 。 将如下配置设置到application.properties里边 。 设置一下服务的端口号为3333 。 整编:微信公众号 , 搜云库技术团队 , ID:souyunku
server.port=3333management.endpoint.shutdown.enabled=truemanagement.endpoints.web.exposure.include=shutdown 接下来 , 咱们创建一个SpringBoot工程 , 然后设置一个bean对象 , 配置上PreDestroy方法 。 这样在停止的时候会打印语句 。 bean的整个生命周期分为创建、初始化、销毁 , 当最后关闭的时候会执行销毁操作 。 在销毁的方法中执行一条输出日志 。
package com.hqs.springboot.shutdowndemo.bean;import javax.annotation.PreDestroy;publicclassTerminateBean{ @PreDestroypublicvoid 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;@ConfigurationpublicclassShutDownConfig{@BeanpublicTerminateBean getTerminateBean() {returnnewTerminateBean();}}在启动类里边输出一个启动日志 , 当工程启动的时候 , 会看到启动的输出 , 接下来咱们执行停止命令 。
curl -X POST http://localhost:3333/actuator/shutdown以下日志可以输出启动时的日志打印和停止时的日志打印 , 同时程序已经停止 。 是不是比较神奇 。
如何优雅的停止SpringBoot服务文章插图
第二种方法也比较简单 , 获取程序启动时候的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 = newSpringApplication(ShutdowndemoApplication.class);application.addListeners(newApplicationPidFileWriter("/Users/huangqingshi/app.pid"));application.run();第四种方法 , 通过调用一个SpringApplication.exit()方法也可以退出程序 , 同时将生成一个退出码 , 这个退出码可以传递给所有的context 。 这个就是一个JVM的钩子 , 通过调用这个方法的话会把所有PreDestroy的方法执行并停止 , 并且传递给具体的退出码给所有Context 。 通过调用System.exit(exitCode)可以将这个错误码也传给JVM 。 程序执行完后最后会输出:Process finished with exit code 0 , 给JVM一个SIGNAL 。 整编:微信公众号 , 搜云库技术团队 , ID:souyunku
/* method 4: exit this application using static method */ConfigurableApplicationContext ctx = SpringApplication.run(ShutdowndemoApplication.class, args);exitApplication(ctx);publicstaticvoid exitApplication(ConfigurableApplicationContext context) {int exitCode = SpringApplication.exit(context, (ExitCodeGenerator) () -> 0);System.exit(exitCode);}