SpringBoot教程----整合Quartz
一 背景
1 数据库表的含义:
1.qrtz_blob_triggers : 以Blob 类型存储的触发器。
2.qrtz_calendars:存放日历信息, quartz可配置一个日历来指定一个时间范围。
3.qrtz_cron_triggers:存放cron类型的触发器。
4.qrtz_fired_triggers:存放已触发的触发器。
5.qrtz_job_details:存放一个jobDetail信息。
6.qrtz_job_listeners:job**监听器**。
7.qrtz_locks: 存储程序的悲观锁的信息(假如使用了悲观锁)。
8.qrtz_paused_trigger_graps:存放暂停掉的触发器。
9.qrtz_scheduler_state:调度器状态。
10.qrtz_simple_triggers:简单触发器的信息。
11.qrtz_triggers:触发器的基本信息。
2 Quartz的3个基本要素:
1 Scheduler:调度器。所有的调度都是由它控制。
2 Trigger: 触发器。决定什么时候来执行任务。
3 JobDetail & Job: JobDetail定义的是任务数据,而真正的执行逻辑是在Job中。使用JobDetail + Job而不是Job,这是因为任务是有可能并发执行,如果Scheduler直接使用Job,就会存在对同一个Job实例并发访问的问题。而JobDetail & Job 方式,sheduler每次执行,都会根据JobDetail创建一个新的Job实例,这样就可以规避并发访问的问题。
3 Scheduler Trigger JobDetail & Job 的基本使用
Scheduler 调度程序-任务执行计划表,只有安排进执行计划的任务Job(通过scheduler.scheduleJob方法安排进执行计划),当它预先定义的执行时间到了的时候(任务触发trigger),该任务才会执行。
Scheduler 存放着任务
通过scheduler.scheduleJob 把任务放入Scheduler 中
到达预定时间,任务触发trigger
4 Quartz中常用的API
1 Scheduler - 用于与调度程序交互的主程序接口。
2 Job - 我们预先定义的希望在未来时间能被调度程序执行的任务类。
3 JobDetail - 使用JobDetail来定义定时任务的实例。
4 JobBuilder -用于声明一个任务实例,也可以定义关于该任务的详情比如任务名、组名等,这个声明的实例将会作为一个实际执行的任务。
5 Trigger - 触发器,表明任务在什么时候会执行。定义了一个已经被安排的任务将会在什么时候执行的时间条件,比如上一节的实例的每2秒就执行一次。
6 TriggerBuilder - 触发器创建器,用于创建触发器trigger实例。
1 Scheduler 由 SchedulerFactory创建
2 Job定时任务实例类
JobDataMap // 用于传递数据
getJobDetail // 获取JobDetail详细数据,如用户名、用户名组等
3 Trigger - 触发器 TriggerBuilder 得到的
触发器也有很多属性,这些属性都是在使用TriggerBuilder 定义触发器时设置的。
tiggerKey - 唯一标识触发器,这在一个Scheduler中必须是唯一的
startTime - 定时任务开始时间,通常使用startAt(java.util.Date)
endTime - 定时任务结束时间,设置了结束时间则在这之后,不再触发
JobBuilder用于创建JobDetail;TriggerBuilder 用于创建触发器Trigger;
JobDetail用于定义任务,真正执行任务的是Job 。
一个简单的demo,一看就会
/*静态引入builder*/
import static org.quartz.JobBuilder.newJob;
import static org.quartz.SimpleScheduleBuilder.simpleSchedule;
import static org.quartz.TriggerBuilder.newTrigger;
JobDetail job = newJob(MyJob.class)
.withIdentity("myJob","myJobGroup") // 类似于Id 唯一
.build();
Trigger trigger = newTrigger()
.withIdentity(triggerKey("myTrigger", "myTriggerGroup")) // 类似于Id 唯一
.withSchedule(simpleSchedule()
.withIntervalInHours(1)
.repeatForever()) // 触发器任务执行的时间
.startAt(futureDate(10, MINUTES))
.build();
scheduler.scheduleJob(job, trigger);
// MyJob中定义了具体执行的任务
二 quartz的demo
job.class:具体需要执行定时任务的类
public class myJob implements Job {
@Override
public void execute(JobExecutionContext jobExecutionContext) {
logger.info("Success in execute ");
// 常用的两个方法
// 1 获取具体的job信息
JobDetail jobDetail = jobExecutionContext.getJobDetail();
String jobName = jobDetail.getKey().getName();
String jobGroup = jobDetail.getKey().getGroup();
// 2 获取到存储任务数据(传递数据用)
Map<String, Object> jobParamsMap = jobDetail.getJobDataMap();
String data= (String) jobParamsMap.get("data");
}
}
service.class:具体业务类
//一 实例化JobDetail
JobKey jobKey = JobKey.jobKey("jobName", "jobGroup");
JobDetail jobDetail = JobBuilder.newJob(myJob.class) // 上一步定义的具体的任务
.withIdentity(jobKey) // 定义一个组的名字. jobExecutionContext.getJobDetail();可获取。类似于id
.build();
// 传递数据用,给myJob传递数据用
jobDetail.getJobDataMap().put("data",mydata);
//二 构建一个trigger
//2.1 表达式调度构建器(即任务执行的时间),cronExpression 为具体的时间格式
CronScheduleBuilder scheduleBuilder = CronScheduleBuilder.cronSchedule(cronExpression);
//2.2 构建一个trigger
TriggerKey triggerKey = TriggerKey.triggerKey("trigger_jobName", "trigger_jobGroup");
CronTrigger trigger = TriggerBuilder.newTrigger()
.withIdentity(triggerKey) // 类似于Id的东西
.startNow()
.withSchedule(scheduleBuilder) // 任务执行的时间
.build();
//三 创建任务
scheduler.scheduleJob(jobDetail, trigger);
// 启动
if (!scheduler.isShutdown()) {
scheduler.start();
}
三 quartz的启停demo
// 停止quartz
JobKey jobKey = JobKey.jobKey("jobName", "jobGroup");
scheduler.pauseJob(jobKey);
// 恢复quartz
JobKey jobKey = JobKey.jobKey("jobName", "jobGroup");
scheduler.resumeJob(jobKey);
// 删除quartz
JobKey jobKey = JobKey.jobKey("jobName", "jobGroup");
TriggerKey triggerKey = TriggerKey.triggerKey("trigger_jobName", "trigger_jobGroup");
// 1 停止触发器
scheduler.pauseTrigger(triggerKey);
// 2 移除触发器
scheduler.unscheduleJob(triggerKey);
// 3 删除任务
scheduler.deleteJob(jobKey);
// 更新quartz
TriggerKey triggerKey = TriggerKey.triggerKey("trigger_jobName", "trigger_jobGroup");
//表达式调度构建器(即任务执行的时间)
CronScheduleBuilder scheduleBuilder=CronScheduleBuilder.cronSchedule(cronExpression);
//按新的cronExpression重新构建trigger
CronTrigger trigger = TriggerBuilder.newTrigger()
.withIdentity(triggerKey)
.withSchedule(scheduleBuilder).build();
scheduler.rescheduleJob(triggerKey, trigger);