一、简单介绍
Quartz 是一个完全由 Java 编写的开源作业调度框架,可以由少量的代码实现较为复杂的功能。
Springboot内置的task虽然也可以实现定时任务,但是它默认单线程,虽然可以通过配置实现多线程,但是功能略显单薄。
Quartz有着强大的任务管理功能,可以在运行时进行任务的开启、关闭、修改任务执行时间等。
二、开发
2.1 依赖引入
<dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-quartz</artifactId>
</dependency>
2.2 配置文件
spring:main:banner-mode: offquartz:job-store-type: memoryscheduler-name: smile-schedulerproperties:org:quartz:jobStore:threadPool:# 线程个数threadCount: 10
注:如需将job信息持久化到db,可参考官方文档进行配置
2.3 实现Job
/*** 定时任务demo* - @DisallowConcurrentExecution 当前任务未执行完前不会执行新的任务* @author smile*/
@Slf4j
@DisallowConcurrentExecution
public class QuartzDemoJob extends QuartzJobBean {@Overrideprotected void executeInternal(JobExecutionContext jobExecutionContext) throws JobExecutionException {// todo something log.info("!!!开始执行--测试定时任务");}
}
2.4 工具类
/*** quartz任务管理* - Group统一使用quartz默认的组* @author smile*/
@Component
public class QuartzUtils {@Autowiredprivate Scheduler scheduler;/*** 添加任务--SimpleScheduler* @param jobClass jobClass* @param taskName jobName、triggerName使用同一个name* @param intervalTime 间隔时间, 单位:秒*/public void addSingleJob(Class<? extends Job> jobClass, String taskName, int intervalTime) throws SchedulerException {JobDetail jobDetail = JobBuilder.newJob(jobClass).withIdentity(taskName).build();SimpleScheduleBuilder simpleScheduler = SimpleScheduleBuilder.simpleSchedule().withMisfireHandlingInstructionNextWithRemainingCount();Trigger trigger = TriggerBuilder.newTrigger().startAt(new Date(System.currentTimeMillis() + 1000 * 10)).withIdentity(taskName).withSchedule(simpleScheduler.withIntervalInSeconds(intervalTime).repeatForever()).build();scheduler.scheduleJob(jobDetail, trigger);}/*** 添加任务--cron* @param jobClass jobClass* @param taskName jobName、triggerName使用同一个name* @param cron cron定时任务规则*/public void addCronJob(Class<? extends Job> jobClass, String taskName, String cron) throws SchedulerException {JobDetail jobDetail = JobBuilder.newJob(jobClass).withIdentity(taskName).build();CronScheduleBuilder cronScheduler = CronScheduleBuilder.cronSchedule(cron).withMisfireHandlingInstructionDoNothing();Trigger trigger = TriggerBuilder.newTrigger().startNow().withIdentity(taskName).withSchedule(cronScheduler).build();scheduler.scheduleJob(jobDetail, trigger);}/*** 修改cron规则*/public void modifyCron(String taskName, String cron) throws SchedulerException {TriggerKey triggerKey = TriggerKey.triggerKey(taskName);CronTrigger trigger = (CronTrigger) scheduler.getTrigger(triggerKey);String oldTime = trigger.getCronExpression();if(!oldTime.equalsIgnoreCase(cron)){CronScheduleBuilder cronBuilder = CronScheduleBuilder.cronSchedule(cron);TriggerBuilder<Trigger> triggerBuilder = TriggerBuilder.newTrigger();triggerBuilder.withIdentity(taskName).startNow().withSchedule(cronBuilder);trigger = (CronTrigger) triggerBuilder.build();scheduler.rescheduleJob(triggerKey, trigger);}}/*** 删除任务*/public void delJob(String taskName) throws SchedulerException {TriggerKey triggerKey = TriggerKey.triggerKey(taskName);JobKey jobKey = JobKey.jobKey(taskName);scheduler.pauseTrigger(triggerKey);scheduler.unscheduleJob(triggerKey);scheduler.deleteJob(jobKey);}
}
2.5 初始化定时任务
/*** 初始化定时任务* @author smile*/
@Component
public class QuartzJobInit implements CommandLineRunner {@Autowiredprivate QuartzUtils quartzUtils;@Overridepublic void run(String... args) throws Exception {// 每十秒执行一次quartzUtils.addSingleJob(QuartzDemoJob.class, "demo-job", 10);}
}
2.6 源码地址
https://github.com/lysmile/spring-boot-demo/tree/master/spring-boot-quartz-demo
附:Crontab实例
# 每分钟的第0秒执行
0 */1 * * * ?
# 每隔5秒执行一次
*/5 * * * * ?
# 每天23:00:00执行
0 0 23 * * ?
# 每天凌晨1点执行
0 0 1 * * ?
# 每月1号凌晨0点执行
0 0 0 1 * ?
# 每月最后一天23点执行一次
0 0 23 L * ?
# 每周的星期天凌晨0点实行一次
0 0 0 ? * 1
# 每个小时的10分、20分、30分分别执行一次
0 10,20,30 * * * ?
# 每天的0点、1点、2点分别执行
0 0 0,1,2 * * ?