参考链接: http://www.quartz-scheduler.org/documentation/quartz-2.2.x/tutorials/tutorial-lesson-01.html
一、预热
简单、直接、粗暴一点,上一段code snippet吧:
// 摘自官方文档
SchedulerFactory schedFact = new org.quartz.impl.StdSchedulerFactory();
Scheduler sched = schedFact.getScheduler();
sched.start();
// define the job and tie it to our HelloJob class
JobDetail job = newJob(HelloJob.class)
.withIdentity("myJob", "group1")
.build();
// Trigger the job to run now, and then every 40 seconds
Trigger trigger = newTrigger()
.withIdentity("myTrigger", "group1")
.startNow()
.withSchedule(simpleSchedule()
.withIntervalInSeconds(40)
.repeatForever())
.build();
// Tell quartz to schedule the job using our trigger
sched.scheduleJob(job, trigger);
在使用调度器(scheduler)之前,调度器(scheduler)需要被实例化(instantiated),可以使用SchedulerFactory去实例化一个。在使用时,将scheduler instance of a factory保存到JNDI, 或者像上面代码的例子一样,直接使用SchedulerFactory创建一个scheduler instance。
一旦scheduler被实例化后,就可以立马start、shutdown,scheduler启动以后,就可以使用Trigger去运行一个Job。
二、quartz api
quartz里主要的几个interface:
- Scheduler: 调度器
- Job: 调度器要去执行的具体任务组件
- JobDetail: 定义Job instances
- Trigger: 触发器,触发Job执行
- JobBuilder: 负责创建JobDetail instances
- TriggerBuilder: 负责创建Trigger instances
// define the job and tie it to our HelloJob class
JobDetail job = newJob(HelloJob.class)
.withIdentity("myJob", "group1") // name "myJob", group "group1"
.build();
// Trigger the job to run now, and then every 40 seconds
Trigger trigger = newTrigger()
.withIdentity("myTrigger", "group1")
.startNow()
.withSchedule(simpleSchedule()
.withIntervalInSeconds(40)
.repeatForever())
.build();
// Tell quartz to schedule the job using our trigger
sched.scheduleJob(job, trigger);
上面的代码中使用的有些方法是通过静态导入的,JobBuilder导入了new Job()
, TriggerBuilder导入new Trigger()
, SimpleScheduleBuilder导入simpleSchedule()
。
这些静态方法可以通过如下的statements导入:
import static org.quartz.JobBuilder.*;
import static org.quartz.SimpleScheduleBuilder.*;
import static org.quartz.CronScheduleBuilder.*;
import static org.quartz.CalendarIntervalScheduleBuilder.*;
import static org.quartz.TriggerBuilder.*;
import static org.quartz.DateBuilder.*;
不同的SchedulerBuilder
类代表不同功能类型的调度器。
DateBuilder
里面有很多方法可以构造出特殊时间点的java.util.Date
。
Jobs and Triggers
定义具体的任务执行时, 需要implements Job
interface 的一个方法execute
//the job interface
package org.quartz;
public interface Job {
public void execute(JobExecutionContext context)
throws JobExecutionException;
}
当和Job绑定的Trigger执行时,scheduler里的一个工作线程就会去执行execute()
里的具体任务方法,JobExecutionContext
里保存着Job运行的上下文信息。
JobDetail
JobDetail 包含了Job运行的各种属性,就是JobDataMap
。JobDataMap
保存着Job运行的状态信息。
Trigger
Trigger触发Job的执行,在Trigger里定义调度信息(Scheduling),Trigger也有一个JobDataMap
,传递参数给和Trigger绑定的Job。quartz 里有很多可以直接使用的Trigger类型,比较常用的是
SimpleTrigger
和 CronTrigger
。
SimpleTrigger
触发Job只执行一次,或者在一个特定的时间触发Job, 重复执行n次,在执行的过程中可以有滞留。
CronTrigger
根据日历去触发Job,比如每天的14:00执行一次Job。
具体执行的Job和Trigger是分开的,这样的好处是:
1、Jobs可以在调度器(scheduler)里创建并保存,而且也和Trigger独立开来,这样多个Trigger可以绑定到一个Job;
2、对于Job的配置是松耦合的,当Trigger触发一个任务后过期后,不用重新去定义Job和Trigger,等待scheduler再次调度就可以再次执行。可以自由更新和替换Trigger,而不用去重新定义Job。 这样对于我们代码中去管理Jobs和Triggers提供了很多方便。
Identities
Jobs和Triggers 在注册到Quartz scheduler时都被赋予了 标识键(identifying keys
) 。通过这些JobKey
和 TriggerKey
可以将Jobs和Triggers进行分组,比如系统中专门 同步数据的job、数据统计的job。一个完整的标识键是 name
和group
的组合,在scheduler中必须是唯一的。