淺談在springboot中使用定時任務的方式
更新時間：2021年06月29日 14:38:32 作者：拍打醒
今天給大家?guī)淼氖顷P于Java的相關知識,文章圍繞著在springboot中使用定時任務的方式展開,文中有非常詳細的介紹及代碼示例,需要的朋友可以參考下
springboot定時任務
在springboot環(huán)境下有多種方法，這里記錄下使用過的其中兩種；1、使用注解，2、通過實現(xiàn)接口的方式。
使用注解的方式雖然比較簡單，但是如果項目需要用戶對定時周期進行修改操作，只使用注解就比較難實現(xiàn)。所以可以使用實現(xiàn)接口的方式。通過對接口的實現(xiàn)，可以在項目運行時根據需要修改任務執(zhí)行周期，只需要關閉原任務再開啟新任務即可。
1、使用注解方式
首先需要在啟動類下添加 @EnableScheduling 注解（@EnableAsync是開啟異步的注解）
package com.fongtech.cli;
import org.mybatis.spring.annotation.MapperScan;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.scheduling.annotation.EnableAsync;
import org.springframework.scheduling.annotation.EnableScheduling;
@SpringBootApplication
@MapperScan("com.fongtech.cli.mbg.*.**")
@EnableAsync
@EnableScheduling
public class SpringbootAdminApplication {
public static void main(String[] args) {
SpringApplication.run(SpringbootAdminApplication.class, args);
}
}
接著在需要用到定時任務的類和方法下加 @Component 和 @Scheduled(cron = "0 0/1 * * * ? ")注解，其中@Scheduled()中的 ‘cron' 有固定的格式。（@Async注解表示開啟異步）
@Slf4j
@Component
public class AsyncTaskConfiguration {
/**
* 每分鐘檢查任務列表，判斷任務類型執(zhí)行相應的任務
* 根據實際任務執(zhí)行情況，限定執(zhí)行任務數量
*/
@Scheduled(cron = "0 0/1 * * * ? ")
@Async
public void startCommonTask() throws Exception {
log.info("startCommonTask start........." + Thread.currentThread().getName());
commonTaskService.startCommonTask();
log.info("startCommonTask end........." + Thread.currentThread().getName());
}}
2、使用實現(xiàn)接口的方式
通過實現(xiàn) SchedulingConfigurer 接口，可對定時任務進行操作。實現(xiàn)接口的方式相比使用注解更加靈活，但需要編寫代碼，相對繁瑣。
實現(xiàn)工具類如下：
package com.fongtech.cli.admin.tasktime;
import com.fongtech.cli.common.util.BeanUtils;
import org.springframework.context.annotation.Configuration;
import org.springframework.scheduling.SchedulingException;
import org.springframework.scheduling.TaskScheduler;
import org.springframework.scheduling.annotation.EnableScheduling;
import org.springframework.scheduling.annotation.SchedulingConfigurer;
import org.springframework.scheduling.config.ScheduledTaskRegistrar;
import org.springframework.scheduling.config.TriggerTask;
import org.springframework.scheduling.support.CronTrigger;
import javax.annotation.PostConstruct;
import java.util.Map;
import java.util.Set;
import java.util.concurrent.ConcurrentHashMap;
import java.util.concurrent.ScheduledFuture;
/**
* @author linb
* @date 2020/6/15 11:16
*/
@Configuration
//@EnableScheduling
public class DefaultSchedulingConfigurer implements SchedulingConfigurer {
private ScheduledTaskRegistrar taskRegistrar;
private Set<ScheduledFuture<?>> scheduledFutures = null;
private Map<String, ScheduledFuture<?>> taskFutures = new ConcurrentHashMap<>();
@Override
public void configureTasks(ScheduledTaskRegistrar taskRegistrar) {
this.taskRegistrar = taskRegistrar;
}
@SuppressWarnings("unchecked")
private Set<ScheduledFuture<?>> getScheduledFutures() {
if (scheduledFutures == null) {
try {
// spring版本不同選用不同字段scheduledFutures
scheduledFutures = (Set<ScheduledFuture<?>>) BeanUtils.getProperty(taskRegistrar, "scheduledTasks");
} catch (NoSuchFieldException e) {
throw new SchedulingException("not found scheduledFutures field.");
}
}
return scheduledFutures;
}
/**
* 添加任務
*/
public void addTriggerTask(String taskId, TriggerTask triggerTask) {
if (taskFutures.containsKey(taskId)) {
throw new SchedulingException("the taskId[" + taskId + "] was added.");
}
TaskScheduler scheduler = taskRegistrar.getScheduler();
ScheduledFuture<?> future = scheduler.schedule(triggerTask.getRunnable(), triggerTask.getTrigger());
getScheduledFutures().add(future);
taskFutures.put(taskId, future);
}
/**
* 取消任務
*/
public void cancelTriggerTask(String taskId) {
ScheduledFuture<?> future = taskFutures.get(taskId);
if (future != null) {
future.cancel(true);
}
taskFutures.remove(taskId);
getScheduledFutures().remove(future);
}
/**
* 重置任務
*/
public void resetTriggerTask(String taskId, TriggerTask triggerTask) {
cancelTriggerTask(taskId);
addTriggerTask(taskId, triggerTask);
}
/**
* 任務編號
*/
public Set<String> taskIds() {
return taskFutures.keySet();
}
/**
* 是否存在任務
*/
public boolean hasTask(String taskId) {
return this.taskFutures.containsKey(taskId);
}
/**
* 任務調度是否已經初始化完成
*/
public boolean inited() {
return this.taskRegistrar != null && this.taskRegistrar.getScheduler() != null;
}
}
在項目啟動后就自動開啟任務的操作類如下：
package com.fongtech.cli.admin.tasktime;
import com.fongtech.cli.admin.service.IAuthLoginService;
import com.fongtech.cli.admin.service.IBackupsService;
import com.fongtech.cli.admin.service.IDictionnaryEntryService;
import com.fongtech.cli.mbg.model.entity.AuthLogin;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.CommandLineRunner;
import org.springframework.core.annotation.Order;
import org.springframework.scheduling.config.TriggerTask;
import org.springframework.scheduling.support.CronTrigger;
import org.springframework.stereotype.Component;
/**
* 項目啟動后執(zhí)行，
*/
@Slf4j
@Component
@Order(value = 1)
public class CmdRunner implements CommandLineRunner {
@Autowired
private DefaultSchedulingConfigurer defaultSchedulingConfigurer;
@Autowired
private IDictionnaryEntryService dictionnaryEntryService;
@Autowired
private IBackupsService backupsService;
@Autowired
private IAuthLoginService authLoginService;
@Override
public void run(String... args) throws Exception {
log.info("------按照預設備份周期啟動數據庫備份定時任務");
while (!defaultSchedulingConfigurer.inited())
{
try {
Thread.sleep(100);
} catch (InterruptedException e) {
e.printStackTrace();
} finally {
}
}
String cron = dictionnaryEntryService.getEntryValueByName("CRON_VALUE");
//默認按照管理員用戶權限執(zhí)行備份任務
AuthLogin authLogin = authLoginService.query().eq(AuthLogin::getLogin_user, "admin").getOne();
//啟動線程，按照原表內的時間執(zhí)行備份任務
defaultSchedulingConfigurer.addTriggerTask("task",
new TriggerTask(
() -> System.out.println("=====----------啟動定時任務=-----------");,
new CronTrigger(cron)));
}
}
暫停定時任務：
defaultSchedulingConfigurer.cancelTriggerTask("task");
到此這篇關于淺談在springboot中使用定時任務的方式的文章就介紹到這了,更多相關springboot定時任務內容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關文章希望大家以后多多支持腳本之家！
相關文章
關于Spring Boot和Kotlin的聯(lián)合開發(fā)
這篇文章主要介紹了關于Spring Boot和Kotlin的聯(lián)合開發(fā),需要的朋友可以參考下2017-06-06
這篇文章主要介紹了Java進程與線程的區(qū)別，進程（Process）是操作系統(tǒng)分配資源的基本單位，線程（Thread）是操作系統(tǒng)能夠進行運算調度的基本單位，下文更多兩者區(qū)別。需要的小伙伴可以參考一下2022-05-05
這篇文章主要介紹了java中的異常,文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值,需要的朋友可以參考下2021-08-08
這篇文章主要介紹了SpringBoot如何動態(tài)改變日志級別，幫助大家更好的理解和使用springboot框架，感興趣的朋友可以了解下2020-12-12
本文介紹了Java動態(tài)腳本Groovy，Groovy是用于Java虛擬機的一種敏捷的動態(tài)語言，它是一種成熟的面向對象編程語言，既可以用于面向對象編程，又可以用作純粹的腳本語言。使用該種語言不必編寫過多的代碼，同時又具有閉包和動態(tài)語言中的其他特性,需要的朋友可以參考一下2021-12-12
說起Spring狀態(tài)機,大家很容易聯(lián)想到這個狀態(tài)機和設計模式中狀態(tài)模式的區(qū)別是啥呢？沒錯,Spring狀態(tài)機就是狀態(tài)模式的一種實現(xiàn),在介紹Spring狀態(tài)機之前,讓我們來看看設計模式中的狀態(tài)模式,需要的朋友可以參考下2024-04-04
今天小編就為大家分享一篇關于MyBatis通過BATCH批量提交的方法，小編覺得內容挺不錯的，現(xiàn)在分享給大家，具有很好的參考價值，需要的朋友一起跟隨小編來看看吧2018-12-12
SpringBoot整合WebSocket的客戶端和服務端的實現(xiàn)代碼
這篇文章主要介紹了SpringBoot整合WebSocket的客戶端和服務端的實現(xiàn),本文通過實例代碼給大家介紹的非常詳細，對大家的學習或工作具有一定的參考借鑒價值，需要的朋友可以參考下2022-07-07
這篇文章主要介紹了淺談一下Java多線程斷點復制,當程序執(zhí)行中斷時（出現(xiàn)錯誤、斷電關機），仍可以從上次復制過程中重新開始（不必從頭開始復制）,需要的朋友可以參考下2023-04-04
SpringCloud Stream由一個中間件中立的核組成，應用通過SpringCloud Stream插入的input(相當于消費者consumer，它是從隊列中接收消息的)和output(相當于生產者producer，它是發(fā)送消息到隊列中的)通道與外界交流2022-09-09