分布式定时任务框架Quartz总结和实践(1)

一、概述

Quartz是OpenSymphony开源组织在Job scheduling领域又一个开源项目,它可以与J2EE与J2SE应用程序相结合也可以单独使用。Quartz可以用来创建简单或为运行十个,百个,甚至是好几万个Jobs这样复杂的程序。Jobs可以做成标准的Java组件或 EJBs。

1.特性

  1. 支持多任务调度和管理,Quartz可以在数据库中存储多个定时任务进行作业调度,可以实现定时任务的增删改查等管理。
  2. 纯Java实现,可以作为独立的应用程序,也可以嵌入在另一个独立式应用程序运行。
  3. 强大的调度功能,Spring默认的调度框架,灵活可配置。
  4. 作业持久化,调度环境持久化机制,可以保存并恢复调度现场。系统关闭数据不会丢失;灵活的应用方式,可以任意定义触发器的调度时间表,支持任务和调度各种组合,组件式监听器、各种插件、线程池等功能,多种存储方式等。
  5. 分布式和集群能力,可以被实例化,一个Quartz集群中的每个节点作为一个独立的Quartz使用,通过相同的数据库表来感知到另一个Quartz应用。

2.使用场景

Quartz是一个分布式的任务调度框架,在分布式环境下需要进行任务调度可以使用。

3.同类框架对比

和Spring框架中的@schedule相比,他们都能基于cron表达式执行定时任务,但明显Quartz框架的能力更强,他可以对任务进行增删改查的操作。

二、原理

1.框架

Quartz主要包括JobDetail、Trigger和Scheduler三部分,JobDetail包含了任务的实现类和任务的描述信息,Trigger决定了任务什么时候执行,Scheduler是调度器,将JobDetail和Trigger结合起来,定时定频率的执行任务。

分布式定时任务框架Quartz总结和实践(1)_第1张图片

2.组成部分说明

(1)Job

表示一个需要定时执行的任务,只需要实现Job接口的execute()方法,该方法就是定时执行的操作。Quartz 每次调度 Job 时,都重新创建一个 Job 实例,因此它不接受多个 Job 的实例。

public interface Job {
    void execute(JobExecutionContext context)
        throws JobExecutionException;
}

(2)JobDetail

JobDetail主要由JobKey(job的名字name和分组group)、JobClass、JobDataMap(任务相关的数据)、JobBuilder组成。他实际保存了Job的描述信息,以便运行时通过 newInstance() 的反射机制实例化 Job。

public class JobDetailImpl implements Cloneable, java.io.Serializable, JobDetail {
    private String name;

    private String group = Scheduler.DEFAULT_GROUP;

    private String description;

    private Class jobClass;

    private JobDataMap jobDataMap;

    private boolean durability = false;

    private boolean shouldRecover = false;

    private transient JobKey key = null;
    //省略...
    }

(3)Trigger

Trigger规定触发执行Job实现类,主要有SimpleTrigger和CronTrigger两个实现类。Trigger由以下部分组成:

  1. TriggerKey(job的名字name和分组group)
  2. JobDataMap(Trigger相关的数据,同JobDetail中JobDataMap,存相同key,若value不同,会覆盖前者。)
  3. ScheduleBuilder(有CronScheduleBuilder、SimpleScheduleBuilder、CalendarIntervalScheduleBuilder、DailyTimeIntervalScheduleBuilder常用前2种。)

(4)Scheduler

Scheduler调度器就是为了读取触发器Trigger从而触发定时任务JobDetail。可以通过SchedulerFactory进行创建调度器,分为StdSchedulerFactory(常用)和DirectSchedulerFactory两种。

  1. StdSchedulerFactory使用一组属性(放在配置文件中)创建和初始化调度器,然后通过getScheduler()方法生成调度程序。
  2. DirectSchedulerFactory不常用,容易硬编码。

3.cron表达式

定时任务离不开Cron表达式设置具体执行时间或执行周期,Cron表达式是一个字符串,一般有两种表达:

  1. 秒 分 小时 日 月 星期 年
  2. 秒 分 小时 日 月 星期

其中,年份即为可选的,所以一般表达式为6-7个域,每个域以空格分开。其中的星期除了可以使用英文缩写,也可以用数字1-7数字来表示,注意1表示的是星期日7表示的星期六

分布式定时任务框架Quartz总结和实践(1)_第2张图片

  • *:星号,表示每个字段对应的时间域的每一个,如在日中,就是表示每天。
  • ?:问号,只能在日期和星期字段中使用,表示无意义的值,等价于点位符。
  • -:减号,表示一个范围,如在分钟中使用5-8,则表示5-8分钟,即5、6、7、8分钟。
  • ,:逗号,表示一个列表值,如在星期中星期一和星期三使用MON,WED,也可以使用数字来表示:1,3
  • /:斜杠,使用x/y来表示一个等步长序列,x表示起始值,y表示步长值。如在秒字段中使用0/15,表示从0秒开始,每15秒增量,即0秒,15秒,30秒,45秒,这种就可以理解为每15秒执行任务。
  • L:只能在日期和星期字段中使用,表示Last。在日期中,L表示月份的最后一天,如1月中的31日;在星期中,L表示星期六(或数字7)。
  • W:只能在日期字段中使用,表示离该日期最近的工作期,不可以跨月。如10W,表示离该月10号最近的工作日,若10号为星期六,则匹配9号星期五;若10号为星期日,则匹配11号星期一;若10号为星期一,则匹配10号星期一。LW组合表示该月的最后一个工作日。
  • C:只能在日期和星期字段中使用,表示Calendar,即计划所关联的日期,若日期未被关联,则等价于关联所有日期。如日期中使用4C,表示日期4号以后的第一天;星期中使用1C,表示星期日后的第一天。
  • #:井号只能在星期字段中使用,表示当月某个工作日。如6#2表示当月的第二个星期五(其中,6表示星期五,#3表示当月的第二个).
    Cron示例
