springboot项目在docker容器中如何优雅关闭

前言

什么是优雅关闭

在我看来所谓的优雅关闭，就是在系统关闭时，预留一些时间，让你有机会来善后一些事情

什么时候需要优雅关闭

是否所有项目都需要优雅关闭？那也不一定，毕竟所谓的优雅关闭，另一面就意味这关闭得慢，因此项目的优雅关闭得看项目的核心程度，换言之就是看该项目处理的数据是不是核心数据，其实项目的最终本质，是对数据的处理。

如何实现优雅关闭

通用的方法是通过进程接收到系统发送信号变量来实现，什么是信号变量，可以参考如下链接
https://www.cnblogs.com/liuhouhou/p/5400540.html

在springboot项目中如何配置优雅关闭

1、如果是springboot2.3版本之前可以通引入如下jar

<dependency>
    <groupId>com.github.timpeeters</groupId>
    <artifactId>spring-boot-graceful-shutdown</artifactId>
    <version>X.X.X</version>
</dependency>

通过引入这个jar，并且在项目的application.yml文件配置

graceful:
  shutdown:
    enabled: true

只需两步就可实现优雅关闭。当项目进行关闭时，观察日志，会发现有如下输出

spring-boot-graceful-shutdown目前支持的springboot版本如下

其实现流程

更多详细教程可以参考如下链接
https://github.com/timpeeters/spring-boot-graceful-shutdown

2、如果springboot是2.3版本之后，则可以直接在application.yml做如下配置即可

server:
  # 开启优雅关闭，默认：IMMEDIATE，立即关闭
  shutdown: graceful

spring:
  lifecycle:
    # 配置优雅关闭宽限时间，即项目在30s都没处理完，则进行强制关闭
    timeout-per-shutdown-phase: 30s

其关闭效果如下

2021-01-15 10:52:04.063  INFO 39004 --- [extShutdownHook] o.s.b.w.e.tomcat.GracefulShutdown        : Commencing graceful shutdown. Waiting for active requests to complete
2021-01-15 10:52:04.138  INFO 39004 --- [nfoReplicator-0] com.netflix.discovery.DiscoveryClient    : DiscoveryClient_HELLO-LOCAL/hello-local:172.17.45.115:8080 - registration status: 204
2021-01-15 10:52:04.605  INFO 39004 --- [tomcat-shutdown] o.s.b.w.e.tomcat.GracefulShutdown        : Graceful shutdown complete
c.netflix.discovery.TimedSupervisorTask  : task supervisor shutting down, can't accept the task

在docker容器中如何进行优雅关闭

如果在Dockerfile做如下配置

ENTRYPOINT [ "sh", "-c", "java $JAVA_OPTS -Djava.security.egd=file:/dev/./urandom -jar /app.jar" ]

是没法实现优雅关闭的效果。其原因是使用 docker stop 关闭容器时, 只有 init(pid 1)进程能收到中断信号, 如果容器的pid 1 进程是 sh 进程, 它不具备转发结束信号到它的子进程的能力, 所以我们真正的java程序得不到中断信号, 也就不能实现优雅关闭. 解决思路是: 让pid 1 进程具备转发终止信号, 或者将 java 程序配成 pid 1 进程.
因此只需对Dockerfile做如下改造就行

ENTRYPOINT [ "sh", "-c", "exec java $JAVA_OPTS -Djava.security.egd=file:/dev/./urandom -jar /app.jar" ]

其实就是在java前边加上exec即可。其实现机理可以参考如下链接
https://spring.io/guides/topicals/spring-boot-docker

在k8s中如何进行优雅关闭

1、配置preStop Hook钩子

preStop Hook 是一个发送到 Pod 中的容器特殊命令或 Http 请求。如果您的应用程序在接收 SIGTERM 时没有正常关闭，您可以使用 preStop Hook 来触发正常关闭。接收 SIGTERM 时大多数程序都会正常关闭，但如果您使用的是第三方代码或管理的系统无法控制，则 preStop Hook 是在不修改应用程序的情况下触发正常关闭的好方法。

2、适当延长terminationGracePeriodSeconds时间

terminationGracePeriodSeconds这玩意的意思直接看如下

其配置参考如下

apiVersion: apps/v1
kind: Deployment
metadata:
  namespace: dev
  name: hello
  labels:
    app: hello
spec:
  replicas: 3
  selector:
    matchLabels:
      app: hello
  template:
    metadata:
      labels:
        app: hello
    spec:
      imagePullSecrets:
      - name: default-secret
      containers:
      - name: hello
        image: {{images}}
        ports:
          - containerPort: 8080
        lifecycle:
          preStop:
            httpGet:
              port: 8080
              path: 你要关闭时执行的动作
      terminationGracePeriodSeconds: 60

总结

优雅关闭正常都是会配置一定的处理时间，超过该时间没处理完，就会进行强杀。因此对于核心业务，我们还得考虑万一进行强杀时，还要考虑是否需要对业务进行补偿操作