您的位置: 首页  >  文章  >  一文让你深入学习quartz

一文让你深入学习quartz

分类: 文章 • 2025-04-24 09:25:10

前言

       我们会经常用到定时任务，比如每天凌晨生成前天报表，每一小时生成汇总数据，发送通知等等。换句话说就是在某一个有规律的时间点干某件事。并且时间的触发的条件可以非常复杂（比如每月最后一个工作日的17:50），复杂到需要一个专门的框架来干这个事。

Quartz就是来干这样的事，你给它一个触发条件的定义，它负责到了时间点，触发相应的Job起来干活。

       这种情况下使用Quartz框架无疑是非常好的选择，并且与Spring可以非常方便的集成。

几种任务调度

  • Timer，简单无门槛，一般也没人用。
  • spring @Scheduled注解，一般集成于项目中，小任务很方便。
  • 开源工具 Quartz，分布式集群开源工具，以下两个分布式任务都是基于Quartz实现。
  • 分布式任务 XXL-JOB，是一个轻量级分布式任务调度框架，支持通过 Web 页面对任务进行 CRUD 操作，支持动态修改任务状态、暂停/恢复任务，以及终止运行中任务，支持在线配置调度任务入参和在线查看调度结果。
  • 分布式任务 Elastic-Job，是一个分布式调度解决方案，由两个相互独立的子项目 Elastic-Job-Lite 和 Elastic-Job-Cloud 组成。定位为轻量级无中心化解决方案，使用 jar 包的形式提供分布式任务的协调服务。支持分布式调度协调、弹性扩容缩容、失效转移、错过执行作业重触发、并行调度、自诊。
  • 分布式任务 Saturn，Saturn是唯品会在github开源的一款分布式任务调度产品。它是基于当当elastic-job来开发的，其上完善了一些功能和添加了一些新的feature。其在唯品会内部已经发部署350+个节点，每天任务调度4000多万次。同时，管理和统计也是它的亮点。

quart的介绍

  • Scheduler：任务调度器，所有的任务都是从这里开始。
  • Trigger：触发器，定义任务执行的方式、间隔。
  • JobDetail & Job ： 定义任务具体执行的逻辑。

Scheduler

          scheduler 是quartz的核心所在，所有的任务都是通过scheduler开始。Scheduler的生命期，从SchedulerFactory创建它时开始，到Scheduler调用shutdown()方法时结束；Scheduler被创建后，可以增加、删除和列举Job和Trigger，以及执行其它与调度相关的操作（如暂停Trigger）。但是，Scheduler只有在调用start()方法后，才会真正地触发trigger（即执行job）。

一文让你深入学习quartz

scheduler是一个接口类，所有的具体实现类都是通过SchedulerFactory工厂类实现，但是SchedulerFactory有两个具体的实现类：
          StdSchedulerFactory：默认值加载是当前工作目录下的”quartz.properties”属性文件。如果加载失败，会去加载org/quartz包下的”quartz.properties”属性文件。一般使用这个实现类就能满足我们的要求。
          DirectSchedulerFactory：是为那些想绝对控制 Scheduler 实例是如何生产出的人所设计的。

一文让你深入学习quartz

Trigger

withIdentity() 给触发器一些属性 比如名字，组名。

startNow() 立刻启动

withSchedule(ScheduleBuilder schedBuilder) 以某种触发器触发。

usingJobData(String dataKey, Boolean value) 给具体job传递参数。

举个创建Trigger的例子：

Trigger trigger = TriggerBuilder.newTrigger()
.withIdentity("trigger1", "group1")
.startNow()
.withSchedule(SimpleScheduleBuilder.simpleSchedule()).withIntervalInSeconds(1)

.repeatForever()).build();

Calendar用于从trigger的调度计划中排除时间段。比如，可以创建一个trigger，每个工作日的上午9:30执行，然后增加一个Calendar，排除掉所有的商业节日。

一文让你深入学习quartz

一文让你深入学习quartz

SimpleScheduleBuilder 
最简单的触发器，表示从某一时刻开始，以一定的时间间隔执行任务。 
属性： 
repeatInterval 重复间隔。
repeatCount 重复次数。
比如：现在开始，以后每一个小时执行一次。

Trigger trigger = TriggerBuilder.newTrigger()
                 .withIdentity("trigger1", "group1")
                 .startNow()
                 .withSchedule(SimpleScheduleBuilder.simpleSchedule()

                  .withIntervalInHours(1)
                 .repeatForever()).build();

一文让你深入学习quartz

DailyTimeIntervalScheduleBuilder 
每一天的某一个时间段内，以一定的时间间隔执行任务，可以指定具体的某一天（星期一、星期二、星期三。。） 
属性： 
intervalUnit 重复间隔（秒、分钟、小时。。。）。
daysOfWeek 具体的星期。 默认 周一到周日
startTimeOfDay 每天开始时间 默认 0.0
endTimeOfDay 每天结束时间，默认 23.59.59
repeatCount 重复次数。 默认是-1 不限次数
interval 每次执行间隔
比如每周一到周四早上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();

CalendarIntervalScheduleBuilder 
和SimpleScheduleBuilder类似，都是表示从某一时刻开始，以一定时间间隔执行任务。但是SimpleScheduleBuilder无法指定一些特殊情况，比如每个月执行一次，每周执行一次、每一年执行一次 
属性： 
interval 执行间隔
intervalUnit 执行间隔的单位（秒，分钟，小时，天，月，年，星期）