Cron表达式 说明
0 0 * * * ? 每小时0分0秒运行
0 0 1 * * ? 每天01:00:00运行运行
0 0 1 * * ? * 每天01:00:00运行运行,同上
0 0 1 * * ? 2021 2021年每天01:00:00运行
0 * 10 * * ? 每天10点-11点之间每分钟运行一次,开始于10:00:00,结束于10:59:00
0 0/5 10 * * ? 每天10点-11点之间每5分钟运行一次,开始于10:00:00,结束于10:59:00
0 0/5 10,15 * * ? 每天10点-11点之间每5分钟运行一次,每天15点-16点之间每5分钟运行一次
0 0-10 10 * * ? 每天10:00-10:10之间每分钟运行
0 10 1 ? * MON-FRI 每周一,二,三,四,五的1:10分运行
0 10 1 1 * ? 每月1日的1:10分运行
0 10 1 L * ? 每月最后一天1:10分运行
0 10 1 ? * 6L 每月最后一个星期五1:10分运行
0 10 1 ? * 6#3 每月第3个星期五1:10分运行

参考资料 :SpringBoot——Quartz定时框架的使用详解和总结:https://juejin.cn/post/6946348432244080676#heading-9

三、实践

1.基于Springboot的Quartz实现

(1)POM中引入依赖

<dependency>
    <groupId>org.springframework.bootgroupId>
    <artifactId>spring-boot-starter-quartzartifactId>
dependency>

(2)定义Job

import org.quartz.Job;
import org.quartz.JobExecutionContext;
import org.quartz.JobExecutionException;

/**
 * @author yangnk
 * @desc
 * @date 2023/08/05 23:57
 **/
public class MyJob implements Job {

    @Override
    public void execute(JobExecutionContext context) throws JobExecutionException {
        context.getJobDetail().getJobDataMap().forEach((k, v) ->{
            System.out.println("key = " + k);
            System.out.println("value = " + v);
            System.out.println("===System.currentTimeMillis() = " + System.currentTimeMillis());
        });
    }
}

(3)获取JobDetail

public static JobDetail getJobDetail() {
    Map<String, String> jobData = new HashMap<>();
    String jobName = "schedulerJob";
    String jobGroup = "schedulerGroup";
    jobData.put("key00","value00");
    jobData.put("key01","value01");
    jobData.put("key03","value03");
    JobDataMap jobDataMap = new JobDataMap();
    jobDataMap.putAll(jobData);

    JobDetail jobDetail = JobBuilder.newJob(MyJob.class)
            .withIdentity(jobName, jobGroup)
            .usingJobData(jobDataMap)
            .storeDurably()
            .build();
    return jobDetail;
}

(4)获取Trigger

public static Trigger getTrigger() {
    //CronScheduleBuilder
    String triggerName2 = "schedulerJob2";
    String triggerGroup2 = "schedulerGroup2";
    String jobTime = "0/1 * * * * ?";
    Trigger trigger2 = TriggerBuilder
            .newTrigger()
            .withIdentity(triggerName2, triggerGroup2)
            .startAt(DateBuilder.futureDate(1, DateBuilder.IntervalUnit.SECOND))
            .withSchedule(CronScheduleBuilder.cronSchedule(jobTime))
            .startNow()
            .build();
    return trigger2;
}

(5)验证和测试结果

public static void main(String[] args) throws SchedulerException {

    //StdSchedulerFactory方式,用的多
    SchedulerFactory schedulerFactory = new StdSchedulerFactory();
    Scheduler schedulerStd = schedulerFactory.getScheduler();

    JobDetail jobDetail = getJobDetail();
    Trigger trigger = getTrigger();

    //执行调度
    schedulerStd.scheduleJob(jobDetail, trigger);
    schedulerStd.start();
}

分布式定时任务框架Quartz总结和实践(1)_第3张图片

代码实现:https://github.com/yangnk/SpringBoot_Learning/tree/d5b072c3e72d516511e85eda57f1c5a4aef56695/SpringBootExample/src/main/java/com/yangnk/quartzExample

TODO

  • 补充针对Quartz增删改查任务的代码;

参考资料

  1. 官网:http://www.quartz-scheduler.org/
  2. SpringBoot定时任务 - 基础quartz实现方式:https://www.pdai.tech/md/spring/springboot/springboot-x-task-quartz-timer.html
  3. SpringBoot——Quartz定时框架的使用详解和总结:https://juejin.cn/post/6946348432244080676#heading-9
  4. Quartz–SpringBoot–整合/使用/教程/实例:https://blog.51cto.com/knifeedge/5257084

本文由博客一文多发平台 OpenWrite 发布!

你可能感兴趣的:(框架和中间件,Quartz,定时任务)