Quartz 定时任务 (1) —— 初体验

一. 什么是Quartz

Quartz是OpenSymphony开源组织在Job scheduling领域又一个开源项目,完全由Java开发,可以用来执行定时任务,类似于java.util.Timer。但是相较于Timer, Quartz增加了很多功能:

  • 持久性作业 - 就是保持调度定时的状态
  • 作业管理 - 对调度作业进行有效的管理

Quartz 是一个完全由 Java 编写的开源作业调度框架,为在 Java 应用程序中进行作业调度提供了简单却强大的机制。
Quartz 可以与 J2EE 与 J2SE 应用程序相结合也可以单独使用。
Quartz 允许程序开发人员根据时间的间隔来调度作业。
Quartz 实现了作业和触发器的多对多的关系,还能把多个作业与不同的触发器关联

1. 核心概念

我们需要明白 Quartz 的几个核心概念,这样理解起 Quartz 的原理就会变得简单了

  1. Job 表示一个工作,要执行的具体内容。此接口中只有一个方法,如下:

    void execute(JobExecutionContext context) 
    
  2. JobDetail 表示一个具体的可执行的调度程序,Job 是这个可执行程调度程序所要执行的内容,另外 JobDetail 还包含了这个任务调度的方案和策略。

  3. Trigger 代表一个调度参数的配置,什么时候去调。

  4. Scheduler 代表一个调度容器,一个调度容器中可以注册多个 JobDetail 和 Trigger。当 Trigger 与 JobDetail 组合,就可以被 Scheduler 容器调度了

2. 运行环境

  1. Quartz 可以运行嵌入在另一个独立式应用程序。
  2. Quartz 可以在应用程序服务器(或 servlet 容器)内被实例化,并且参与 XA 事务。
  3. Quartz 可以作为一个独立的程序运行(其自己的 Java 虚拟机内),可以通过 RMI 使用。
  4. Quartz 可以被实例化,作为独立的项目集群(负载平衡和故障转移功能),用于作业的执行

二. 入门案例

maven依赖

        
        
            org.quartz-scheduler
            quartz
            2.3.2
        

1. 需要定时执行的代码

    private static int count = 1;
    @Override
    public void execute(JobExecutionContext context) throws JobExecutionException {
        System.out.println("定时任务执行第"+count+++"次");
    }

2. 启动定时器的代码

public static void main(String[] args) {
        try {
            // 1. 创建调度器
            Scheduler scheduler = StdSchedulerFactory.getDefaultScheduler();
            // 2. 创捷任务实例 JobDetail
            JobDetail jobDetail = JobBuilder.newJob(JobTest.class)
                    .withIdentity("test1", "test1")  // 任务名 和 所属组
                    .build();
            // 3. 创建触发器
            TriggerBuilder triggerBuilder = TriggerBuilder.newTrigger();
            Trigger trigger = TriggerBuilder.newTrigger()
                    .withIdentity("haiyang", "test1") // 触发器名称和组
                    .startNow() // 马上启动触发器
                    .withSchedule(SimpleScheduleBuilder
                            .simpleSchedule()
                            .withIntervalInSeconds(1)
                            .withRepeatCount(3))  // 每1秒执行一次定时任务  重复3次
                    .build();
            // 4. 让调度器关联 jobDetail 和 trigger
            scheduler.scheduleJob(jobDetail,trigger);
            scheduler.start();
        } catch (SchedulerException e) {
            e.printStackTrace();
        }
    }

3. 运行结果

Quartz 定时任务 (1) —— 初体验_第1张图片

它实际执行力4次,因为启动时执行了一次然后过了一秒执行了第一次,如果想只执行一次把两个参数都设置成0 就行

三. 多种触发器

1. SimpleTrigge

正如其名所示,SimpleTrigger对于设置和使用是最为简单的一种 Quartz Trigger。它是为那种需要在特定的日期/时间启动,且以一个可能的间隔时间重复执行 n 次的 Job 所设计的。

