`

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 4exit 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

分享到:
评论

相关推荐

    详解Springboot 优雅停止服务的几种方法

    SpringBoot 优雅停止服务的多种方法 在使用 SpringBoot 时,我们经常需要停止服务,但是直接使用 kill -9 命令停止服务可能会导致一些问题,如未完成的任务中断、依赖服务的中断等。为了解决这些问题,我们需要使用...

    springboot优雅启动脚本

    将app.sh和springboot的jar文件放到同一个文件夹中,使用sh app.sh start启动程序,sh app.sh stop停止程序,sh app.sh restart重启程序

    关于spring boot中几种注入方法的一些个人看法

    Spring Boot 中的几种注入方法 在 Spring Boot 中,注入是一种非常重要的机制,用于将 bean 对象注入到其他 bean 对象中,以便实现松耦合和高内聚的设计目标。下面我们将对 Spring Boot 中的几种注入方法进行详细的...

    Springboot-服务-Windows 一键启动、停止脚本

    "Springboot-服务-Windows 一键启动、停止脚本"这个主题关注的是如何为Spring Boot应用程序创建自定义的批处理脚本来执行这些操作。批处理脚本是Windows操作系统中的文本文件,扩展名为`.bat`,它们包含了可执行的...

    springboot项目启动自动执行自定义方法

    springboot项目启动自动执行自定义方法springboot项目启动自动执行自定义方法springboot项目启动自动执行自定义方法

    SpringBoot 实战 之 优雅终止服务的方法

    SpringBoot 实战 之 优雅终止服务的方法 在 SpringBoot 中,优雅终止服务是一种非常重要的技术,尤其是在生产环境中。由于 SpringBoot 是一个微服务框架,它的生产部署方式需要尽可能简单,与常规的 Web 应用有着一...

    springboot注册bean的三种方法

    SpringBoot注册Bean的三种方法 SpringBoot是一个流行的Java框架,用于构建企业级应用程序。其中,注册Bean是SpringBoot的核心机制之一。今天,我们将探讨SpringBoot注册Bean的三种方法,分别是@ComponentScan、@...

    springboot分页查询的两种方法.md

    SpringBoot分页查询的两种写法,一种是手动实现,另一种是使用框架实现

    java+springboot医疗服务系统

    java+springboot医疗服务系统java+springboot医疗服务系统java+springboot医疗服务系统java+springboot医疗服务系统java+springboot医疗服务系统java+springboot医疗服务系统java+springboot医疗服务系统java+...

    springboot大学生就业服务平台

    springboot大学生就业服务平台springboot大学生就业服务平台springboot大学生就业服务平台springboot大学生就业服务平台springboot大学生就业服务平台springboot大学生就业服务平台springboot大学生就业服务平台...

    shell 管理SpringBoot 生产环境服务-转载

    6. 如何优雅地处理服务停止,包括清理资源、保存状态等。 7. 在生产环境中监控和日志管理的最佳实践。 8. 脚本中可能涉及的环境变量设置和配置文件加载。 通过学习这些内容,读者将能够创建自己的shell脚本来高效地...

    springboot监控服务器基本信息代码工具包

    使用方法: 1.添加工程依赖 &lt;!-- 获取系统信息 --&gt; &lt;groupId&gt;com.github.oshi&lt;/groupId&gt; &lt;artifactId&gt;oshi-core &lt;version&gt;5.8.2 2. 把工具放进去 3. 写一个接口返回获取的信息 @GetMapping("cc") public ...

    springboot集成netty实现代理服务器

    springboot集成netty实现代理服务器,实现http和https请求的代理功能

    springboot家政服务管理平台-论文

    springboot家政服务管理平台--论文springboot家政服务管理平台--论文springboot家政服务管理平台--论文springboot家政服务管理平台--论文springboot家政服务管理平台--论文springboot家政服务管理平台--论文...

    SpringBoot构建微服务

    SpringBoot快速构建微服务。java开发。

    centos系统springboot启动、重启、停止shell脚本

    centos系统springboot启动、重启、停止shell脚本,centos系统springboot启动、重启、停止shell脚本

    springboot项目使用服务部署到windows系统

    这是一个将spingboot项目打包的jar通过windows服务管理的项目 目录说明: config: 可放置外部yml等配置文件 firmware: 放置jar包,目前只支持一个jar包 jdk*: 放置jar依赖的java库 BatServices.exe: 64位程序,使用...

    SpringBoot结合Sigar获取服务器监控信息源代码

    SpringBoot结合Sigar获取服务器监控信息提供restful接口的源代码, 并使用swagger生成接口文档, 包括 CPU信息,服务器基本信息,内存信息, JVM信息,磁盘信息等. 有详细的代码注释.

    SpringBoot 使用Java Service Wrapper 部署Windows服务

    在本文中,我们将深入探讨如何使用Java Service Wrapper将SpringBoot应用部署为Windows服务。 首先,理解SpringBoot的核心特性是必要的。SpringBoot通过默认配置、内嵌Servlet容器(如Tomcat或Jetty)以及自动配置...

Global site tag (gtag.js) - Google Analytics