springboot+Quartz實(shí)現(xiàn)任務(wù)調(diào)度的示例代碼
在spring框架中通過 @Schedule 可以實(shí)現(xiàn)定時(shí)任務(wù),通過該注解 cron 的屬性描述的規(guī)則,spring會(huì)去調(diào)用這個(gè)方法。
spring已經(jīng)簡(jiǎn)單粗暴的實(shí)現(xiàn)了定時(shí)任務(wù),為什么要使用Quartz ?
如果你現(xiàn)在有很多個(gè)定時(shí)任務(wù),規(guī)則不同,例如:
- 想每月25號(hào),信用卡自動(dòng)還款
- 想每年4月1日自己給當(dāng)年暗戀女神發(fā)一封匿名賀卡
- 想每隔1小時(shí),備份一下自己的愛情動(dòng)作片 學(xué)習(xí)筆記到云盤
maven 依賴
<dependency> <groupId>org.quartz-scheduler</groupId> <artifactId>quartz</artifactId> <version>2.2.1</version> </dependency> <dependency> <groupId>org.quartz-scheduler</groupId> <artifactId>quartz-jobs</artifactId> <version>2.2.1</version> </dependency>
以下是bootdo開源學(xué)習(xí)框架的源碼
我并沒有用到全部的字段,思路是先查詢DB,
封裝以下兩個(gè)對(duì)象
- JobDetail 負(fù)責(zé)存放 job 所需要的數(shù)據(jù)
- Trigger 設(shè)置 job 的 key,規(guī)則(cron)何時(shí)開啟任務(wù)等屬性
當(dāng)觸發(fā)條件滿足時(shí),會(huì)根據(jù)所設(shè)置的beanClass 找到該類(必須實(shí)現(xiàn)org.quartz.Job), 這時(shí)可以取出JobDetail 中的數(shù)據(jù),執(zhí)行具體業(yè)務(wù)邏輯
@Component public class WelcomeJob implements Job{ @Override public void execute(JobExecutionContext arg0) throws JobExecutionException { //你的業(yè)務(wù)邏輯 } }
表結(jié)構(gòu)
CREATE TABLE `sys_task` ( `id` bigint(20) NOT NULL AUTO_INCREMENT, `cronExpression` varchar(255) DEFAULT NULL COMMENT 'cron表達(dá)式', `methodName` varchar(255) DEFAULT NULL COMMENT '任務(wù)調(diào)用的方法名', `isConcurrent` varchar(255) DEFAULT NULL COMMENT '任務(wù)是否有狀態(tài)', `description` varchar(255) DEFAULT NULL COMMENT '任務(wù)描述', `updateBy` varchar(64) DEFAULT NULL COMMENT '更新者', `beanClass` varchar(255) DEFAULT NULL COMMENT '任務(wù)執(zhí)行時(shí)調(diào)用哪個(gè)類的方法 包名+類名', `createDate` datetime DEFAULT NULL COMMENT '創(chuàng)建時(shí)間', `jobStatus` varchar(255) DEFAULT NULL COMMENT '任務(wù)狀態(tài)', `jobGroup` varchar(255) DEFAULT NULL COMMENT '任務(wù)分組', `updateDate` datetime DEFAULT NULL COMMENT '更新時(shí)間', `createBy` varchar(64) DEFAULT NULL COMMENT '創(chuàng)建者', `springBean` varchar(255) DEFAULT NULL COMMENT 'Spring bean', `jobName` varchar(255) DEFAULT NULL COMMENT '任務(wù)名', PRIMARY KEY (`id`) ) ENGINE=InnoDB AUTO_INCREMENT=3 DEFAULT CHARSET=utf8 ROW_FORMAT=COMPACT;
配置類
import java.io.IOException; import java.util.Properties; import org.quartz.Scheduler; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.beans.factory.config.PropertiesFactoryBean; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import org.springframework.core.io.ClassPathResource; import org.springframework.scheduling.quartz.SchedulerFactoryBean; import com.txgl.common.quartz.factory.JobFactory; @Configuration public class QuartzConfigration { @Autowired JobFactory jobFactory; @Bean public SchedulerFactoryBean schedulerFactoryBean() { SchedulerFactoryBean schedulerFactoryBean = new SchedulerFactoryBean(); try { schedulerFactoryBean.setOverwriteExistingJobs(true); schedulerFactoryBean.setQuartzProperties(quartzProperties()); schedulerFactoryBean.setJobFactory(jobFactory); } catch (IOException e) { e.printStackTrace(); } return schedulerFactoryBean; } // 指定quartz.properties @Bean public Properties quartzProperties() throws IOException { PropertiesFactoryBean propertiesFactoryBean = new PropertiesFactoryBean(); propertiesFactoryBean.setLocation(new ClassPathResource("/config/quartz.properties")); propertiesFactoryBean.afterPropertiesSet(); return propertiesFactoryBean.getObject(); } // 創(chuàng)建schedule @Bean(name = "scheduler") public Scheduler scheduler() { return schedulerFactoryBean().getScheduler(); } }
QuartzManager的代碼是關(guān)鍵,通過注入Scheduler 對(duì)任務(wù)進(jìn)行操作
import java.util.ArrayList; import java.util.List; import java.util.Set; import org.apache.log4j.Logger; import org.quartz.CronScheduleBuilder; import org.quartz.CronTrigger; import org.quartz.DateBuilder; import org.quartz.DateBuilder.IntervalUnit; import org.quartz.Job; import org.quartz.JobBuilder; import org.quartz.JobDetail; import org.quartz.JobExecutionContext; import org.quartz.JobKey; import org.quartz.Scheduler; import org.quartz.SchedulerException; import org.quartz.Trigger; import org.quartz.TriggerBuilder; import org.quartz.TriggerKey; import org.quartz.impl.matchers.GroupMatcher; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.beans.factory.annotation.Qualifier; import org.springframework.scheduling.quartz.SchedulerFactoryBean; import org.springframework.stereotype.Service; import org.springframework.web.context.support.SpringBeanAutowiringSupport; import com.bootdo.common.domain.ScheduleJob; import com.bootdo.common.quartz.factory.*; import com.bootdo.common.utils.SpringContextHolder;; /** * * * @title: QuartzManager.java * @description: 計(jì)劃任務(wù)管理 * */ @Service public class QuartzManager { public final Logger log = Logger.getLogger(this.getClass()); // private SchedulerFactoryBean schedulerFactoryBean // =SpringContextHolder.getBean(SchedulerFactoryBean.class); // @Autowired // @Qualifier("schedulerFactoryBean") // private SchedulerFactoryBean schedulerFactoryBean; @Autowired private Scheduler scheduler; /** * 添加任務(wù) * * @param scheduleJob * @throws SchedulerException */ public void addJob(ScheduleJob job) { try { // 創(chuàng)建jobDetail實(shí)例,綁定Job實(shí)現(xiàn)類 // 指明job的名稱,所在組的名稱,以及綁定job類 Class<? extends Job> jobClass = (Class<? extends Job>) (Class.forName(job.getBeanClass()).newInstance() .getClass()); JobDetail jobDetail = JobBuilder.newJob(jobClass).withIdentity(job.getJobName(), job.getJobGroup())// 任務(wù)名稱和組構(gòu)成任務(wù)key .build(); // 定義調(diào)度觸發(fā)規(guī)則 // 使用cornTrigger規(guī)則 Trigger trigger = TriggerBuilder.newTrigger().withIdentity(job.getJobName(), job.getJobGroup())// 觸發(fā)器key .startAt(DateBuilder.futureDate(1, IntervalUnit.SECOND)) .withSchedule(CronScheduleBuilder.cronSchedule(job.getCronExpression())).startNow().build(); // 把作業(yè)和觸發(fā)器注冊(cè)到任務(wù)調(diào)度中 scheduler.scheduleJob(jobDetail, trigger); // 啟動(dòng) if (!scheduler.isShutdown()) { scheduler.start(); } } catch (Exception e) { e.printStackTrace(); } } // public void addJob(ScheduleJob job) throws SchedulerException { // if (job == null || !ScheduleJob.STATUS_RUNNING.equals(job.getJobStatus())) { // return; // } // // TriggerKey triggerKey = TriggerKey.triggerKey(job.getJobName(), job.getJobGroup()); // // CronTrigger trigger = (CronTrigger) scheduler.getTrigger(triggerKey); // // // 不存在,創(chuàng)建一個(gè) // // if (null == trigger) { // Class<? extends Job> clazz = ScheduleJob.CONCURRENT_IS.equals(job.getIsConcurrent()) // ? QuartzJobFactory.class // : QuartzJobFactoryDisallowConcurrentExecution.class; // // JobDetail jobDetail = JobBuilder.newJob(clazz).withIdentity(job.getJobName(), job.getJobGroup()).build(); // // jobDetail.getJobDataMap().put("scheduleJob", job); // // CronScheduleBuilder scheduleBuilder = CronScheduleBuilder.cronSchedule(job.getCronExpression()); // // trigger = TriggerBuilder.newTrigger().withIdentity(job.getJobName(), job.getJobGroup()) // .withSchedule(scheduleBuilder).build(); // // scheduler.scheduleJob(jobDetail, trigger); // } else { // // Trigger已存在,那么更新相應(yīng)的定時(shí)設(shè)置 // // CronScheduleBuilder scheduleBuilder = CronScheduleBuilder.cronSchedule(job.getCronExpression()); // // // 按新的cronExpression表達(dá)式重新構(gòu)建trigger // // trigger = trigger.getTriggerBuilder().withIdentity(triggerKey).withSchedule(scheduleBuilder).build(); // // // 按新的trigger重新設(shè)置job執(zhí)行 // // scheduler.rescheduleJob(triggerKey, trigger); // } // } /** * 獲取所有計(jì)劃中的任務(wù)列表 * * @return * @throws SchedulerException */ public List<ScheduleJob> getAllJob() throws SchedulerException { GroupMatcher<JobKey> matcher = GroupMatcher.anyJobGroup(); Set<JobKey> jobKeys = scheduler.getJobKeys(matcher); List<ScheduleJob> jobList = new ArrayList<ScheduleJob>(); for (JobKey jobKey : jobKeys) { List<? extends Trigger> triggers = scheduler.getTriggersOfJob(jobKey); for (Trigger trigger : triggers) { ScheduleJob job = new ScheduleJob(); job.setJobName(jobKey.getName()); job.setJobGroup(jobKey.getGroup()); job.setDescription("觸發(fā)器:" + trigger.getKey()); Trigger.TriggerState triggerState = scheduler.getTriggerState(trigger.getKey()); job.setJobStatus(triggerState.name()); if (trigger instanceof CronTrigger) { CronTrigger cronTrigger = (CronTrigger) trigger; String cronExpression = cronTrigger.getCronExpression(); job.setCronExpression(cronExpression); } jobList.add(job); } } return jobList; } /** * 所有正在運(yùn)行的job * * @return * @throws SchedulerException */ public List<ScheduleJob> getRunningJob() throws SchedulerException { List<JobExecutionContext> executingJobs = scheduler.getCurrentlyExecutingJobs(); List<ScheduleJob> jobList = new ArrayList<ScheduleJob>(executingJobs.size()); for (JobExecutionContext executingJob : executingJobs) { ScheduleJob job = new ScheduleJob(); JobDetail jobDetail = executingJob.getJobDetail(); JobKey jobKey = jobDetail.getKey(); Trigger trigger = executingJob.getTrigger(); job.setJobName(jobKey.getName()); job.setJobGroup(jobKey.getGroup()); job.setDescription("觸發(fā)器:" + trigger.getKey()); Trigger.TriggerState triggerState = scheduler.getTriggerState(trigger.getKey()); job.setJobStatus(triggerState.name()); if (trigger instanceof CronTrigger) { CronTrigger cronTrigger = (CronTrigger) trigger; String cronExpression = cronTrigger.getCronExpression(); job.setCronExpression(cronExpression); } jobList.add(job); } return jobList; } /** * 暫停一個(gè)job * * @param scheduleJob * @throws SchedulerException */ public void pauseJob(ScheduleJob scheduleJob) throws SchedulerException { JobKey jobKey = JobKey.jobKey(scheduleJob.getJobName(), scheduleJob.getJobGroup()); scheduler.pauseJob(jobKey); } /** * 恢復(fù)一個(gè)job * * @param scheduleJob * @throws SchedulerException */ public void resumeJob(ScheduleJob scheduleJob) throws SchedulerException { JobKey jobKey = JobKey.jobKey(scheduleJob.getJobName(), scheduleJob.getJobGroup()); scheduler.resumeJob(jobKey); } /** * 刪除一個(gè)job * * @param scheduleJob * @throws SchedulerException */ public void deleteJob(ScheduleJob scheduleJob) throws SchedulerException { JobKey jobKey = JobKey.jobKey(scheduleJob.getJobName(), scheduleJob.getJobGroup()); scheduler.deleteJob(jobKey); } /** * 立即執(zhí)行job * * @param scheduleJob * @throws SchedulerException */ public void runAJobNow(ScheduleJob scheduleJob) throws SchedulerException { JobKey jobKey = JobKey.jobKey(scheduleJob.getJobName(), scheduleJob.getJobGroup()); scheduler.triggerJob(jobKey); } /** * 更新job時(shí)間表達(dá)式 * * @param scheduleJob * @throws SchedulerException */ public void updateJobCron(ScheduleJob scheduleJob) throws SchedulerException { TriggerKey triggerKey = TriggerKey.triggerKey(scheduleJob.getJobName(), scheduleJob.getJobGroup()); CronTrigger trigger = (CronTrigger) scheduler.getTrigger(triggerKey); CronScheduleBuilder scheduleBuilder = CronScheduleBuilder.cronSchedule(scheduleJob.getCronExpression()); trigger = trigger.getTriggerBuilder().withIdentity(triggerKey).withSchedule(scheduleBuilder).build(); scheduler.rescheduleJob(triggerKey, trigger); } }
service實(shí)現(xiàn)
import com.bootdo.common.config.Constant; import com.bootdo.common.dao.TaskDao; import com.bootdo.common.domain.ScheduleJob; import com.bootdo.common.domain.TaskDO; import com.bootdo.common.quartz.utils.QuartzManager; import com.bootdo.common.service.JobService; import com.bootdo.common.utils.ScheduleJobUtils; import org.quartz.SchedulerException; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.stereotype.Service; import java.util.HashMap; import java.util.List; import java.util.Map; @Service public class JobServiceImpl implements JobService { @Autowired private TaskDao taskScheduleJobMapper; @Autowired QuartzManager quartzManager; @Override public TaskDO get(Long id) { return taskScheduleJobMapper.get(id); } @Override public List<TaskDO> list(Map<String, Object> map) { return taskScheduleJobMapper.list(map); } @Override public int count(Map<String, Object> map) { return taskScheduleJobMapper.count(map); } @Override public int save(TaskDO taskScheduleJob) { return taskScheduleJobMapper.save(taskScheduleJob); } @Override public int update(TaskDO taskScheduleJob) { return taskScheduleJobMapper.update(taskScheduleJob); } @Override public int remove(Long id) { try { TaskDO scheduleJob = get(id); quartzManager.deleteJob(ScheduleJobUtils.entityToData(scheduleJob)); return taskScheduleJobMapper.remove(id); } catch (SchedulerException e) { e.printStackTrace(); return 0; } } @Override public int batchRemove(Long[] ids) { for (Long id : ids) { try { TaskDO scheduleJob = get(id); quartzManager.deleteJob(ScheduleJobUtils.entityToData(scheduleJob)); } catch (SchedulerException e) { e.printStackTrace(); return 0; } } return taskScheduleJobMapper.batchRemove(ids); } @Override public void initSchedule() throws SchedulerException { // 這里獲取任務(wù)信息數(shù)據(jù) List<TaskDO> jobList = taskScheduleJobMapper.list(new HashMap<String, Object>(16)); for (TaskDO scheduleJob : jobList) { if ("1".equals(scheduleJob.getJobStatus())) { ScheduleJob job = ScheduleJobUtils.entityToData(scheduleJob); quartzManager.addJob(job); } } } @Override public void changeStatus(Long jobId, String cmd) throws SchedulerException { TaskDO scheduleJob = get(jobId); if (scheduleJob == null) { return; } if (Constant.STATUS_RUNNING_STOP.equals(cmd)) { quartzManager.deleteJob(ScheduleJobUtils.entityToData(scheduleJob)); scheduleJob.setJobStatus(ScheduleJob.STATUS_NOT_RUNNING); } else { if (!Constant.STATUS_RUNNING_START.equals(cmd)) { } else { scheduleJob.setJobStatus(ScheduleJob.STATUS_RUNNING); quartzManager.addJob(ScheduleJobUtils.entityToData(scheduleJob)); } } update(scheduleJob); } @Override public void updateCron(Long jobId) throws SchedulerException { TaskDO scheduleJob = get(jobId); if (scheduleJob == null) { return; } if (ScheduleJob.STATUS_RUNNING.equals(scheduleJob.getJobStatus())) { quartzManager.updateJobCron(ScheduleJobUtils.entityToData(scheduleJob)); } update(scheduleJob); } }
啟動(dòng)一個(gè)監(jiān)聽去初始化Quartz
import org.springframework.beans.factory.annotation.Autowired; import org.springframework.boot.CommandLineRunner; import org.springframework.core.annotation.Order; import org.springframework.stereotype.Component; import com.bootdo.common.quartz.utils.QuartzManager; import com.bootdo.common.service.JobService; @Component @Order(value = 1) public class ScheduleJobInitListener implements CommandLineRunner { @Autowired JobService scheduleJobService; @Autowired QuartzManager quartzManager; @Override public void run(String... arg0) throws Exception { try { scheduleJobService.initSchedule(); } catch (Exception e) { e.printStackTrace(); } } }
以上就是本文的全部?jī)?nèi)容,希望對(duì)大家的學(xué)習(xí)有所幫助,也希望大家多多支持腳本之家。
相關(guān)文章
java實(shí)現(xiàn)上傳網(wǎng)絡(luò)圖片到微信臨時(shí)素材
這篇文章主要為大家詳細(xì)介紹了java實(shí)現(xiàn)上傳網(wǎng)絡(luò)圖片到微信臨時(shí)素材,網(wǎng)絡(luò)圖片上傳到微信服務(wù)器,具有一定的參考價(jià)值,感興趣的小伙伴們可以參考一下2018-07-07Spring關(guān)閉Tomcat Servlet容器時(shí)內(nèi)存泄漏問題解決方案
這篇文章主要介紹了Spring關(guān)閉Tomcat Servlet容器時(shí)內(nèi)存泄漏問題解決方案,文中通過示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友可以參考下2019-10-10如何通過自定義spring?invalidator注解校驗(yàn)數(shù)據(jù)合法性
這篇文章主要介紹了如何通過自定義spring?invalidator注解校驗(yàn)數(shù)據(jù)合法性,具有很好的參考價(jià)值,希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方,望不吝賜教2022-07-07使用EasyExcel實(shí)現(xiàn)百萬(wàn)級(jí)別數(shù)據(jù)導(dǎo)出的代碼示例
近期需要開發(fā)一個(gè)將百萬(wàn)數(shù)據(jù)量MySQL8的數(shù)據(jù)導(dǎo)出到excel的功能,所以本文講給大家介紹了基于EasyExcel實(shí)現(xiàn)百萬(wàn)級(jí)別數(shù)據(jù)導(dǎo)出,文中通過代碼示例講解的非常詳細(xì),需要的朋友可以參考下2023-12-12SpringCloud通過Feign傳遞List類型參數(shù)方式
這篇文章主要介紹了SpringCloud通過Feign傳遞List類型參數(shù)方式,具有很好的參考價(jià)值,希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方,望不吝賜教2022-03-03IntelliJ IDEA中Project與Module的概念以及區(qū)別
這篇文章主要給大家介紹了關(guān)于IntelliJ IDEA中Project與Module的概念以及區(qū)別的相關(guān)資料,文中通過實(shí)例介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2021-01-01