我们前面已经在一个简单的Quartz的例子里使用过了SimpleTrigger

           Trigger trigger = TriggerBuilder.newTrigger()
                    .withIdentity("haiyang", "test1") // 触发器名称和组
                    .startNow() // 马上启动触发器
                    .withSchedule(SimpleScheduleBuilder
                            .simpleSchedule()
                            .withIntervalInSeconds(1)
                            .withRepeatCount(3))  // 每1秒执行一次定时任务  重复3次
                    .build();

2. CalendarTrigger

类似于SimpleTrigger,指定从某一个时间开始,以一定的时间间隔执行的任务。 但是不同的是SimpleTrigger指定的时间间隔为毫秒,没办法指定每隔一个月执行一次(每月的时间间隔不是固定值),而CalendarIntervalTrigger支持的间隔单位有秒,分钟,小时,天,月,年,星期。

相较于SimpleTrigger有两个优势:

  1. 更方便,比如每隔1小时执行,你不用自己去计算1小时等于多少毫秒。
  2. 支持不是固定长度的间隔,比如间隔为月和年。但劣势是精度只能到秒。

它适合的任务类似于:9:00 开始执行,并且以后每周 9:00 执行一次

它的属性有:

  • interval 执行间隔
  • intervalUnit 执行间隔的单位(秒,分钟,小时,天,月,年,星期)

例子:

Trigger trigger = TriggerBuilder.newTrigger()
                    .withIdentity("haiyang", "test1") // 触发器名称和组
                    .startNow() // 马上启动触发器
                    //.withSchedule(CalendarIntervalScheduleBuilder.calendarIntervalSchedule().withIntervalInDays(2))  // 每2天执行一次
                    //.withSchedule(CalendarIntervalScheduleBuilder.calendarIntervalSchedule().withIntervalInYears(2))  // 每2年执行一次
                    .withSchedule(CalendarIntervalScheduleBuilder.calendarIntervalSchedule().withIntervalInSeconds(2))  // 每2秒执行一次
                    .build();

3. DailyTimeIntervalTrigger

指定每天的某个时间段内,以一定的时间间隔执行任务。并且它可以支持指定星期

它适合的任务类似于:指定每天9:00 至 18:00 ,每隔70秒执行一次,并且只要周一至周五执行。

它的属性有:

  • startTimeOfDay 每天开始时间
  • endTimeOfDay 每天结束时间
  • daysOfWeek 需要执行的星期
  • interval 执行间隔
  • intervalUnit 执行间隔的单位(秒,分钟,小时,天,月,年,星期)
  • repeatCount 重复次数

例子1:

Trigger trigger = TriggerBuilder.newTrigger()
                    .withIdentity("haiyang", "test1") // 触发器名称和组
                    .startNow() // 马上启动触发器
                    .withSchedule(DailyTimeIntervalScheduleBuilder
                            .dailyTimeIntervalSchedule()
                            .startingDailyAt(TimeOfDay.hourAndMinuteOfDay(00,45)) // 每天 00:45 分 执行  开始时执行一次
                            .endingDailyAt(TimeOfDay.hourAndMinuteOfDay(00,46)) // 每天 00:46分 结束 结束时执行一次
                            .onDaysOfTheWeek(1,2,3,4,5))  // 每 周1,2,3,4,5执行
                    .build();

例子2:

            Trigger trigger = TriggerBuilder.newTrigger()
                    .withIdentity("haiyang", "test1") // 触发器名称和组
                    .startNow() // 马上启动触发器
                    .withSchedule(DailyTimeIntervalScheduleBuilder
                            .dailyTimeIntervalSchedule()
                            .startingDailyAt(TimeOfDay.hourAndMinuteOfDay(9, 0)) //第天9:00开始
                            .endingDailyAt(TimeOfDay.hourAndMinuteOfDay(16, 0)) //16:00 结束
                            .onDaysOfTheWeek(1,2,3,4,5) //周一至周五执行
                            .withIntervalInHours(1) //每间隔1小时执行一次
                            .withRepeatCount(100)) //最多重复100次(实际执行100+1次))  // 每 周1,2,3,4,5执行
                    .build();