Trigger trigger = TriggerBuilder.newTrigger().withIdentity("trigger1", "group1")
//加入 scheduler之后立刻执行
.startNow()
//定时 ，每个1秒钟执行一次
.withSchedule(calendarIntervalSchedule()
.withIntervalInWeeks(1) //每周执行一次
).build();

CronScheduleBuilder

  • CronScheduleBuilder
  • 以上几个例子都可以使用cron表达式来表示。 
  • cron表达式。

Trigger trigger = TriggerBuilder.newTrigger().withIdentity("trigger1", "group1")
//加入 scheduler之后立刻执行
.startNow()
//定时 ，每个1秒钟执行一次
.withSchedule(cronSchedule("0 0/2 8-17 * * ?") // 每天8:00-17:00，每隔2分钟执行一次
).build();

JobDetail & Job 

jobdetail 就是对job的定义，而job是具体执行的逻辑内容。 具体的执行的逻辑需要实现 job类，并实现execute方法。 
这里为什么需要有个JobDetai来作为job的定义，为什么不直接使用job？ 
如果使用jobdetail来定义，那么每次调度都会创建一个new job实例，这样带来的好处就是任务并发执行的时候，互不干扰，不会对临界资源造成影响。

我们传给scheduler一个JobDetail实例，因为我们在创建JobDetail时，将要执行的job的类名传给了JobDetail，所以scheduler就知道了要执行何种类型的job；每次当scheduler执行job时，在调用其execute(…)方法之前会创建该类的一个新的实例；执行完毕，对该实例的引用就被丢弃了，实例会被垃圾回收；这种执行策略带来的一个后果是，job必须有一个无参的构造函数（当使用默认的JobFactory时）；另一个后果是，在job类中，不应该定义有状态的数据属性，因为在job的多次执行中，这些属性的值不会保留。

那么如何给job实例增加属性或配置呢？如何在job的多次执行中，跟踪job的状态呢？ JobDataMap

当一个trigger被触发时，与之关联的JobDetail实例会被加载，JobDetail引用的job类通过配置在Scheduler上的JobFactory进行初始化。

简单的实现

一文让你深入学习quartz

一文让你深入学习quartz

Job的实例要到该执行它们的时候才会实例化出来。每次 Job 被执行，一个新的 Job 实例会被创建。
这样你的Job 不必担心线程安全性，因为同一时刻仅有一个线程去执行给定 Job 类的实例，甚至是并发执行同一 Job 也是如此。
@DisallowConcurrentExecution 保证上一个任务执行完后，再去执行下一个任务，这里的任务是同一个任务。

cron 表达式

表达式站位说明

如：0 0 12 * * ?

一文让你深入学习quartzcorn表达式说明图

  • 星号()：可用在所有字段中，表示对应时间域的每一个时刻，例如， 在分钟字段时，表示“每分钟”；
  • 问号（?）：该字符只在日期和星期字段中使用，它通常指定为“无意义的值”，相当于点位符；
  • 减号(-)：表达一个范围，如在小时字段中使用“10-12”，则表示从10到12点，即10,11,12；
  • 逗号(,)：表达一个列表值，如在星期字段中使用“MON,WED,FRI”，则表示星期一，星期三和星期五；
  • 斜杠(/)：x/y表达一个等步长序列，x为起始值，y为增量步长值。如在分钟字段中使用0/15，则表示为0,15,30和45秒，而5/15在分钟字段中表示5,20,35,50，你也可以使用*/y，它等同于0/y；
  • L：该字符只在日期和星期字段中使用，代表“Last”的意思，但它在两个字段中意思不同。L在日期字段中，表示这个月份的最后一天，如一月的31号，非闰年二月的28号；如果L用在星期中，则表示星期六，等同于7。但是，如果L出现在星期字段里，而且在前面有一个数值X，则表示“这个月的最后X天”，例如，6L表示该月的最后星期五；
  • W：该字符只能出现在日期字段里，是对前导日期的修饰，表示离该日期最近的工作日。例如15W表示离该月15号最近的工作日，如果该月15号是星期六，则匹配14号星期五；如果15日是星期日，则匹配16号星期一；如果15号是星期二，那结果就是15号星期二。但必须注意关联的匹配日期不能够跨月，如你指定1W，如果1号是星期六，结果匹配的是3号星期一，而非上个月最后的那天。W字符串只能指定单一日期，而不能指定日期范围；
  • LW组合：在日期字段可以组合使用LW，它的意思是当月的最后一个工作日；
  • 井号(#)：该字符只能在星期字段中使用，表示当月某个工作日。如6#3表示当月的第三个星期五(6表示星期五，#3表示当前的第三个)，而4#5表示当月的第五个星期三，假设当月没有第五个星期三，忽略不触发；
  • C：该字符只在日期和星期字段中使用，代表“Calendar”的意思。它的意思是计划所关联的日期，如果日期没有被关联，则相当于日历中所有日期。例如5C在日期字段中就相当于日历5日以后的第一天。1C在星期字段中相当于星期日后的第一天。
  • Cron表达式对特殊字符的大小写不敏感，对代表星期的缩写英文大小写也不敏感。

常用例子写法：

一文让你深入学习quartz

好了，quartz的使用到这里就结束了，感兴趣的伙伴可以继续深入研究。

 

相关推荐