方法一
- Springboot提供的actuator的功能,它可以执行shutdown, health, info
<dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-actuator</artifactId> </dependency>
# 设置服务的端口号为3300 server.port=3300 management.endpoint.shutdown.enabled=true management.endpoints.web.exposure.include=shutdown
将
shutdown
节点打开,将/actuator/shutdown
暴露web访问也设置上除了shutdown之外还有health, info的web访问都打开的话将
配置
management.endpoints.web.exposure.include=*
即可。
- 关闭时执行销毁操作
import javax.annotation.PreDestroy; public class TerminateBean { // 关闭时执行销毁操作 @PreDestroy public void destroy() { System.out.println("TerminalBean is destroyed"); } }
- 自定义Config注册bean
import com.hqs.springboot.shutdowndemo.bean.TerminateBean; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; @Configuration public class ShutDownConfig { @Bean public TerminateBean getTerminateBean() { return new TerminateBean(); } }
在启动类里输出启动日志
curl -X POST http://localhost:3300/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
。
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; @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; } }
如何暴力停止呢,简单,直接
kill -9 相应的PID
即可。
真实工作中还需要考虑的点还很多,比如需要保护暴露的点不被别人利用,一般要加一些防火墙,或者只在内网使用,保证程序安全。
在真实的工作中的时候第三种比较常用,程序中一般使用内存队列
或线程池
的时候最好要优雅的关机,将内存队列没有处理的保存起来或线程池中没处理完的程序处理完。但是因为停机的时候比较快,所以停服务的时候最好不要处理大量的数据操作,这样会影响程序停止。