如何开启优雅下线

形态一：SpringBoot业务应用（推荐）

如果业务应用采用了SpringBoot方式集成XXL-Job的执行器，那么可自动完成相应的优雅下线能力初始化集成。只需完成如下两个步骤即可：

1. 添加SchedulerX插件pom依赖。版本详情，请参见XXL-JOB插件版本。

   <dependency>
     <groupId>com.aliyun.schedulerx</groupId>
     <artifactId>schedulerx3-plugin-xxljob</artifactId>
     <version>最新版本</version>
   </dependency>

2. 添加应用配置参数，开启优雅下线。详细参数说明，请参见配置参数说明。

   # 参数说明参考上一章节
   xxl.job.executor.shutdownMode=WAIT_ALL

形态二：Spring业务应用

如果业务应用是通过Spring框架启动的Web应用，除了添加POM依赖和应用启动参数（参考形态一：SpringBoot业务应用（推荐）），还需通过初始化配置XxlJobExecutorEnhancerInitializer，在web.xml中添加如下配置：

<web-app>
  <context-param>
        <!-- Spring ApplicationContextInitializer 增强xxljob executor功能 -->
        <param-name>globalInitializerClasses</param-name>
        <param-value>com.aliyun.schedulerx.xxljob.enhance.XxlJobExecutorEnhancerInitializer</param-value>
    </context-param>
</web-app>

形态三：Frameless Java业务应用

如果业务应用采用xxl-job executor案例中的Frameless方式，通过纯Java编码方式启动业务应用时，可通过自定义编码完成优雅下线功能初始化集成。首先业务应用还是需要添加POM依赖和应用启动参数（参考形态一：SpringBoot业务应用（推荐）），相关参考案例如下：

• Executor启动前，添加：EnhancerLoader.load(xxlJobProp)，完成功能增加加载。

• Executor启动前，添加：Runtime.getRuntime().addShutdownHook(...)，为当前应用添加下线Hook实现。

public static void main(String[] args) {
    try {
        // load executor prop
        Properties xxlJobProp = FrameLessXxlJobConfig.loadProperties("xxl-job-executor.properties");

        // 初始化增加xxl-job executor加载
        EnhancerLoader.load(xxlJobProp);

        // start xxl-job executor
        FrameLessXxlJobConfig.getInstance().initXxlJobExecutor(xxlJobProp);

        // 添加系统优雅线下hook
        Runtime.getRuntime().addShutdownHook(new Thread(){
            @Override
            public void run() {
                FrameLessXxlJobConfig.getInstance().destroyXxlJobExecutor();
            }
        });
        // Blocks until interrupted
        while (true) {
            try {
                TimeUnit.HOURS.sleep(1);
            } catch (InterruptedException e) {
                break;
            }
        }
    } catch (Exception e) {
        logger.error(e.getMessage(), e);
    } finally {
        // destroy
        FrameLessXxlJobConfig.getInstance().destroyXxlJobExecutor();
    }
}

自建部署，通过kill -15停机

在自建CD流程中通常会有一个应用进程停止的节点，该节点可通过构建一个stop.sh 脚本用于应用进程停止退出。脚本内容需包含应用优雅下线的相关逻辑处理，参考如下停机脚本。

# 应用启用成功后进程ID信息会写入app.pid文件
PID="{应用部署路径}/app.pid"
FORCE=1
if [ -f ${PID} ]; then
  TARGET_PID=`cat ${PID}`
  kill -15 ${TARGET_PID}
  loop=1
  while(( $loop<=5 ))
  do
    ## health 检查当前应用进程确实已经结束，可根据应用特征自定义
    health
    if [ $? == 0 ]; then
      echo "check $loop times, current app has not stop yet."
      sleep 5s
      let "loop++"
    else
      FORCE=0
      break
    fi
  done
  if [ $FORCE -eq 1 ]; then
  	echo "App(pid:${TARGET_PID}) stop timeout, forced termination."
    kill -9 ${TARGET_PID}
  if
  rm -rf ${PID}
  echo "App(pid:${TARGET_PID}) stopped successful."
fi

K8S容器化部署，通过PreStop停机

利用k8s pod的生命周期管理可默认实现优雅下线。同时还可以使用preStop hook，通过exec执行脚本和HTTP请求方式来实现优雅下线逻辑处理。

• 默认无效修改：如果业务应用进程为容器中的主进程PID 1，则默认会先给主进程发送SIGTERM信号进行优雅下线。

• 自定义preStop：如容器内为复杂的多进程关系，可通过配置preStop脚本，自定义通过kill -15 PID停止应用进程，或者调用提前预设的stop.sh脚本实现应用进程退出。

apiVersion: apps/v1
kind: Deployment
metadata:
  name: my-app
spec:
  replicas: 3
  selector:
    matchLabels:
      app: my-app
  template:
    metadata:
      labels:
        app: my-app
    spec:
      containers:
      - name: my-app-container
        image: my-app-image:latest
        lifecycle:
          preStop:
            exec:
              # command: ["/bin/sh", "-c", "kill -15 PID && sleep 30"]
              command: ["/bin/sh", "-c", "脚本路径/stop.sh"]

阿里云上应用发布平台自动集成

敬请期待。