# Quartz
# Flag
- https://github.com/apache/shardingsphere-elasticjob (opens new window)
- https://github.com/attemper/attemper (opens new window)
# Job的状态与并发
@DisallowConcurrentExecution
同一时间将只有一个Job实例被执行。
如:ReportJob有个实例为ReportForJoe,那么同一时间只有一个ReportForJoe被执行。而ReportForMike等都可以执行。
@PersistJobDataAfterExecution
,在Job被执行结束后,将会更新JobDataMap,这样下次Job执行后就会使用新的值而不是初始值。
如果使用
@PersistJobDataAfterExecution
注解,推荐也使用@DisallowConcurrentExecution
注解,这是为了避免并发问题导致数据紊乱。
public void addJob(Loan loan) {
JobDetail jobDetail1 = JobBuilder.newJob(AutoInvestAfterLoanPassed.class) // 创建builder,(jobDetail的预准备对象)
// 通过builder调用withIdentity()去设置builder的名字和分组,最后通过build()方法获得一个jobDetail对象
.withIdentity(loan.getId(), ScheduleConstants.JobGroup.AUTO_INVEST_AFTER_LOAN_PASSED).build();
jobDetail1.getJobDataMap().put(AutoInvestAfterLoanPassed.LOAN_ID, loan.getId());
// FIXME:需判断DELAY_TIME是否大于0
Date startDate1 = DateUtil.addMinute((loan.getPublishTime() != null ? loan.getPublishTime() : new Date()),
Integer.parseInt(configService.getConfigValue(ConfigConstants.AutoInvest.DELAY_TIME)));
Date enDate = DateUtil.addMonth(new Date(), 3);
// 定义一个触发器trigger对象,用来执行jobDetail
SimpleTrigger trigger1 = TriggerBuilder.newTrigger() //创建一个触发器trigger对象
// 设置触发器的名字和分组
.withIdentity(loan.getId(), ScheduleConstants.TriggerGroup.AUTO_INVEST_AFTER_LOAN_PASSED)
// 设置以哪种方式执行JobDetail:
// 一、SimpleScheduleBuilder 简单任务的重复执行SimpleScheduleBuilder.repeatSecondlyForever(5)
// 二、CronTrigger 按日历触发任务CronScheduleBuilder.cronSchedule("0 17 1 * * ?")
// 以及执行一次JobDetail的间隔时间,以及执行到什么时候
.forJob(jobDetail1)
// 每隔5分钟执行一次,永远重复不限制次数执行,失效之后,再启动马上执行
.withSchedule(SimpleScheduleBuilder.repeatMinutelyForever(1))
//设置触发器开始执行JobDetail的起始时间,还有startNow()立即执行
.startAt(startDate1)
// 结束时间 endAt(“结束的时间”),实现在任务执后自动销毁任务
.endAt(enDate)
// 最终获得一个Trigger对象
.build();
try {
// 调度容器设置JobDetail和Trigger
scheduler.scheduleJob(jobDetail1, trigger1);
// 启动
if (!scheduler.isShutdown()) {
scheduler.start();
}
// 获取触发器状态
TriggerState triggerState = scheduler.getTriggerState(trigger.getKey());
// 判断触发器状态是否为暂停
if (TriggerState.PAUSED.equals(triggerState)) {
// 如果触发器为暂停就恢复启动
scheduler.resumeTrigger(trigger.getKey());
}
if (log.isDebugEnabled()){
log.debug("添加调度成功,时间:{}", DateUtil.DateToString(startDate1, DateStyle.YYYY_MM_DD_HH_MM_SS_CN));
}
} catch (SchedulerException e) {
throw e;
}
}
首先从Scheduler.scheduleJob(JobDetail jobDetail,Trigger trigger)调度job, 实际上就是将job存储到RAM中的jobsByGroup, jobsByKey对应的Map中,将触发器存储到触发器(List),triggersByKey,triggersByGroup对应的Map中,及timeTriggers的Treeset中
Scheduler.unscheduleJob(TriggerKey triggerKey)就是将triggerKey从triggersByKey,triggersByGroup,triggers,timeTriggers中移除;
Scheduler.deleteJob(JobKey jobKey)除了从容器触发中的TriggerWrapper的JobKey为jobKey的列表
<TriggerWrapper>
, 并uncheduleJob(TriggerKey triggerKey)列表列表<TriggerWrapper>
中的所有TriggerWrapper,同时从jobsByKey,jobsByGroup 的移除对应jobKey的相关信息
# Quartz的Misfire处理规则
调度(scheduleJob)或恢复调度(resumeTrigger,resumeJob)后不同的misfire对应的处理规则
CronTrigger
withMisfireHandlingInstructionDoNothing
——不触发立即执行
——等待下次Cron触发频率到达时刻开始按照Cron频率依次执行
withMisfireHandlingInstructionIgnoreMisfires
——以错过的第一个频率时间立刻开始执行
——重做错过的所有频率周期后
——当下一次触发频率发生时间大于当前时间后,再按照正常的Cron频率依次执行
withMisfireHandlingInstructionFireAndProceed
——以当前时间为触发频率立刻触发一次执行
——然后按照Cron频率依次执行
SimpleTrigger
withMisfireHandlingInstructionFireNow
——以当前时间为触发频率立即触发执行
——执行至FinalTIme的剩余周期次数
——以调度或恢复调度的时刻为基准的周期频率,FinalTime根据剩余次数和当前时间计算得到
——调整后的FinalTime会略大于根据starttime计算的到的FinalTime值
withMisfireHandlingInstructionIgnoreMisfires
——以错过的第一个频率时间立刻开始执行
——重做错过的所有频率周期
——当下一次触发频率发生时间大于当前时间以后,按照Interval的依次执行剩下的频率
——共执行RepeatCount+1次
withMisfireHandlingInstructionNextWithExistingCount
——不触发立即执行
——等待下次触发频率周期时刻,执行至FinalTime的剩余周期次数
——以startTime为基准计算周期频率,并得到FinalTime
——即使中间出现pause,resume以后保持FinalTime时间不变
withMisfireHandlingInstructionNowWithExistingCount
——以当前时间为触发频率立即触发执行
——执行至FinalTIme的剩余周期次数
——以调度或恢复调度的时刻为基准的周期频率,FinalTime根据剩余次数和当前时间计算得到
——调整后的FinalTime会略大于根据starttime计算的到的FinalTime值
withMisfireHandlingInstructionNextWithRemainingCount
——不触发立即执行
——等待下次触发频率周期时刻,执行至FinalTime的剩余周期次数
——以startTime为基准计算周期频率,并得到FinalTime
——即使中间出现pause,resume以后保持FinalTime时间不变
withMisfireHandlingInstructionNowWithRemainingCount
——以当前时间为触发频率立即触发执行
——执行至FinalTIme的剩余周期次数
——以调度或恢复调度的时刻为基准的周期频率,FinalTime根据剩余次数和当前时间计算得到
——调整后的FinalTime会略大于根据starttime计算的到的FinalTime值
MISFIRE_INSTRUCTION_RESCHEDULE_NOW_WITH_REMAINING_REPEAT_COUNT
——此指令导致trigger忘记原始设置的starttime和repeat-count
——触发器的repeat-count将被设置为剩余的次数
——这样会导致后面无法获得原始设定的starttime和repeat-count值
# QuartzAPI
参考:https://blog.csdn.net/QXC1281/article/details/68924140
核心接口有
- Scheduler – (调度器)与scheduler交互的主要API;
- Job – (作业)你通过scheduler执行任务,你的任务类需要实现的接口;
- JobDetail – (作业实例)定义Job的实例;
- Trigger – (触发器)触发Job的执行;
- JobBuilder – 定义和创建JobDetail实例的接口;
- TriggerBuilder – 定义和创建Trigger实例的接口;
# 触发器接口基本介绍
Trigger触发器方法介绍
// 触发器状态
TriggerState
|-public enum TriggerState { NONE, NORMAL, PAUSED, COMPLETE, ERROR, BLOCKED }
|-NONE 无
|-NORMAL 正常状态
|-PAUSED 暂停状态
|-COMPLETE 完成
|-ERROR 错误
|-BLOCKED 堵塞
// 执行完成时状态
CompletedExecutionInstruction
|- public enum CompletedExecutionInstruction {
NOOP, RE_EXECUTE_JOB, SET_TRIGGER_COMPLETE, DELETE_TRIGGER,
SET_ALL_JOB_TRIGGERS_COMPLETE, SET_TRIGGER_ERROR, SET_ALL_JOB_TRIGGERS_ERROR }
|-NOOP 无
|-RE_EXECUTE_JOB 重复执行
|-SET_TRIGGER_COMPLETE 触发器执行完成
|-DELETE_TRIGGER 删除触发器
|-SET_ALL_JOB_TRIGGERS_COMPLETE 所有作业和触发器执行完成
|-SET_TRIGGER_ERROR 触发器执行错误
|-SET_ALL_JOB_TRIGGERS_ERROR 设置所有都是错误的
TriggerTimeComparator
getKey 获取触发器key值
getJobKey 获取作业key
getDescription 获取面熟
getCalendarName 获取日历名称
getJobDataMap 获取作业数据map
getPriority 获取优先级
mayFireAgain 是否重复执行
getStartTime 开始时间
getEndTime 结束时间
getNextFireTime 下一次执行时间
getPreviousFireTime 上一执行时间
getFireTimeAfter(Date afterTime) 获取某个时间后的运行时间
getFinalFireTime 获取最后执行时间
getMisfireInstruction 获取失败策略
getTriggerBuilder 获取触发器建造者
getScheduleBuilder 获取调度类建造者
equals
compareTo
// 失败策略
MISFIRE_INSTRUCTION_SMART_POLICY
MISFIRE_INSTRUCTION_IGNORE_MISFIRE_POLICY
DEFAULT_PRIORITY
# 触发器实现类
Trigger (org.quartz)
|-CalendarIntervalTrigger (org.quartz) 日期触发器
| |-CalendarIntervalTriggerImpl (org.quartz.impl.triggers)
|-MutableTrigger (org.quartz.spi)
| |-OperableTrigger (org.quartz.spi)
| |-AbstractTrigger (org.quartz.impl.triggers)
| |-CalendarIntervalTriggerImpl (org.quartz.impl.triggers)
| |-SimpleTriggerImpl (org.quartz.impl.triggers)
| |-DailyTimeIntervalTriggerImpl (org.quartz.impl.triggers)
| |-CronTriggerImpl (org.quartz.impl.triggers)
|-SimpleTrigger (org.quartz) 简单触发器
| |-SimpleTriggerImpl (org.quartz.impl.triggers)
|-CoreTrigger (org.quartz.impl.triggers)
| |-CalendarIntervalTriggerImpl (org.quartz.impl.triggers)
| |-SimpleTriggerImpl (org.quartz.impl.triggers)
| |-DailyTimeIntervalTriggerImpl (org.quartz.impl.triggers)
| |-CronTriggerImpl (org.quartz.impl.triggers)
|-CronTrigger (org.quartz) cron表达式
| |-CronTriggerImpl (org.quartz.impl.triggers)
|-DailyTimeIntervalTrigger (org.quartz)日期触发类(日)
|-DailyTimeIntervalTriggerImpl (org.quartz.impl.triggers)
- 常用
- SimpleTrigger :简单触发器
- CalendarIntervalTrigger:日历触发器
- CronTrigger:Cron表达式触发器
- DailyTimeIntervalTrigger:日期触发器
# 调度器建造者
// 用于创建各个调度器
ScheduleBuilder (org.quartz)
|-CalendarIntervalScheduleBuilder (org.quartz)
|-DailyTimeIntervalScheduleBuilder (org.quartz)
|-SimpleScheduleBuilder (org.quartz)
|-CronScheduleBuilder (org.quartz)
# 触发器建造者
简单触发器器源码分析,利用了建造者模式
private TriggerBuilder() 构造函数私有
public static TriggerBuilder<Trigger> newTrigger() 创建一个建造者
build() 创建触发器
// 根据name和默认的group(即"DEFAULT_GROUP")创建trigger的key
public TriggerBuilder<T> withIdentity(String name)
public TriggerBuilder<T> withIdentity(String name, String group)
public TriggerBuilder<T> withIdentity(TriggerKey triggerKey)
public TriggerBuilder<T> withDescription(String triggerDescription) 描述
public TriggerBuilder<T> withPriority(int triggerPriority) 优先级
public TriggerBuilder<T> modifiedByCalendar(String calName) 日期
public TriggerBuilder<T> startAt(Date triggerStartTime) 开始时间
public TriggerBuilder<T> startNow() 立即执行
public TriggerBuilder<T> endAt(Date triggerEndTime) 结束时间
public <SBT extends T> TriggerBuilder<SBT> withSchedule(ScheduleBuilder<SBT> schedBuilder) 调度器
public TriggerBuilder<T> forJob(JobKey keyOfJobToFire) 设置作业
public TriggerBuilder<T> forJob(String jobName)
public TriggerBuilder<T> forJob(String jobName, String jobGroup)
public TriggerBuilder<T> forJob(JobDetail jobDetail)
usingJobData(----,----) 设置作业内容
key
description
startTime
endTime
priority Trigger.DEFAULT_PRIORITY
calendarName
jobKey
jobDataMap
scheduleBuilder
# SimpleTrigger简单触发器
简单调度器建造者
//构造函数私有化
protected SimpleScheduleBuilder()
//获取简单调度器
public static SimpleScheduleBuilder simpleSchedule()
/***********************/
// 1分钟执行(一直执行)
public static SimpleScheduleBuilder repeatMinutelyForever()
//每隔几分钟执行(一直执行)
public static SimpleScheduleBuilder repeatMinutelyForever(int minutes)
// 1秒执行(一直执行)
public static SimpleScheduleBuilder repeatSecondlyForever()
//每隔几秒钟执行(一直执行)
public static SimpleScheduleBuilder repeatSecondlyForever(int seconds)
// 1小时执行(一直执行)
public static SimpleScheduleBuilder repeatHourlyForever()
//每隔几小时钟执行(一直执行)
public static SimpleScheduleBuilder repeatHourlyForever(int hours)
/***********************/
//间隔时间为1分钟,总的执行次数为count
public static SimpleScheduleBuilder repeatMinutelyForTotalCount(int count)
//间隔时间为几分钟,总的执行次数为count .............
public static SimpleScheduleBuilder repeatMinutelyForTotalCount(int count, int minutes)
public static SimpleScheduleBuilder repeatSecondlyForTotalCount(int count)
public static SimpleScheduleBuilder repeatSecondlyForTotalCount(int count, int seconds)
public static SimpleScheduleBuilder repeatHourlyForTotalCount(int count)
public static SimpleScheduleBuilder repeatHourlyForTotalCount(int count, int hours)
/***********************/
public MutableTrigger build() 创建一个Trigger
/***********************/
// 几秒钟重复执行
public SimpleScheduleBuilder withIntervalInMilliseconds(long intervalInMillis)
public SimpleScheduleBuilder withIntervalInSeconds(int intervalInSeconds)
public SimpleScheduleBuilder withIntervalInMinutes(int intervalInMinutes)
public SimpleScheduleBuilder withIntervalInHours(int intervalInHours)
/***********************/
// 重复执行册数
public SimpleScheduleBuilder withRepeatCount(int triggerRepeatCount)
/***********************/
参考地址
http://blog.sina.com.cn/s/blog_56d8ea900101eu45.html
//以错过的第一个频率时间立刻开始执行
//重做错过的所有频率周期后
//当下一次触发频率发生时间大于当前时间后,再按照正常的Cron频率依次执行
public SimpleScheduleBuilder withMisfireHandlingInstructionIgnoreMisfires()
//以当前时间为触发频率立即触发执行
//执行至FinalTIme的剩余周期次数
//以调度或恢复调度的时刻为基准的周期频率,FinalTime根据剩余次数和当前时间计算得到
//调整后的FinalTime会略大于根据starttime计算的到的FinalTime值
public SimpleScheduleBuilder withMisfireHandlingInstructionFireNow()
//不触发立即执行
//等待下次触发频率周期时刻,执行至FinalTime的剩余周期次数
//以startTime为基准计算周期频率,并得到FinalTime
//即使中间出现pause,resume以后保持FinalTime时间不变
public SimpleScheduleBuilder withMisfireHandlingInstructionNextWithExistingCount()
//不触发立即执行
//等待下次触发频率周期时刻,执行至FinalTime的剩余周期次数
//以startTime为基准计算周期频率,并得到FinalTime
//即使中间出现pause,resume以后保持FinalTime时间不变
public SimpleScheduleBuilder withMisfireHandlingInstructionNextWithRemainingCount()
//以当前时间为触发频率立即触发执行
//执行至FinalTIme的剩余周期次数
//以调度或恢复调度的时刻为基准的周期频率,FinalTime根据剩余次数和当前时间计算得到
//调整后的FinalTime会略大于根据starttime计算的到的FinalTime值
public SimpleScheduleBuilder withMisfireHandlingInstructionNowWithExistingCount()
//以当前时间为触发频率立即触发执行
//执行至FinalTIme的剩余周期次数
//以调度或恢复调度的时刻为基准的周期频率,FinalTime根据剩余次数和当前时间计算得到
public SimpleScheduleBuilder withMisfireHandlingInstructionNowWithRemainingCount()
interval 时间间隔
repeatCount 重复时间
misfireInstruction
SimpleTrigger
public class SimpleTriggerMain {
public static void main(String[] args) throws SchedulerException {
// 获取一个调度工厂
SchedulerFactory schedFact = new org.quartz.impl.StdSchedulerFactory();
// 获取一个调度器
Scheduler sched = schedFact.getScheduler();
SimpleDateFormat sdf = new SimpleDateFormat("yyyy-MM-dd hh:mm:ss");
JobDetail job = JobBuilder.newJob(HelloJob.class).withIdentity("job1", "group1").build();
// 在当前时间15秒后运行
Date startTime = DateBuilder.nextGivenSecondDate(new Date( ),15);
// 创建一个SimpleTrigger实例,指定该Trigger在Scheduler中所属组及名称。
// 接着设置调度的时间规则.当前时间15秒后运行,每10秒运行一次,共运行5次
SimpleTrigger trigger = (SimpleTrigger) TriggerBuilder.newTrigger().withIdentity("trigger1", "group1")
.startAt(startTime).withSchedule(SimpleScheduleBuilder.simpleSchedule()
.withIntervalInSeconds(10)
.withRepeatCount(5)
)
.build();
sched.scheduleJob(job, trigger);
// 调度启动
sched.start();
}
}
# CronTriger-Cron触发器
Cron调度器建造者
// 构造函数私有化
protected CronScheduleBuilder(CronExpression cronExpression)
public MutableTrigger build()
// 根据cron表达式建造
public static CronScheduleBuilder cronSchedule(String cronExpression)
// 核查表达式是否正确
public static CronScheduleBuilder cronScheduleNonvalidatedExpression(
String cronExpression) throws ParseException
//表达式异常
cronScheduleNoParseException
// 利用CronExpression建造
public static CronScheduleBuilder cronSchedule(CronExpression cronExpression)
//每天在指定的时间执行,根据这个调度创建一个cron表达式
public static CronScheduleBuilder dailyAtHourAndMinute(int hour, int minute)
// 通过`分钟`、`小时`、`周`创建一个CronScheduleBuilder实例,即在某一天的给定时刻
// (通过`分钟`、`小时`指定)执行,,而天数由`周`确定,如果“周二、周四的10:05“等;
public static CronScheduleBuilder atHourAndMinuteOnGivenDaysOfWeek(
int hour, int minute, Integer... daysOfWeek)
//调度计划:每周的某一天,在指定的时间(小时和分钟)执行
public static CronScheduleBuilder weeklyOnDayAndHourAndMinute(
int dayOfWeek, int hour, int minute)
//调度计划:每月的某一天,在指定的时间(小时和分钟)执行
public static CronScheduleBuilder monthlyOnDayAndHourAndMinute(
int dayOfMonth, int hour, int minute)
//设置时区
public CronScheduleBuilder inTimeZone(TimeZone timezone)
// 设置处理办法
public CronScheduleBuilder withMisfireHandlingInstructionIgnoreMisfires()
public CronScheduleBuilder withMisfireHandlingInstructionDoNothing()
public CronScheduleBuilder withMisfireHandlingInstructionFireAndProceed()
cronExpression
misfireInstruction
Cron应用
public class CronTriggerMain {
public static void main(String[] args) throws SchedulerException {
SchedulerFactory schedFact = new org.quartz.impl.StdSchedulerFactory();
// 获取一个调度器
Scheduler sched = schedFact.getScheduler();
JobDetail job = JobBuilder.newJob(HelloJob.class).withIdentity("job1", "group1").build();
// 每两秒执行
CronTrigger trigger = TriggerBuilder.newTrigger().withIdentity("trigger1", "group1").withSchedule(
CronScheduleBuilder.cronSchedule("/2 * * * * ?")
).build();
sched.scheduleJob(job, trigger);
// 调度启动
sched.start();
}
}
# DailyTimeIntervalTrigger-日期触发
DailyTime调度器建造者
// 建造者模式
DailyTimeIntervalScheduleBuilder
dailyTimeIntervalSchedule
build
//执行时间间隔触发执行,unit时间单位
public DailyTimeIntervalScheduleBuilder withInterval(int timeInterval, IntervalUnit unit)
//秒
withIntervalInSeconds
//分钟
withIntervalInMinutes
//小时
withIntervalInHours
// 周几执行
public DailyTimeIntervalScheduleBuilder onDaysOfTheWeek(Integer … onDaysOfWeek)
onDaysOfTheWeek
onMondayThroughFriday
onSaturdayAndSunday
onEveryDay
// 开始触发时间
startingDailyAt
//结束时间
endingDailyAt
//支持次数
endingDailyAfterCount
withMisfireHandlingInstructionIgnoreMisfires
withMisfireHandlingInstructionDoNothing
withMisfireHandlingInstructionFireAndProceed
//重复次数
withRepeatCount
validateInterval
// 常量等
interval
intervalUnit
daysOfWeek
startTimeOfDay
endTimeOfDay
repeatCount
misfireInstruction
ALL_DAYS_OF_THE_WEEK
MONDAY_THROUGH_FRIDAY
SATURDAY_AND_SUNDAY
应用
public class DailyTimeIntervalTriggerMain {
public static void main(String[] args) throws SchedulerException {
SchedulerFactory schedFact = new org.quartz.impl.StdSchedulerFactory();
// 获取一个调度器
Scheduler sched = schedFact.getScheduler();
JobDetail job = JobBuilder.newJob(HelloJob.class).withIdentity("job1", "group1").build();
// 每两秒执行
DailyTimeIntervalTrigger trigger = TriggerBuilder.newTrigger().withIdentity("trigger1", "group1").withSchedule(
DailyTimeIntervalScheduleBuilder.dailyTimeIntervalSchedule().withInterval(2, DateBuilder.IntervalUnit.SECOND)
).build();
sched.scheduleJob(job, trigger);
// 调度启动
sched.start();
}
}
# CalendarIntervalTrigger-日历触发
Calendar调度器建造者
CalendarIntervalScheduleBuilder
calendarIntervalSchedule
build
// 和DailyTimeIntervalScheduleBuilder差不多
public CalendarIntervalScheduleBuilder withInterval(int timeInterval, IntervalUnit unit)
withIntervalInSeconds
withIntervalInMinutes
withIntervalInHours
withIntervalInDays
withIntervalInWeeks
withIntervalInMonths
withIntervalInYears
withMisfireHandlingInstructionIgnoreMisfires
withMisfireHandlingInstructionDoNothing
withMisfireHandlingInstructionFireAndProceed
inTimeZone
preserveHourOfDayAcrossDaylightSavings
skipDayIfHourDoesNotExist
validateInterval
interval
intervalUnit
misfireInstruction
timeZone
preserveHourOfDayAcrossDaylightSavings
skipDayIfHourDoesNotExist
应用
public class CalendarIntervalMain {
public static void main(String[] args) throws SchedulerException {
SchedulerFactory schedFact = new StdSchedulerFactory();
// 获取一个调度器
Scheduler sched = schedFact.getScheduler();
JobDetail job = JobBuilder.newJob(HelloJob.class).withIdentity("job1", "group1").build();
// 每两秒执行
CalendarIntervalTrigger trigger = TriggerBuilder.newTrigger().withIdentity("trigger1", "group1").withSchedule(
CalendarIntervalScheduleBuilder.calendarIntervalSchedule().withInterval(2, DateBuilder.IntervalUnit.SECOND)
).build();
sched.scheduleJob(job, trigger);
// 调度启动
sched.start();
}
}