一文搞懂如何實現(xiàn)Java,Spring動態(tài)啟停定時任務
更新時間：2022年06月23日 10:53:16 作者：MrDong先生
定時任務的應用場景十分廣泛，如定時清理文件、定時生成報表、定時數(shù)據(jù)同步備份等。本文將教你實現(xiàn)Java、Spring動態(tài)啟停定時任務，感興趣的可以學習一下
為什么需要定時任務
定時任務的應用場景十分廣泛，如定時清理文件、定時生成報表、定時數(shù)據(jù)同步備份等。
Java定時任務的原理
jdk自帶的庫中，有兩種技術可以實現(xiàn)定時任務，一種是Timer,另一種是ScheduledThreadPoolExecutor
Timer+TimerTask
Timer是一個線程，控制執(zhí)行TimerTask所需要執(zhí)行的內容
public class Timer {
/**
* The timer task queue. This data structure is shared with the timer
* thread. The timer produces tasks, via its various schedule calls,
* and the timer thread consumes, executing timer tasks as appropriate,
* and removing them from the queue when they're obsolete.
*/
private final TaskQueue queue = new TaskQueue();
/**
* The timer thread.
*/
private final TimerThread thread = new TimerThread(queue);
。。。。。。
}
其中，需要注意，Timer類有幾個方法創(chuàng)建不同的線程執(zhí)行:
延時執(zhí)行
//其中的delay是延時時間，表示多少毫秒后執(zhí)行一次task
public void schedule(TimerTask task, long delay) {
if (delay < 0)
throw new IllegalArgumentException("Negative delay.");
sched(task, System.currentTimeMillis()+delay, 0);
}
指定時間點執(zhí)行
//到達指定時間time的時候執(zhí)行一次task
public void schedule(TimerTask task, Date time) {
sched(task, time.getTime(), 0);
}
延時周期執(zhí)行
//經過delay毫秒后按每period毫秒執(zhí)行一次的周期執(zhí)行task
public void schedule(TimerTask task, long delay, long period) {
if (delay < 0)
throw new IllegalArgumentException("Negative delay.");
if (period <= 0)
throw new IllegalArgumentException("Non-positive period.");
sched(task, System.currentTimeMillis()+delay, -period);
}
指定時間點后周期執(zhí)行
//到達指定時間firstTime之后按照每period毫秒執(zhí)行一次的周期執(zhí)行task
public void schedule(TimerTask task, Date firstTime, long period) {
if (period <= 0)
throw new IllegalArgumentException("Non-positive period.");
sched(task, firstTime.getTime(), -period);
}
TimerTask是一個實現(xiàn)了Runable接口的類，所以能夠放到線程去執(zhí)行:
public abstract class TimerTask implements Runnable {
/**
* This object is used to control access to the TimerTask internals.
*/
final Object lock = new Object();
。。。。。。
}
示例：
public class JavaTimerJob {
public static void main(String[] args) {
Timer timer = new Timer();
Task task = new Task();
//當前時間開始，每1秒執(zhí)行一次
timer.schedule(task, new Date(),1000);
}
}
class Task extends TimerTask {
@Override
public void run() {
System.out.println(new Date()+": This is my job...");
}
}
執(zhí)行結果：
Tue May 30 13:45:47 CST 2022: This is my job...
Tue May 30 13:45:48 CST 2022: This is my job...
Tue May 30 13:45:49 CST 2022: This is my job...
Tue May 30 13:45:50 CST 2022: This is my job...
。。。。
弊端：Timer是單線程的，一旦定時任務中某一過程時刻拋出異常，將會導致整體線程停止，定時任務停止。
ScheduledThreadPoolExecutor
繼承了ThreadPoolExecutor,,是一個基于線程池的調度器 通過實現(xiàn)ScheduledExecutorService接口方法去實現(xiàn)任務調度，主要方法如下:
延時執(zhí)行
//command是待執(zhí)行的線程，delay表示延時時長，unit代表時間單位
public ScheduledFuture<?> schedule(Runnable command,
long delay,
TimeUnit unit) {
if (command == null || unit == null)
throw new NullPointerException();
RunnableScheduledFuture<?> t = decorateTask(command,
new ScheduledFutureTask<Void>(command, null,
triggerTime(delay, unit)));
delayedExecute(t);
return t;
}
延時周期執(zhí)行
//command是待執(zhí)行的線程，initialDelay表示延時時長，period代表執(zhí)行間隔時長，unit代表時間單位
public ScheduledFuture<?> scheduleAtFixedRate(Runnable command,
long initialDelay,
long period,
TimeUnit unit) {
if (command == null || unit == null)
throw new NullPointerException();
if (period <= 0)
throw new IllegalArgumentException();
ScheduledFutureTask<Void> sft =
new ScheduledFutureTask<Void>(command,
null,
triggerTime(initialDelay, unit),
unit.toNanos(period));
RunnableScheduledFuture<Void> t = decorateTask(command, sft);
sft.outerTask = t;
delayedExecute(t);
return t;
}
每段延時間隔執(zhí)行
//command是待執(zhí)行的線程，initialDelay表示延時時長，delay代表每次執(zhí)行線程前的延時時長，unit代表時間單位
public ScheduledFuture<?> scheduleWithFixedDelay(Runnable command,
long initialDelay,
long delay,
TimeUnit unit) {
if (command == null || unit == null)
throw new NullPointerException();
if (delay <= 0)
throw new IllegalArgumentException();
ScheduledFutureTask<Void> sft =
new ScheduledFutureTask<Void>(command,
null,
triggerTime(initialDelay, unit),
unit.toNanos(-delay));
RunnableScheduledFuture<Void> t = decorateTask(command, sft);
sft.outerTask = t;
delayedExecute(t);
return t;
}
示例：
public class JavaScheduledThreadPoolExecutor {
public static void main(String[] args) {
ScheduledExecutorService scheduledExecutorService = Executors.newScheduledThreadPool(8);
//延時1秒后開始執(zhí)行，每3秒執(zhí)行一次
scheduledExecutorService.scheduleAtFixedRate(new Runnable() {
@Override
public void run() {
System.out.println(new Date()+": This is my job...");
}
}, 1, 3, TimeUnit.SECONDS);
}
}
執(zhí)行結果：
Tue May 30 15:05:16 CST 2022: This is my job...
Tue May 30 15:05:19 CST 2022: This is my job...
Tue May 30 15:05:22 CST 2022: This is my job...
Tue May 30 15:05:25 CST 2022: This is my job...
。。。。。
Timer VS ScheduledThreadPoolExecutor
Timer
- 是單線程，如果開啟多個線程服務，將會出現(xiàn)競爭，一旦出現(xiàn)異常，線程停止，定時任務停止；
- 兼容性更高，jdk1.3后使用
ScheduledThreadPoolExecutor
- 基于線程池實現(xiàn)多線程，且自動調整線程數(shù)，線程出錯并不會影響整體定時任務執(zhí)行。
- 在jdk1.5后可使用
Spring定時任務
Spring原生定時任務主要依靠@Scheduled注解實現(xiàn)：
@Target({ElementType.METHOD, ElementType.ANNOTATION_TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Repeatable(Schedules.class)
public @interface Scheduled {
String CRON_DISABLED = "-";
String cron() default ""; //類似于corn表達式，可以指定定時任務執(zhí)行的延遲及周期規(guī)則
String zone() default ""; //指明解析cron表達式的時區(qū)。
long fixedDelay() default -1; //在最后一次調用結束和下一次調用開始之間以固定周期（以毫秒為單位）執(zhí)行帶注解的方法。（要等待上次任務完成后）
String fixedDelayString() default ""; //同上面作用一樣，只是String類型
long fixedRate() default -1; //在調用之間以固定的周期（以毫秒為單位）執(zhí)行帶注解的方法。（不需要等待上次任務完成）
String fixedRateString() default ""; //同上面作用一樣，只是String類型
long initialDelay() default -1; //第一次執(zhí)行fixedRate()或fixedDelay()任務之前延遲的毫秒數(shù) 。
String initialDelayString() default ""; //同上面作用一樣，只是String類型
}
Spring靜態(tài)定時任務示例:
@Slf4j
@Component
public class TestJob {
//每40秒執(zhí)行一次
@Scheduled(cron = "0/40 * * * * ?")
public void logJob(){
if(log.isDebugEnabled()){
log.debug("現(xiàn)在是：{}",LocalDateTime.now());
}
}
}
執(zhí)行結果：
現(xiàn)在是：2022-05-30T16:03:40.006
現(xiàn)在是：2022-05-30T16:04
現(xiàn)在是：2022-05-30T16:04:40.003
@Scheduled定時任務原理（源碼）
①項目啟動掃描帶有注解@Scheduled的所有方法信息由ScheduledAnnotationBeanPostProcessor的postProcessAfterInitialization方法實現(xiàn)功能：
public Object postProcessAfterInitialization(Object bean, String beanName) {
if (bean instanceof AopInfrastructureBean || bean instanceof TaskScheduler ||
bean instanceof ScheduledExecutorService) {
// Ignore AOP infrastructure such as scoped proxies.
return bean;
}
Class<?> targetClass = AopProxyUtils.ultimateTargetClass(bean);
if (!this.nonAnnotatedClasses.contains(targetClass)) {
//獲取定時任務的方法
Map<Method, Set<Scheduled>> annotatedMethods = MethodIntrospector.selectMethods(targetClass,
(MethodIntrospector.MetadataLookup<Set<Scheduled>>) method -> {
Set<Scheduled> scheduledMethods = AnnotatedElementUtils.getMergedRepeatableAnnotations(
method, Scheduled.class, Schedules.class);
return (!scheduledMethods.isEmpty() ? scheduledMethods : null);
});
if (annotatedMethods.isEmpty()) {
this.nonAnnotatedClasses.add(targetClass);
if (logger.isTraceEnabled()) {
logger.trace("No @Scheduled annotations found on bean class: " + targetClass);
}
}
else {
// Non-empty set of methods
annotatedMethods.forEach((method, scheduledMethods) ->
//調用processScheduled方法將定時任務方法存放到任務隊列中
scheduledMethods.forEach(scheduled -> processScheduled(scheduled, method, bean)));
if (logger.isTraceEnabled()) {
logger.trace(annotatedMethods.size() + " @Scheduled methods processed on bean '" + beanName +
"': " + annotatedMethods);
}
}
}
return bean;
}
②調用processScheduled方法將定時任務方法存放到任務隊列中
protected void processScheduled(Scheduled scheduled, Method method, Object bean) {
try {
//創(chuàng)建任務線程
Runnable runnable = createRunnable(bean, method);
boolean processedSchedule = false;
String errorMessage =
"Exactly one of the 'cron', 'fixedDelay(String)', or 'fixedRate(String)' attributes is required";
Set<ScheduledTask> tasks = new LinkedHashSet<>(4);
//解析任務執(zhí)行初始延遲
long initialDelay = scheduled.initialDelay();
String initialDelayString = scheduled.initialDelayString();
if (StringUtils.hasText(initialDelayString)) {
Assert.isTrue(initialDelay < 0, "Specify 'initialDelay' or 'initialDelayString', not both");
if (this.embeddedValueResolver != null) {
initialDelayString = this.embeddedValueResolver.resolveStringValue(initialDelayString);
}
if (StringUtils.hasLength(initialDelayString)) {
try {
initialDelay = parseDelayAsLong(initialDelayString);
}
catch (RuntimeException ex) {
throw new IllegalArgumentException(
"Invalid initialDelayString value \"" + initialDelayString + "\" - cannot parse into long");
}
}
}
//解析cron表達式
String cron = scheduled.cron();
if (StringUtils.hasText(cron)) {
String zone = scheduled.zone();
if (this.embeddedValueResolver != null) {
cron = this.embeddedValueResolver.resolveStringValue(cron);
zone = this.embeddedValueResolver.resolveStringValue(zone);
}
if (StringUtils.hasLength(cron)) {
Assert.isTrue(initialDelay == -1, "'initialDelay' not supported for cron triggers");
processedSchedule = true;
if (!Scheduled.CRON_DISABLED.equals(cron)) {
TimeZone timeZone;
if (StringUtils.hasText(zone)) {
timeZone = StringUtils.parseTimeZoneString(zone);
}
else {
timeZone = TimeZone.getDefault();
}
tasks.add(this.registrar.scheduleCronTask(new CronTask(runnable, new CronTrigger(cron, timeZone))));
}
}
}
// At this point we don't need to differentiate between initial delay set or not anymore
if (initialDelay < 0) {
initialDelay = 0;
}
//解析fixedDelay參數(shù)
long fixedDelay = scheduled.fixedDelay();
if (fixedDelay >= 0) {
Assert.isTrue(!processedSchedule, errorMessage);
processedSchedule = true;
//存放任務到任務隊列中
tasks.add(this.registrar.scheduleFixedDelayTask(new FixedDelayTask(runnable, fixedDelay, initialDelay)));
}
String fixedDelayString = scheduled.fixedDelayString();
if (StringUtils.hasText(fixedDelayString)) {
if (this.embeddedValueResolver != null) {
fixedDelayString = this.embeddedValueResolver.resolveStringValue(fixedDelayString);
}
if (StringUtils.hasLength(fixedDelayString)) {
Assert.isTrue(!processedSchedule, errorMessage);
processedSchedule = true;
try {
fixedDelay = parseDelayAsLong(fixedDelayString);
}
catch (RuntimeException ex) {
throw new IllegalArgumentException(
"Invalid fixedDelayString value \"" + fixedDelayString + "\" - cannot parse into long");
}
tasks.add(this.registrar.scheduleFixedDelayTask(new FixedDelayTask(runnable, fixedDelay, initialDelay)));
}
}
//解析fixedRate參數(shù)
long fixedRate = scheduled.fixedRate();
if (fixedRate >= 0) {
Assert.isTrue(!processedSchedule, errorMessage);
processedSchedule = true;
tasks.add(this.registrar.scheduleFixedRateTask(new FixedRateTask(runnable, fixedRate, initialDelay)));
}
String fixedRateString = scheduled.fixedRateString();
if (StringUtils.hasText(fixedRateString)) {
if (this.embeddedValueResolver != null) {
fixedRateString = this.embeddedValueResolver.resolveStringValue(fixedRateString);
}
if (StringUtils.hasLength(fixedRateString)) {
Assert.isTrue(!processedSchedule, errorMessage);
processedSchedule = true;
try {
fixedRate = parseDelayAsLong(fixedRateString);
}
catch (RuntimeException ex) {
throw new IllegalArgumentException(
"Invalid fixedRateString value \"" + fixedRateString + "\" - cannot parse into long");
}
tasks.add(this.registrar.scheduleFixedRateTask(new FixedRateTask(runnable, fixedRate, initialDelay)));
}
}
// 斷言檢查
Assert.isTrue(processedSchedule, errorMessage);
//并發(fā)控制將任務隊列存入注冊任務列表
synchronized (this.scheduledTasks) {
Set<ScheduledTask> regTasks = this.scheduledTasks.computeIfAbsent(bean, key -> new LinkedHashSet<>(4));
regTasks.addAll(tasks);
}
}
catch (IllegalArgumentException ex) {
throw new IllegalStateException(
"Encountered invalid @Scheduled method '" + method.getName() + "': " + ex.getMessage());
}
}
③將任務解析并添加到任務隊列后，交由ScheduledTaskRegistrar類的scheduleTasks方法添加（注冊）定時任務到環(huán)境中:
protected void scheduleTasks() {
if (this.taskScheduler == null) {
//獲取ScheduledExecutorService對象，實際上都是使用ScheduledThreadPoolExecutor執(zhí)行定時任務調度
this.localExecutor = Executors.newSingleThreadScheduledExecutor();
this.taskScheduler = new ConcurrentTaskScheduler(this.localExecutor);
}
if (this.triggerTasks != null) {
for (TriggerTask task : this.triggerTasks) {
addScheduledTask(scheduleTriggerTask(task));
}
}
if (this.cronTasks != null) {
for (CronTask task : this.cronTasks) {
addScheduledTask(scheduleCronTask(task));
}
}
if (this.fixedRateTasks != null) {
for (IntervalTask task : this.fixedRateTasks) {
addScheduledTask(scheduleFixedRateTask(task));
}
}
if (this.fixedDelayTasks != null) {
for (IntervalTask task : this.fixedDelayTasks) {
addScheduledTask(scheduleFixedDelayTask(task));
}
}
}
private void addScheduledTask(@Nullable ScheduledTask task) {
if (task != null) {
this.scheduledTasks.add(task);
}
}
由上述源碼可以看出，Spring原生定時任務的大概步驟如下：
1.掃描帶@Scheduled注解的類和方法（ScheduledAnnotationBeanPostProcessor.postProcessAfterInitialization(........))
2.將定時任務解析完成后加入任務隊列（ScheduledAnnotationBeanPostProcessor.processScheduled(........))
3.將定時任務注冊到當前運行環(huán)境，等待執(zhí)行（ScheduledTaskRegistrar.scheduleTasks(.......)) 且@Scheduled的底層調度實現(xiàn)是ScheduledThreadPoolExecutor
以上就是一文搞懂如何實現(xiàn)Java,Spring動態(tài)啟停定時任務的詳細內容，更多關于Java Spring啟停定時任務的資料請關注腳本之家其它相關文章！
相關文章
jdk17+springboot使用webservice的踩坑實戰(zhàn)記錄
這篇文章主要給大家介紹了關于jdk17+springboot使用webservice踩坑的相關資料,網(wǎng)上很多教程是基于jdk8的,所以很多在17上面跑不起來,折騰兩天,直接給答案,需要的朋友可以參考下2024-01-01
這篇文章主要介紹了SpringCloud啟動失敗問題匯總，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教2023-03-03
這篇文章主要介紹了springboot自動配置原理解析，幫助大家更好的理解和學習使用springboot，感興趣的朋友可以了解下2021-04-04
這篇文章主要介紹了Idea中Springboot熱部署無效問題解決,文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值,需要的朋友可以參考下2019-11-11
因為工作需要計算采煤機工作面的中心點，如果套用數(shù)學的計算公式，用java去實現(xiàn)，太麻煩了。本文將利用java幾何計算的工具包，幾行代碼就能求出多變形的中心，簡直yyds!還不快跟隨小編一起學起來2022-10-10
這篇文章主要介紹了spring?boot集成loback日志配置的示例代碼,本文通過示例代碼給大家介紹的非常詳細,對大家的學習或工作具有一定的參考借鑒價值,需要的朋友參考下吧2024-01-01
Mybatis攔截器常常會被用來進行分頁處理。所以下面這篇文章主要給大家介紹了關于mybatis攔截器與分頁插件的相關資料，文中通過示例代碼介紹的非常詳細，對大家學習或者使用mybatis具有一定的參考學習價值，需要的朋友們下面來一起學習學習吧2019-04-04
關于spring?boot使用?jdbc+mysql?連接的問題
這篇文章主要介紹了spring?boot使用?jdbc+mysql?連接,在這里mysql?8.x版本驅動包，要使用?com.mysql.cj.jdbc.Driver作為驅動類，文中給大家詳細介紹，需要的朋友可以參考下2022-03-03
Java實現(xiàn)ftp上傳下載、刪除文件及在ftp服務器上傳文件夾的方法
這篇文章主要介紹了Java實現(xiàn)ftp上傳下載、刪除文件及在ftp服務器上傳文件夾的方法,需要的朋友可以參考下2015-11-11
Java數(shù)據(jù)類型Integer與int的區(qū)別詳細解析
這篇文章主要介紹了Java數(shù)據(jù)類型Integer與int的區(qū)別詳細解析,Ingeter是int的包裝類,int的初值為0,Ingeter的初值為null,int和integer(無論new否)比,都為true,因為會把Integer自動拆箱為int再去比,需要的朋友可以參考下2023-12-12