淺談springboot項目中定時任務如何優(yōu)雅退出
在一個springboot項目中需要跑定時任務處理批數(shù)據(jù)時，突然有個Kill命令或者一個Ctrl+C的命令，此時我們需要當批數(shù)據(jù)處理完畢后才允許定時任務關(guān)閉，也就是當定時任務結(jié)束時才允許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);
/**
* 捕捉命令實現(xiàn)優(yōu)雅退出
*/
MySignalHandler.install("TERM"); //捕捉kill命令
MySignalHandler.install("INT"); //捕捉ctrl+c命令
}
}
優(yōu)雅退出配置類
通過install方法捕捉到相應的命令，
通過signalAction方法進行總開發(fā)的控制。
import org.slf4j.LoggerFactory;
import sun.misc.Signal;
import sun.misc.SignalHandler;
/**
* @description: 定時任務控制類(實現(xiàn)優(yōu)雅退出)
* @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;
/**
* 定時任務總開關(guān)-狀態(tài)：true：打開 false：關(guān)閉
*/
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 {
//關(guān)閉總開關(guān)
this.base_flag = false;
logger.info("\n執(zhí)行優(yōu)雅退出操作\n等待運行中任務執(zhí)行完畢…………");
Thread.sleep(3000);
StringBuffer stringBuffer = new StringBuffer("a");
//此處為相關(guān)的業(yè)務代碼，只要還有一個定時任務在執(zhí)行，那么就等待線程任務執(zhí)行完畢。
while (BaseApplyTask.apply_flag || BaseResumeTask.resume_flag || CorpDemandTask.demand_flag || RecommendResumeTask.resume_flag || BaseCodeTask.code_flag || RecommendoneTask.resume_flag ||ResumeByZcbTask.zpbresume_flag) {
//等待線程任務執(zhí)行完畢
stringBuffer.append("");
}
//獲取到的上下文對象關(guān)閉相應的程序。
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();
}
}
}
舉例說明
我們在定時任務中添加一個總開關(guān)，當總開關(guān)是關(guān)著時是不允許定時任務執(zhí)行的，
@Component
public class BaseCodeTask {
private final static Logger logger = LoggerFactory.getLogger(BaseCodeTask.class);
@Autowired
private ResumeService resumeService;
public static boolean code_flag = true; //簡歷任務執(zhí)行狀態(tài) true:執(zhí)行中 false：執(zhí)行完畢
private static final Integer LIMIT = 500;
private final static long time = 60 * 1000; //一分鐘
/**
* @param
* @description: 同步簡歷信息(定時任務)
* 任務執(zhí)行間隔時間：6秒
* 待同步數(shù)據(jù)為空，則5分鐘后執(zhí)行下一次
* @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 {
//總開關(guān)狀態(tài)：true：打開 false：關(guān)閉
if (!MySignalHandler.base_flag)
return;
this.code_flag = true;
logger.info("\n======定時任務：初始化基本數(shù)據(jù)======\n開始執(zhí)行\(zhòng)n");
//以下是業(yè)務代碼。相關(guān)的定時任務批處理
resumeService.initializationMap();
resumeService.setCodeDictionary();
resumeService.setCityInfo();
resumeService.setCodePostInfo();
logger.info("\n======定時任務：初始化基本數(shù)據(jù)======\n結(jié)束\n");
} catch (Exception e) {
e.printStackTrace();
} finally {
this.code_flag = false;
}
}
}
定時任務優(yōu)雅退出的使用可以有效的防止批處理任務的中斷，小伙伴們可以嘗試添加哦。。。。
補充知識：springboot自帶定時器實現(xiàn)定時任務的開啟關(guān)閉以及動態(tài)修改定時規(guī)則
最近項目中遇到了需要自動定時導出的需求，用戶可以從頁面修改導出的時間規(guī)則，可以啟用和停用定時任務。
經(jīng)過了解，項目中目前實現(xiàn)定時任務，一般有三種選擇，一是用Java自帶的timer類。稍微看了一下，可以實現(xiàn)大部分的指定頻率的任務的調(diào)度（timer.schedule（）），也可以實現(xiàn)關(guān)閉和開啟（timer.cancle）。但是用其來實現(xiàn)某天的某個時間或者某月的某一天調(diào)度任務有點不方便。
二是采用Quartz 調(diào)度器實現(xiàn)。這是一個功能很強大的開源的專門用于定時任務調(diào)度的框架，也很好的和springboot整合，缺點：配置復雜，需要花費一定的時間去了解和研究。（本人懶，因此沒有選擇這個，但是這個功能地區(qū)強大，有時間研究）
三是spring3.0以后自帶的scheduletask任務調(diào)度，可以實現(xiàn)quartz的大部分功能，不需要額外引用jar，也不需要另外配置。而且支持注解和配置文件兩種。
因此最后選擇直接用spring自帶的task 實現(xiàn)。
基本用法很簡單，通過在方法上加注解@schedule（也可以通過xml文件配置的方式），注解里有 cron ，fixedDelay ，fixedRate ，initialDelay 等等參數(shù)，可以完成指定時間，平率執(zhí)行此方法。這里不詳細介紹。
直接介紹，通過頁面動態(tài)修改cron參數(shù)，修改定時規(guī)則的思路。
1 實現(xiàn)接口SchedulingConfigurer，這個接口只有一個方法，配置定時任務。重寫此方法，添加新的任務實現(xiàn)runable和新的觸發(fā) 實現(xiàn)trigger 。
2 在新的觸發(fā)里，把修改的cron寫入新的觸發(fā)
3 寫UI 方法，接收前端修改的定時參數(shù)。
代碼如下：
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);// 定時任務觸發(fā)，可修改定時任務的執(zhí)行周期
Date nextExecDate = trigger.nextExecutionTime(triggerContext);
return nextExecDate;
}
});
System.out.println("can?");
}
}
這個方法可以實現(xiàn) 根據(jù)頁面設置動態(tài)修改定時器的cron參數(shù)，不用重啟服務。但是運行之后發(fā)現(xiàn)了一個缺陷，即必須在修改完之后，只有再一次到達定時任務的時間，才會調(diào)用新的觸發(fā)時間， 這就導致，頁面設置的時間并不能即時生效，這在項目中是不符合用戶的要求，于是為了解決這個bug，換了另外一種解決方法。
思路：（了解ThreadPoolTaskScheduler這個類，TaskScheduler接口的默認實現(xiàn)類，多線程定時任務執(zhí)行?？梢栽O置執(zhí)行線程池數(shù)（默認一個線程））
1、ThreadPoolTaskScheduler 實現(xiàn)TaskScheduler，可以通過方法 schedule(java.lang.Runnable task, Trigger trigger)，添加定時任務和觸發(fā)器。返回java.util.concurrent.ScheduledFuture<?>，future可以控制任務的開關(guān)等。
2、前端修改定時參數(shù)，在set方法中修改ThreadPoolTaskScheduler 的觸發(fā)器。
代碼如下：
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);// 定時任務觸發(fā)，可修改定時任務的執(zhí)行周期
Date nextExecDate = trigger.nextExecutionTime(triggerContext);
return nextExecDate;
}
});
}
public void stopCron() {
if (future != null) {
future.cancel(true);//取消任務調(diào)度
}
}
}
驗證可行，作個記錄，如果有認為可以調(diào)整的地方，歡迎討論！
以上這篇淺談springboot項目中定時任務如何優(yōu)雅退出就是小編分享給大家的全部內(nèi)容了，希望能給大家一個參考，也希望大家多多支持腳本之家。
相關(guān)文章
使用@TransactionalEventListener監(jiān)聽事務教程
這篇文章主要介紹了使用@TransactionalEventListener監(jiān)聽事務教程，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教2021-09-09
SpringBoot集成單點登錄CAS的方法實現(xiàn)
本文主要介紹了SpringBoot集成單點登錄CAS的方法實現(xiàn),包括CAS的基本概念、集成步驟、具體代碼示例等,文中通過示例代碼介紹的非常詳細,需要的朋友們下面隨著小編來一起學習學習吧2024-03-03
Spring配置數(shù)據(jù)源的三種方式(小結(jié))
本文主要介紹了Spring配置數(shù)據(jù)源的三種方式，文中通過示例代碼介紹的非常詳細，具有一定的參考價值，感興趣的小伙伴們可以參考一下2022-01-01
本篇文章主要介紹了詳解springboot解決第三方依賴jar包的問題，解決了第三方依賴jar包的問題，具有一定的參考價值，感興趣的小伙伴們可以參考一下2017-09-09
在日常的開發(fā)中，我們難免會對日期格式化，對日期進行計算，對日期進行校驗，為了避免重復寫這些瑣碎的邏輯，我這里封裝了一個日期工具類，方便以后使用，直接復制代碼到項目中即可使用，需要的可以參考一下2022-10-10
Java response響應體和文件下載實現(xiàn)原理
這篇文章主要介紹了Java response響應體和文件下載實現(xiàn)原理,文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值,需要的朋友可以參考下2020-05-05
如何通過java將doc文件轉(zhuǎn)換為docx文件詳解
在數(shù)字化時代文檔處理成為了我們?nèi)粘９ぷ骱蛯W習中不可或缺的一部分,其中doc和docx作為兩種常見的文檔格式,各自具有不同的特點和優(yōu)勢,這篇文章主要給大家介紹了關(guān)于如何通過java將doc文件轉(zhuǎn)換為docx文件的相關(guān)資料,需要的朋友可以參考下2024-07-07
使用maven創(chuàng)建web項目的方法步驟(圖文)
本篇文章主要介紹了使用maven創(chuàng)建web項目的方法步驟，小編覺得挺不錯的，現(xiàn)在分享給大家，也給大家做個參考。一起跟隨小編過來看看吧2018-01-01
這篇文章主要介紹了Java中接口和抽象類的區(qū)別與相同之處,本文講解了抽象類的概念、接口的概念、接口和抽象類的區(qū)別與聯(lián)系等內(nèi)容,需要的朋友可以參考下2015-06-06
這篇文章主要為大家詳細介紹了Struts2實現(xiàn)文件上傳時顯示進度條功能，具有一定的參考價值，感興趣的小伙伴們可以參考一下2017-05-05