浅谈springboot项目中定时任务如何优雅退出

在一个springboot项目中需要跑定时任务处理批数据时，突然有个Kill命令或者一个Ctrl+C的命令，此时我们需要当批数据处理完毕后才允许定时任务关闭，也就是当定时任务结束时才允许Kill命令生效。

启动类

启动类上我们获取到相应的上下文，捕捉相应命令。在这里插入代码片

@SpringBootApplication
/**指定mapper对应包的路径*/
@MapperScan("com.youlanw.kz.dao")
/**开启计划任务*/
@EnableScheduling
/**开启异常重试机制*/
@EnableRetry
public class YlkzTaskApplication {

  public static ConfigurableApplicationContext context;

  public static void main(String[] args) {
    context = SpringApplication.run(YlkzTaskApplication.class, args);
    /**
     * 捕捉命令实现优雅退出
     */
    MySignalHandler.install("TERM");  //捕捉kill命令
    MySignalHandler.install("INT");   //捕捉ctrl+c命令
  }
}

优雅退出配置类

通过install方法捕捉到相应的命令，

通过signalAction方法进行总开发的控制。

import org.slf4j.LoggerFactory;
import sun.misc.Signal;
import sun.misc.SignalHandler;
/**
 * @description: 定时任务控制类(实现优雅退出)
 * @method:
 * @author: mamengmeng
 * @date: 10:51 2018/8/13
 */
public class MySignalHandler implements SignalHandler {

  private final static org.slf4j.Logger logger = LoggerFactory.getLogger(MySignalHandler.class);

  private SignalHandler oldHandler;
  /**
   * 定时任务总开关-状态：true：打开 false：关闭
   */
  public static boolean base_flag = true;

  @Override
  public void handle(Signal signal) {
    signalAction(signal);
  }

  public static SignalHandler install(String signalName) {
    Signal diagSignal = new Signal(signalName);
    MySignalHandler instance = new MySignalHandler();
    instance.oldHandler = Signal.handle(diagSignal, instance);
    return instance;
  }

  public void signalAction(Signal signal) {
    try {
      //关闭总开关
      this.base_flag = false;
      logger.info("\n执行优雅退出操作\n等待运行中任务执行完毕…………");
      Thread.sleep(3000);
      StringBuffer stringBuffer = new StringBuffer("a");
      //此处为相关的业务代码，只要还有一个定时任务在执行，那么就等待线程任务执行完毕。
      while (BaseApplyTask.apply_flag || BaseResumeTask.resume_flag || CorpDemandTask.demand_flag || RecommendResumeTask.resume_flag || BaseCodeTask.code_flag || RecommendoneTask.resume_flag ||ResumeByZcbTask.zpbresume_flag) {
        //等待线程任务执行完毕
        stringBuffer.append("");
      }
      //获取到的上下文对象关闭相应的程序。
      YlkzTaskApplication.context.close();
      logger.info("\n================\n程序已安全退出！\n================");
      oldHandler.handle(signal);
    } catch (Exception e) {
      logger.error("handle|Signal handler" + "failed, reason "
          + e.getMessage());
      e.printStackTrace();
    }
  }
}

举例说明

我们在定时任务中添加一个总开关，当总开关是关着时是不允许定时任务执行的，

@Component
public class BaseCodeTask {
  private final static Logger logger = LoggerFactory.getLogger(BaseCodeTask.class);

  @Autowired
  private ResumeService resumeService;

  public static boolean code_flag = true;      //简历任务执行状态 true:执行中 false：执行完毕
  private static final Integer LIMIT = 500;
  private final static long time = 60 * 1000;    //一分钟
  /**
   * @param
   * @description: 同步简历信息(定时任务)
   * 任务执行间隔时间：6秒
   * 待同步数据为空，则5分钟后执行下一次
   * @method: sendResume
   * @author: zhengmingjie
   * @date: 16:17 2018/8/3
   * @return: void
   */
  @Scheduled(initialDelay = 1000, fixedDelay = time / 10)
  @Async
  public void sendResume() throws Exception {
    List<Resume> list = null;
    try {
      //总开关状态：true：打开 false：关闭
      if (!MySignalHandler.base_flag)
        return;
      this.code_flag = true;
      logger.info("\n======定时任务：初始化基本数据======\n开始执行\n");
      //以下是业务代码。相关的定时任务批处理
      resumeService.initializationMap();
      resumeService.setCodeDictionary();
      resumeService.setCityInfo();
      resumeService.setCodePostInfo();
      logger.info("\n======定时任务：初始化基本数据======\n结束\n");
    } catch (Exception e) {
      e.printStackTrace();
    } finally {
      this.code_flag = false;
    }
  }
}

定时任务优雅退出的使用可以有效的防止批处理任务的中断，小伙伴们可以尝试添加哦。。。。

补充知识：springboot自带定时器实现定时任务的开启关闭以及动态修改定时规则

最近项目中遇到了需要自动定时导出的需求，用户可以从页面修改导出的时间规则，可以启用和停用定时任务。

经过了解，项目中目前实现定时任务，一般有三种选择，一是用Java自带的timer类。稍微看了一下，可以实现大部分的指定频率的任务的调度（timer.schedule（）），也可以实现关闭和开启（timer.cancle）。但是用其来实现某天的某个时间或者某月的某一天调度任务有点不方便。

二是采用Quartz 调度器实现。这是一个功能很强大的开源的专门用于定时任务调度的框架，也很好的和springboot整合，缺点：配置复杂，需要花费一定的时间去了解和研究。（本人懒，因此没有选择这个，但是这个功能地区强大，有时间研究）

