最近在做项目,有个需求:就是需要定时去执行某一项任务。谈到定时,我第一个想到就是QuartzJob 这个任务调度系统,借此博客,给大家分享一下使用过程中的一些技巧。
引用官网的一段话
Quartz is a richly featured, open source job scheduling library that can be integrated within virtually any Java application - from the smallest stand-alone application to the largest e-commerce system. Quartz can be used to create simple or complex schedules for executing tens, hundreds, or even tens-of-thousands of jobs; jobs whose tasks are defined as standard Java components that may execute virtually anything you may program them to do. The Quartz Scheduler includes many enterprise-class features, such as support for JTA transactions and clustering.
大概意思:quartz是一个功能丰富的开源的任务调用系统,它可以创建简单或者复杂的几十、几百、甚至成千上万的job。此外,quartz调度器还支持JTA事务和集群。(原谅我这蹩脚的翻译)
简单来说,就是可以帮助我们设置一个有规律的或者在某个具体点干点想干的事的一个开源框架。
注:本文使用的quartz版本是2.2.1
导入maven文件:
<dependency>
<groupId>org.quartz-schedulergroupId>
<artifactId>quartzartifactId>
<version>2.2.1version>
dependency>
<dependency>
<groupId>org.quartz-schedulergroupId>
<artifactId>quartz-jobsartifactId>
<version>2.2.1version>
dependency>
废话不多说,码来:
主函数:
package com.perf.Test;
import org.quartz.*;
import org.quartz.impl.StdSchedulerFactory;
/**
* @author cj34920
* Date: 2018/07/18
*/
public class quartzMain {
public static void main(String[] args) {
//定义一个JobDetail
JobDetail jobDetail = JobBuilder.newJob(HelloQuartz.class)
//定义name和group
.withIdentity("job1", "group1")
//job需要传递的内容
.usingJobData("name", "sdas")
.build();
//定义一个Trigger
Trigger trigger = TriggerBuilder.newTrigger().withIdentity("trigger1", "group1")
//加入 scheduler之后立刻执行
.startNow()
//定时 ,每个1秒钟执行一次
.withSchedule(SimpleScheduleBuilder.simpleSchedule().withIntervalInSeconds(1)
//重复执行
.repeatForever()).build();
try {
//创建scheduler
Scheduler scheduler = StdSchedulerFactory.getDefaultScheduler();
scheduler.scheduleJob(jobDetail, trigger);
scheduler.start(); //运行一段时间后关闭
try {
Thread.sleep(6000);
} catch (InterruptedException e) {
e.printStackTrace();
}
scheduler.shutdown();
} catch (
SchedulerException e) {
e.printStackTrace();
}
}
}
HelloQuartz 类:
package com.perf.Test;
import org.quartz.Job;
import org.quartz.JobDetail;
import org.quartz.JobExecutionContext;
import java.util.Date;
/**
* @author cj34920
* Date: 2018/07/18
*/
public class HelloQuartz implements Job {
@Override
public void execute(JobExecutionContext jobExecutionContext) {
JobDetail detail = jobExecutionContext.getJobDetail();
String name = detail.getJobDataMap().getString("name");
System.out.println("my job name is " + name + " at " + new Date());
}
}
scheduler 是quartz的核心所在,所有的任务都是通过scheduler开始。
scheduler是一个接口类,所有的具体实现类都是通过SchedulerFactory工厂类实现,但是SchedulerFactory有两个具体的实现类,如图:
惊奇的发现trigger采用的也是buidler模式-。-(想了解什么事builder模式可以看下我的另外一篇博客https://blog.csdn.net/bicheng4769/article/details/80988996)
这里我只给大家介绍一些常用的方法,其余的可以自己查看文档:
usingJobData(String dataKey, Boolean value) 给具体job传递参数。
举个创建Trigger的例子:
Trigger trigger = TriggerBuilder.newTrigger()
.withIdentity("trigger1", "group1")
.startNow()
.withSchedule(SimpleScheduleBuilder.simpleSchedule().withIntervalInSeconds(1)
.repeatForever()).build();
Trigger的重点内容就是在withSchedule这个方法,从参数开始:查看SchedulerBuilder
,这个是个抽象类
,一共有4种具体实现方法,如图:
比如:现在开始,以后每一个小时执行一次。
Trigger trigger = TriggerBuilder.newTrigger()
.withIdentity("trigger1", "group1")
.startNow()
.withSchedule(SimpleScheduleBuilder.simpleSchedule().withIntervalInHours(1)
.repeatForever()).build();
比如每周一到周四早上9点开始,晚上16点结束,每次执行间隔1 小时。
需要 导入静态方法:import static org.quartz.DailyTimeIntervalScheduleBuilder.dailyTimeIntervalSchedule;
Trigger trigger = TriggerBuilder.newTrigger().withIdentity("trigger1", "group1")
//加入 scheduler之后立刻执行
.startNow()
//定时 ,每个1秒钟执行一次
.withSchedule(dailyTimeIntervalSchedule()
.startingDailyAt(TimeOfDay.hourAndMinuteOfDay(9, 0)) //第天9:00开始
.endingDailyAt(TimeOfDay.hourAndMinuteOfDay(16, 0)) //16:00 结束
.onDaysOfTheWeek(MONDAY,TUESDAY,WEDNESDAY,THURSDAY) //周一至周五执行
.withIntervalInHours(1) //每间隔1小时执行一次
).build();
SimpleScheduleBuilder
类似,都是表示从某一时刻开始,以一定时间间隔执行任务。但是SimpleScheduleBuilder
无法指定一些特殊情况,比如每个月执行一次,每周执行一次、每一年执行一次 Trigger trigger = TriggerBuilder.newTrigger().withIdentity("trigger1", "group1")
//加入 scheduler之后立刻执行
.startNow()
//定时 ,每个1秒钟执行一次
.withSchedule(calendarIntervalSchedule()
.withIntervalInWeeks(1) //每周执行一次
).build();
接下来是最刁的也是最常用的最自由的CronScheduleBuilder
Trigger trigger = TriggerBuilder.newTrigger().withIdentity("trigger1", "group1")
//加入 scheduler之后立刻执行
.startNow()
//定时 ,每个1秒钟执行一次
.withSchedule(cronSchedule("0 0/2 8-17 * * ?") // 每天8:00-17:00,每隔2分钟执行一次
).build();
这没什么 最主要解释写cron表达式,可以自行google。
jobdetail 就是对job的定义,而job是具体执行的逻辑内容。
具体的执行的逻辑需要实现 job类,并实现execute
方法。
这里为什么需要有个JobDetai来作为job的定义,为什么不直接使用job?
解释:如果使用jobdetail来定义,那么每次调度都会创建一个new job实例,这样带来的好处就是任务并发执行的时候,互不干扰,不会对临界资源造成影响。
如何禁止并发执行?
答:项目中出现了一种情况,本来job执行时间只需要10s,但是由于数据库量增大之后,执行时间变成了60s,而我设置的间隔时间是30s,这样就会出现上次任务还没执行完成,下次任务就开始执行了。所以,在这种情况下,我们要禁止quart的并发操作。
2种方式:
id="scheduleJob" class="org.springframework.scheduling.quartz.MethodInvokingJobDetailFactoryBean">
<property name="targetObject" ref="scheduleBusinessObject"/>
<property name="targetMethod" value="doIt"/>
<property name="concurrent" value="false"/>
job类上加上注解@DisallowConcurrentExecution
。
@DisallowConcurrentExecution
public class HelloQuartz implements Job {
@Override
public void execute(JobExecutionContext jobExecutionContext) {
JobDetail detail = jobExecutionContext.getJobDetail();
String name = detail.getJobDataMap().getString("name");
System.out.println("my job name is " + name + " at " + new Date());
}
}
注意:@DisallowConcurrentExecution是对JobDetail实例生效,如果一个job类被不同的jobdetail引用,这样是可以并发执行。
Quartz是一个纯java开发的开源框架,对于java出身的程序员来讲,不管是api还是文档相对还是很友好的,而且使用起来也很方便。其实quartz最主要的几个接口就是 scheduler·、job、jobdetai、Trigger、jobBuilder。其中最主要的还是Trigger,再深一点,最主要的还是cron表达式。下一篇博文的话,给大家介绍如何在spring中使用Quartz。