SpringBoot如何實(shí)現(xiàn)定時(shí)任務(wù)示例詳解
更新時(shí)間：2021年10月15日 09:22:20 作者：Jae1995
使用定時(shí)任務(wù)完成一些業(yè)務(wù)邏輯,比如天氣接口的數(shù)據(jù)獲取,定時(shí)發(fā)送短信,郵件。以及商城中每天用戶的限額,定時(shí)自動(dòng)收貨等等,這篇文章主要給大家介紹了關(guān)于SpringBoot如何實(shí)現(xiàn)定時(shí)任務(wù)的相關(guān)資料,需要的朋友可以參考下
寫在前面
SpringBoot創(chuàng)建定時(shí)任務(wù)的方式很簡(jiǎn)單，主要有兩種方式：一、基于注解的方式（@Scheduled）二、數(shù)據(jù)庫動(dòng)態(tài)配置。實(shí)際開發(fā)中，第一種需要在代碼中寫死表達(dá)式，如果修改起來，又得重啟會(huì)顯得很麻煩；所以我們往往會(huì)采取第二種方式，可以直接從數(shù)據(jù)庫中讀取定時(shí)任務(wù)的指定執(zhí)行時(shí)間，無需重啟。
下面就來介紹下這兩種方式吧
一、基于注解（@Scheduled）
基于注解是一種靜態(tài)的方式，只需要幾行代碼就可以搞定了
添加一個(gè)配置類
@Configuration //標(biāo)記配置類
@EnableScheduling //開啟定時(shí)任務(wù)
public class MyScheduleConfig {
//添加定時(shí)任務(wù)
@Scheduled(cron = "0/5 * * * * ?")
private void myTasks() {
System.out.println("執(zhí)行定時(shí)任務(wù) " + LocalDateTime.now());
}
}
上面代碼的cron表達(dá)式表示每5秒執(zhí)行一次，可以通過這個(gè)網(wǎng)站（http://tools.jb51.net/code/Quartz_Cron_create）去生成要的cron表達(dá)式
啟動(dòng)應(yīng)用，控制臺(tái)看效果
這個(gè)方式的確很簡(jiǎn)單方便，但前面介紹也說到了，有個(gè)缺點(diǎn)就是當(dāng)我們需要去修改定時(shí)任務(wù)的執(zhí)行周期或者停止的時(shí)候，我們需要到代碼層去修改，重啟。
二、數(shù)據(jù)庫動(dòng)態(tài)配置
這里使用MySQL數(shù)據(jù)庫
1、表數(shù)據(jù)添加，資源配置
1.1 添加表
CREATE TABLE `scheduled_job` ( `job_id` int(11) NOT NULL AUTO_INCREMENT COMMENT '主鍵id', `job_key` varchar(128) NOT NULL COMMENT '定時(shí)任務(wù)完整類名', `cron_expression` varchar(20) NOT NULL COMMENT 'cron表達(dá)式', `task_explain` varchar(50) NOT NULL DEFAULT '' COMMENT '任務(wù)描述', `status` tinyint(4) NOT NULL DEFAULT '1' COMMENT '狀態(tài),1:正常;-1:停用', PRIMARY KEY (`job_id`), UNIQUE KEY `job_key` (`job_key`), UNIQUE KEY `cron_key_unique_idx` (`job_key`) ) ENGINE=InnoDB AUTO_INCREMENT=1 DEFAULT CHARSET=utf8 COLLATE=utf8_bin COMMENT='定時(shí)任務(wù)表';
1.2 插入兩條數(shù)據(jù)，job_key根據(jù)是完整的類名
1.3 引入依賴
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<!--mysql-->
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>5.1.49</version>
<scope>runtime</scope>
</dependency>
<!--mybatis-plus-->
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-boot-starter</artifactId>
<version>3.3.1.tmp</version>
</dependency>
<!--lombok簡(jiǎn)化代碼-->
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<version>1.18.20</version>
<scope>provided</scope>
</dependency>
1.4 配置application.yml
spring:
datasource:
url: jdbc:mysql://127.0.0.1:3306/test?userUnicode=true&characterEncoding=UTF8&useSSL=false
username: root
password: 123
driver-class-name: com.mysql.jdbc.Driver
server:
servlet:
context-path: /demo
port: 8888
2、瘋狂貼代碼
2.1 創(chuàng)建定時(shí)任務(wù)線程池
@Configuration
@Slf4j
public class ScheduledConfig {
@Bean
public ThreadPoolTaskScheduler threadPoolTaskScheduler() {
log.info("創(chuàng)建定時(shí)任務(wù)調(diào)度線程池 start");
ThreadPoolTaskScheduler threadPoolTaskScheduler = new ThreadPoolTaskScheduler();
threadPoolTaskScheduler.setPoolSize(20);
threadPoolTaskScheduler.setThreadNamePrefix("taskExecutor-");
threadPoolTaskScheduler.setWaitForTasksToCompleteOnShutdown(true);
threadPoolTaskScheduler.setAwaitTerminationSeconds(60);
log.info("創(chuàng)建定時(shí)任務(wù)調(diào)度線程池 end");
return threadPoolTaskScheduler;
}
}
2.2 項(xiàng)目啟動(dòng)時(shí)初始化定時(shí)任務(wù)
@Slf4j
@Component
public class ScheduledTaskRunner implements ApplicationRunner {
@Autowired
private ScheduledTaskService scheduledTaskService;
@Override
public void run(ApplicationArguments args) throws Exception {
log.info("----初始化定時(shí)任務(wù)開始----");
scheduledTaskService.initTask();
log.info("----初始化定時(shí)任務(wù)完成----");
}
}
2.3 定時(shí)任務(wù)公共接口
public interface ScheduledOfTask extends Runnable{
void execute();
@Override
default void run() {
execute();
}
}
2.4 創(chuàng)建兩個(gè)定時(shí)任務(wù)實(shí)現(xiàn)類
@Component
@Slf4j
public class TaskJob1 implements ScheduledOfTask{
@Override
public void execute() {
log.info("執(zhí)行任務(wù)1 "+ LocalDateTime.now());
}
}
@Component
@Slf4j
public class TaskJob2 implements ScheduledOfTask{
@Override
public void execute() {
log.info("執(zhí)行任務(wù)2 "+ LocalDateTime.now());
}
}
2.5 定時(shí)任務(wù)管理接口
public interface ScheduledTaskService{
Boolean start(ScheduledJob scheduledJob);
Boolean stop(String jobKey);
Boolean restart(ScheduledJob scheduledJob);
void initTask();
}
2.6 定時(shí)任務(wù)管理實(shí)現(xiàn)類
@Slf4j
@Service
public class ScheduledTaskServiceImpl implements ScheduledTaskService {
/**
* 可重入鎖
*/
private ReentrantLock lock = new ReentrantLock();
/**
* 定時(shí)任務(wù)線程池
*/
@Autowired
private ThreadPoolTaskScheduler threadPoolTaskScheduler;
/**
* 啟動(dòng)狀態(tài)的定時(shí)任務(wù)集合
*/
public Map<String, ScheduledFuture> scheduledFutureMap = new ConcurrentHashMap<>();
@Autowired
private ScheduledJobService scheduledJobService;
@Override
public Boolean start(ScheduledJob scheduledJob) {
String jobKey = scheduledJob.getJobKey();
log.info("啟動(dòng)定時(shí)任務(wù)"+jobKey);
//添加鎖放一個(gè)線程啟動(dòng)，防止多人啟動(dòng)多次
lock.lock();
log.info("加鎖完成");
try {
if(this.isStart(jobKey)){
log.info("當(dāng)前任務(wù)在啟動(dòng)狀態(tài)中");
return false;
}
//任務(wù)啟動(dòng)
this.doStartTask(scheduledJob);
} finally {
lock.unlock();
log.info("解鎖完畢");
}
return true;
}
/**
* 任務(wù)是否已經(jīng)啟動(dòng)
*/
private Boolean isStart(String taskKey) {
//校驗(yàn)是否已經(jīng)啟動(dòng)
if (scheduledFutureMap.containsKey(taskKey)) {
if (!scheduledFutureMap.get(taskKey).isCancelled()) {
return true;
}
}
return false;
}
@Override
public Boolean stop(String jobKey) {
log.info("停止任務(wù) "+jobKey);
boolean flag = scheduledFutureMap.containsKey(jobKey);
log.info("當(dāng)前實(shí)例是否存在 "+flag);
if(flag){
ScheduledFuture scheduledFuture = scheduledFutureMap.get(jobKey);
scheduledFuture.cancel(true);
scheduledFutureMap.remove(jobKey);
}
return flag;
}
@Override
public Boolean restart(ScheduledJob scheduledJob) {
log.info("重啟定時(shí)任務(wù)"+scheduledJob.getJobKey());
//停止
this.stop(scheduledJob.getJobKey());
return this.start(scheduledJob);
}
/**
* 執(zhí)行啟動(dòng)任務(wù)
*/
public void doStartTask(ScheduledJob sj){
log.info(sj.getJobKey());
if(sj.getStatus().intValue() != 1)
return;
Class<?> clazz;
ScheduledOfTask task;
try {
clazz = Class.forName(sj.getJobKey());
task = (ScheduledOfTask) SpringContextUtil.getBean(clazz);
} catch (ClassNotFoundException e) {
throw new IllegalArgumentException("spring_scheduled_cron表數(shù)據(jù)" + sj.getJobKey() + "有誤", e);
}
Assert.isAssignable(ScheduledOfTask.class, task.getClass(), "定時(shí)任務(wù)類必須實(shí)現(xiàn)ScheduledOfTask接口");
ScheduledFuture scheduledFuture = threadPoolTaskScheduler.schedule(task,(triggerContext -> new CronTrigger(sj.getCronExpression()).nextExecutionTime(triggerContext)));
scheduledFutureMap.put(sj.getJobKey(),scheduledFuture);
}
@Override
public void initTask() {
List<ScheduledJob> list = scheduledJobService.list();
for (ScheduledJob sj : list) {
if(sj.getStatus().intValue() == -1) //未啟用
continue;
doStartTask(sj);
}
}
}
2.8 上面用到的獲取Bean的工具類SpringContextUtil
@Component
public class SpringContextUtil implements ApplicationContextAware {
private static ApplicationContext applicationContext = null;
@Override
public void setApplicationContext(ApplicationContext applicationContext) throws BeansException {
if(SpringContextUtil.applicationContext == null){
SpringContextUtil.applicationContext = applicationContext;
}
}
public static ApplicationContext getApplicationContext() {
return applicationContext;
}
public static Object getBean(String name){
return getApplicationContext().getBean(name);
}
public static <T> T getBean(Class<T> clazz){
return getApplicationContext().getBean(clazz);
}
public static <T> T getBean(String name,Class<T> clazz){
return getApplicationContext().getBean(name, clazz);
}
}
2.9 表操作對(duì)應(yīng)的一些類
Pojo
@Data
@TableName("scheduled_job")
public class ScheduledJob {
@TableId(value = "job_id",type = IdType.AUTO)
private Integer jobId;
private String jobKey;
private String cronExpression;
private String taskExplain;
private Integer status;
}
ScheduledJobMapper
public interface ScheduledJobMapper extends BaseMapper<ScheduledJob> {
}
ScheduledJobService
public interface ScheduledJobService extends IService<ScheduledJob> {
/**
* 修改定時(shí)任務(wù)，并重新啟動(dòng)
* @param scheduledJob
* @return
*/
boolean updateOne(ScheduledJob scheduledJob);
}
@Service
@Slf4j
public class ScheduledJobServiceImpl extends ServiceImpl<ScheduledJobMapper, ScheduledJob> implements ScheduledJobService{
@Autowired
private ScheduledTaskService scheduledTaskService;
@Override
public boolean updateOne(ScheduledJob scheduledJob) {
if(updateById(scheduledJob))
scheduledTaskService.restart(getById(scheduledJob.getJobId()));
return true;
}
}
2.10 修改定時(shí)任務(wù)的接口
@RestController
@RequestMapping("/job")
public class ScheduledJobController {
@Autowired
private ScheduledJobService scheduledJobService;
@PostMapping(value = "/update")
public CallBackResult update(HttpServletRequest request, ScheduledJob scheduledJob){
if(scheduledJobService.updateOne(scheduledJob))
return new CallBackResult(true,"修改成功");
return new CallBackResult(false,"修改失敗");
}
}
3、測(cè)試結(jié)果
3.1 啟動(dòng)項(xiàng)目，看下定時(shí)任務(wù)的執(zhí)行結(jié)果，控制臺(tái)輸出結(jié)果
我們可以看到任務(wù)1是每5秒執(zhí)行一次，任務(wù)2是12秒執(zhí)行一次
3.2 修改任務(wù)1的cron參數(shù)或者狀態(tài)
3.2.1 修改cron，執(zhí)行周期改為20秒執(zhí)行一次，狀態(tài)不變
再看控制臺(tái)輸出結(jié)果，任務(wù)2沒變化，任務(wù)1由5秒一次變成了20秒一次了
3.2.1 修改狀態(tài)
再看控制臺(tái)輸出結(jié)果，任務(wù)2沒變化，任務(wù)1已經(jīng)不再執(zhí)行了
最后
第二種方式支持通過接口的方式去改動(dòng)，并且不需要重啟，當(dāng)然啦，也可以直接在數(shù)據(jù)庫中添加或修改數(shù)據(jù)后重啟項(xiàng)目，配置更加靈活一點(diǎn)。
如果是一個(gè)固定的需求，執(zhí)行周期一定不會(huì)變的了，推薦還是第一種寫法，畢竟簡(jiǎn)單嘛。
如果覺得寫得還不錯(cuò)的話，給個(gè)推薦鼓勵(lì)一下吧。
到此這篇關(guān)于SpringBoot如何實(shí)現(xiàn)定時(shí)任務(wù)的文章就介紹到這了,更多相關(guān)SpringBoot實(shí)現(xiàn)定時(shí)任務(wù)內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！
相關(guān)文章
Java的中斷是一種協(xié)作機(jī)制。也就是說調(diào)用線程對(duì)象的interrupt方法并不一定就中斷了正在運(yùn)行的線程，它只是要求線程自己在合適的時(shí)機(jī)中斷自己，本文將詳細(xì)介紹，需要了解的朋友可以參考下2012-12-12
這篇文章主要介紹了idea中引入了gb2312編碼的文件的解決方法，文中通過示例代碼介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值，需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2019-08-08
這篇文章主要介紹了Java之CountDownLatch原理解析，具有很好的參考價(jià)值，希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方，望不吝賜教2022-10-10
Spring Boot啟動(dòng)及退出加載項(xiàng)的方法
這篇文章主要介紹了Spring Boot啟動(dòng)及退出加載項(xiàng)的方法，文中通過示例代碼介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值，需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2019-04-04
本文主要介紹了Java list亂序的實(shí)現(xiàn)三種方法,包含Collections.shuffle()方法,random和Stream API這三種,具有一定的參考價(jià)值,感興趣的可以了解一下2024-03-03
SpringMVC中利用@InitBinder來對(duì)頁面數(shù)據(jù)進(jìn)行解析綁定的方法
本篇文章主要介紹了SpringMVC中利用@InitBinder來對(duì)頁面數(shù)據(jù)進(jìn)行解析綁定的方法，非常具有實(shí)用價(jià)值，需要的朋友可以參考下2018-03-03
PropertiesLoaderUtils 出現(xiàn)中文亂碼的解決方式
這篇文章主要介紹了PropertiesLoaderUtils 出現(xiàn)中文亂碼的解決方式，具有很好的參考價(jià)值，希望對(duì)大家有所幫助。一起跟隨小編過來看看吧2020-08-08
SkyWalking?自定義插件(Spring?RabbitMQ)具體分析過程
這篇文章主要介紹了SkyWalking?自定義插件(Spring?RabbitMQ)具體分析過程，本文通過實(shí)例代碼給大家介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或工作具有一定的參考借鑒價(jià)值,需要的朋友可以參考下2022-02-02
Spring Boot + Vue 基于 RSA 的用戶身份
RSA是一種非對(duì)稱加密算法,適用于用戶身份認(rèn)證加密,本文介紹了基于RSA的用戶身份認(rèn)證加密機(jī)制的實(shí)現(xiàn),包括前端Vue.js使用jsencrypt庫對(duì)用戶名密碼進(jìn)行加密,后端使用RSA私鑰解密驗(yàn)證用戶憑據(jù),感興趣的朋友跟隨小編一起看看吧2024-11-11
Java深入學(xué)習(xí)圖形用戶界面GUI之創(chuàng)建窗體
圖形編程中，窗口是一個(gè)重要的概念，窗口其實(shí)是一個(gè)矩形框，應(yīng)用程序可以使用其從而達(dá)到輸出結(jié)果和接受用戶輸入的效果，學(xué)習(xí)了GUI就讓我們用它來創(chuàng)建一個(gè)窗體2022-05-05