三是spring3.0以后自带的scheduletask任务调度，可以实现quartz的大部分功能，不需要额外引用jar，也不需要另外配置。而且支持注解和配置文件两种。

因此最后选择直接用spring自带的task 实现。

基本用法很简单，通过在方法上加注解@schedule（也可以通过xml文件配置的方式），注解里有 cron ，fixedDelay ，fixedRate ，initialDelay 等等参数，可以完成指定时间，平率执行此方法。这里不详细介绍。

直接介绍，通过页面动态修改cron参数，修改定时规则的思路。

1 实现接口SchedulingConfigurer，这个接口只有一个方法，配置定时任务。重写此方法，添加新的任务实现runable和新的触发 实现trigger 。

2 在新的触发里，把修改的cron写入新的触发

3 写UI 方法，接收前端修改的定时参数。

代码如下：

package com.fiberhome.ms.cus.cashform.ui;

import java.util.Date;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.scheduling.Trigger;
import org.springframework.scheduling.TriggerContext;
import org.springframework.scheduling.annotation.SchedulingConfigurer;
import org.springframework.scheduling.config.ScheduledTaskRegistrar;
import org.springframework.scheduling.support.CronTrigger;
import org.springframework.stereotype.Component;
@Component
public class DynamicScheduledTask implements SchedulingConfigurer {
@Autowired
private ScheduleExport scheduleExport;

// private static String DEFAULT_CRON = "0/10 * * * * ?";
private String cron = "";

public String getCron() {
return cron;
}

public void setCron(String cron) {
this.cron = cron;
}

@Override
public void configureTasks(ScheduledTaskRegistrar taskRegistrar) {
// TODO Auto-generated method stub
taskRegistrar.addTriggerTask(new Runnable() {

@Override
public void run() {
// TODO Auto-generated method stub
try {
scheduleExport.scheduleTaskExport();//异步定时生成文件
System.out.println("Msg:定时生成文件成功");
} catch (Exception e) {
// TODO: handle exception
e.printStackTrace();
System.out.println("Error:定时生成文件错误");
}
}
}, new Trigger() {
@Override
public Date nextExecutionTime(TriggerContext triggerContext) {
// TODO Auto-generated method stub
if ("".equals(cron)|| cron == null)
return null;
CronTrigger trigger = new CronTrigger(cron);// 定时任务触发，可修改定时任务的执行周期
Date nextExecDate = trigger.nextExecutionTime(triggerContext);
return nextExecDate;
}
});
System.out.println("can?");
}
}

这个方法可以实现 根据页面设置动态修改定时器的cron参数，不用重启服务。但是运行之后发现了一个缺陷，即必须在修改完之后，只有再一次到达定时任务的时间，才会调用新的触发时间， 这就导致，页面设置的时间并不能即时生效，这在项目中是不符合用户的要求，于是为了解决这个bug，换了另外一种解决方法。

思路：（了解ThreadPoolTaskScheduler这个类，TaskScheduler接口的默认实现类，多线程定时任务执行。可以设置执行线程池数（默认一个线程））

1、ThreadPoolTaskScheduler 实现TaskScheduler，可以通过方法 schedule(java.lang.Runnable task, Trigger trigger)，添加定时任务和触发器。返回java.util.concurrent.ScheduledFuture<?>，future可以控制任务的开关等。

2、前端修改定时参数，在set方法中修改ThreadPoolTaskScheduler 的触发器。

代码如下：

package com.fiberhome.ms.cus.cashform.ui.util;

import java.util.Date;
import java.util.concurrent.ScheduledFuture;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.scheduling.Trigger;
import org.springframework.scheduling.TriggerContext;
import org.springframework.scheduling.concurrent.ThreadPoolTaskScheduler;
import org.springframework.scheduling.support.CronTrigger;
import org.springframework.stereotype.Component;

import com.fiberhome.ms.cus.cashform.ui.ScheduleExport;

@Component
public class DynamicScheduleTaskSecond {
@Autowired
private ThreadPoolTaskScheduler threadPoolTaskScheduler;
@Autowired
private ScheduleExport scheduleExport;
private ScheduledFuture<?> future;

private String cron = "";

public String getCron() {
return cron;
}

public void setCron(String cron) {
this.cron = cron;
stopCron();
future = threadPoolTaskScheduler.schedule(new Runnable() {

@Override
public void run() {
// TODO Auto-generated method stub
try {
scheduleExport.scheduleTaskExport();// 异步定时生成文件
System.out.println("Msg:定时生成文件成功");
} catch (Exception e) {
// TODO: handle exception
e.printStackTrace();
System.out.println("Error:定时生成文件错误");
}
}
}, new Trigger() {
@Override
public Date nextExecutionTime(TriggerContext triggerContext) {
// TODO Auto-generated method stub
if ("".equals(cron) || cron == null)
return null;
CronTrigger trigger = new CronTrigger(cron);// 定时任务触发，可修改定时任务的执行周期
Date nextExecDate = trigger.nextExecutionTime(triggerContext);
return nextExecDate;
}
});
}

public void stopCron() {
if (future != null) {
future.cancel(true);//取消任务调度
}
}
}

验证可行，作个记录，如果有认为可以调整的地方，欢迎讨论！

以上这篇浅谈springboot项目中定时任务如何优雅退出就是小编分享给大家的全部内容了，希望能给大家一个参考，也希望大家多多支持服务器之家。

原文链接：https://blog.csdn.net/weixin_42395975/article/details/95946020