例子3:

          Trigger trigger = TriggerBuilder.newTrigger()
                    .withIdentity("haiyang", "test1") // 触发器名称和组
                    .startNow() // 马上启动触发器
                    .withSchedule(DailyTimeIntervalScheduleBuilder
                            .dailyTimeIntervalSchedule()
                            .startingDailyAt(TimeOfDay.hourAndMinuteOfDay(9, 0)) //第天9:00开始
                            .endingDailyAfterCount(10) //每天执行10次,这个方法实际上根据 startTimeOfDay+interval*count 算出 endTimeOfDay
                            .onDaysOfTheWeek(1,2,3,4,5) //周一至周五执行
                            .withIntervalInHours(1)) //每间隔1小时执行一次
                    .build();

4. CronTrigger

适合于更复杂的任务,它支持类型于Linux Cron的语法(并且更强大)。基本上它覆盖了以上三个Trigger的绝大部分能力(但不是全部)—— 当然,也更难理解。

它适合的任务类似于:每天0:00,9:00,18:00各执行一次。

它的属性只有:

  • Cron表达式。但这个表示式本身就够复杂了。下面会有说明。

例子:

       Trigger trigger = TriggerBuilder.newTrigger()
                    .withIdentity("haiyang", "test1") // 触发器名称和组
                    .startNow() // 马上启动触发器
                    .withSchedule(CronScheduleBuilder
                            .cronSchedule("0 0/1 1-3 * * ?")) // 每天1:00-3:00,每隔1分钟执行一次
                    .build();
4.1 Cron表达式
位置 时间域 允许值 特殊值
1 0-59 , - * /
2 分钟 0-59 , - * /
3 小时 0-23 , - * /
4 日期 1-31 , - * ? / L W C
5 月份 1-12 , - * /
6 星期 1-7 , - * ? / L C #
7 年份(可选) 1-31 , - * /

星号(*):可用在所有字段中,表示对应时间域的每一个时刻,例如, 在分钟字段时,表示“每分钟”;

问号(?):该字符只在日期和星期字段中使用,它通常指定为“无意义的值”,相当于点位符;

减号(-):表达一个范围,如在小时字段中使用“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表达式对特殊字符的大小写不敏感,对代表星期的缩写英文大小写也不敏感。

4.2 Cron表达式案例
表示式 说明
0 0 12 * * ? 每天12点运行
0 15 10 ? * * 每天10:15运行
0 15 10 * * ? 每天10:15运行
0 15 10 * * ? * 每天10:15运行
0 15 10 * * ? 2008 在2008年的每天10:15运行
0 * 14 * * ? 每天14点到15点之间每分钟运行一次,开始于14:00,结束于14:59。
0 0/5 14 * * ? 每天14点到15点每5分钟运行一次,开始于14:00,结束于14:55。
0 0/5 14,18 * * ? 每天14点到15点每5分钟运行一次,此外每天18点到19点每5钟也运行一次。
0 0-5 14 * * ? 每天14:00点到14:05,每分钟运行一次。
0 10,44 14 ? 3 WED 3月每周三的14:10分到14:44,每分钟运行一次。
0 15 10 ? * MON-FRI 每周一,二,三,四,五的10:15分运行。
0 15 10 15 * ? 每月15日10:15分运行。
0 15 10 L * ? 每月最后一天10:15分运行。
0 15 10 ? * 6L 每月最后一个星期五10:15分运行。
0 15 10 ? * 6L 2007-2009 在2007,2008,2009年每个月的最后一个星期五的10:15分运行。
0 15 10 ? * 6#3 每月第三个星期五的10:15分运行。
4.3 CronTrigger的熄火策略
  • MISFIRE_INSTRUCTION_FIRE_ONCE_NOW - 如果熄火,该指令会告诉Quartz希望马上再次触发
  • MISFIRE_INSTRUCTION_DO_NOTHING - 如果熄火,该指令会告诉Quartz下一次执行时间到来时再执行,并不想马上执行

你可能感兴趣的:(springboot,quartz,java)