什么是Quartz

旧城等待， 2022-05-18 07:56 42阅读 0赞

**什么是Quartz**  
分享人：张强 。 这次介绍的是Quartz，任务调度框架，使用的还是比较多的。希望能帮到你，如果有错误的地方请留言，或者加qq137416943，欢迎交流。

视频：

width="640" height="498" src="https://v.qq.com/iframe/player.html?vid=e0741km19dv&tiny=0&auto=0" allowfullscreen="">

正文：

> 目录：  
> 1.背景介绍  
> 2.知识剖析  
> 3.常见问题  
> 4.编码实战  
> 5.扩展思考  
> 6.参考文献  
> 7.更多讨论

**1.背景介绍**

什么是Quartz

> Quartz是一个开源任务调度框架。当前版本2.2.3  
> Quartz是OpenSymphony开源组织在Job scheduling（时间调度）领域一个开源项目，(OpenSymphony——开源组织的峨眉派，它的每个开源项目都有自己独特的特点)任务调度：在某个有规律的时间点来执行某件事。时间的触发的条件可能非常复杂，有可能携带复杂的条件等。任务调度是操作系统的重要组成部分，而对于实时操作系统，任务调度直接影响其实时性能。JAVA中任务调度是指基于给定时间点，给定时间间隔或者给定执行次数自动执行任务。

[Quartz官方文档链接][Quartz]  
[W3C Quartz教程][W3C Quartz]

定时方式的实现方式包括但不限于下面这几个：

*  JDK原生定时工具：java.util.Time；
 *  JDK对定时任务调度的线程池支持：ScheduledExecutor；
 *  开源工具：Quartz；
 *  开源工具：JCronTab。

**2.知识剖析**

Quartz特点

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

Quartz的三个核心概念

*  任务 Job 具体要执行的业务逻辑
 *  触发器 Trigger 定义触发业务的时间规则
 *  调度器 Scheduler 调度器去根据触发条件去调度任务执行

**任务 Job和JobDetail**  
Job 实现业务逻辑任务的接口。Job接口只有一个“execute”方法，执行具体的业务逻辑，只有一个参数：JobExecutionContext  
JobExecutionContext 储存Quartz运行时候的环境以及Job本身的数据

JobDetail 描述Job实例所包含的属性  
JobDetail中比较重要的属性：

> name 必须 任务名称 JobDetail.getKey()  
> group 必须 任务所在的组，不设定的话按默认（default）  
> jobClass job实现类  
> jobDataMap job需要的参数

**JobDateMap**  
进行任务调度的时候JobDateMap存储在JobExecutionContext中；  
JobDateMap用来装在任何可序列化的数据对象，job实例对象被执行的时候这些参数对象会传递给它；  
JobDateMap实现Map接口，支持键值对，添加存取基本类型数据类型的方法  
获取方式：

> 1.从Map中直接获取  
> 2.在Job实现类中添加setter方法赋值

**Trigger**  
触发器 触发job的执行  
simplateTrigger 在一个指定时间段内执行一次作业任务或是在指定时间间隔内执行多次作业任务  
CronTrigger 基于日历的作业调度器，基于cron表达式  
**通用属性：**  
JobKey 标识Job实例，触发器根据此指定job实例执行  
StartTime 触发器的时间表首次被触发的时间，值为Java.util.Date  
EndTime 触发器不再被触发的时间，值同上

**cron表达式**，Linux定时任务经常用到，这里格式一样  
格式为 \[秒\] \[分\] \[小时\] \[日\] \[月\] \[周\] \[年\]

[cron表达式在线生成器][cron]

**Scheduler**  
调度器  
根据Trigger触发器调度Job，可以配置后台运行的线程、存储信息方式等，创建方式有两种：  
StdSchedulerFactory可以通过xml或者properties进行声明式配置属性

SchedulerFactory schedulerFactory = new StdSchedulerFactory();
    Scheduler scheduler = schedulerFactory.getScheduler();

DirectSchedulerFactory 属性需要用代码配置

DirectSchedulerFactory factory = DirectSchedulerFactory.getInstance();
    Scheduler scheduler = factory.getScheduler();

**3.常见问题**

Quartz体系结构  
![o_b84f2c82-dc72-3c24-9388-766dc415cdb8.gif][]

Quartz体系结构  
**Job和JobDetail**  
任务的实现接口和绑定任务接口  
**Trigger**  
触发器，决定什么时候调用，用来触发执行Job。Quartz的两种Trigger：  
SimpleTrigger 简单触发器，在一个指定时间段内执行一次作业任务或是在指定时间间隔内执行多次作业任务  
CronTrigger 基于日历的作业调度器，而不是像SimpleTrigger那样精确指定间隔时间。它可以设定非常复杂的触发时间表，基于cron表达式，比SimpleTrigger复杂、常用。  
**Scheduler**  
调度器，根据Trigger，定时定频率执行JobDetail信息，和Job绑定在一起

Quartz由300多个类组成，这里是其中的比较重要的，或者说需要了解的  
Job 执行业务，也就是实现业务逻辑任务的接口；  
JobDetail 绑定Job，描述job信息，关联job监听器，储存特定job实例的状态信息；  
JobDataMap JobDetail对象的一部分，储存包含不限量的（序列化的）数据对象，在job实例执行的时候，可以使用其中的数据；  
JobBuilder 定义JobDetail实例，保存执行信息等；  
JobStore job数据接口，保存job数据，可以保存在内存中或者数据库中；  
Trigger 触发器；  
TriggerBuilder 创建Trigger实例；  
ThreadPool Quartz用来解决并发等问题；  
Scheduler 调度器；  
**Calender** 可以一个或者多个Calender和Trigger关联，用于排除或者包含某个时间点；  
**监听器**：JobListener、TriggerListener、SchedulerListentr

**4.编码实战**  
举例：  
Job 实现类，作为业务逻辑，：

@Service("documentService")
    public class DocumentJob implements Job{
    
    //    private String message;
    //    private String triggerMessage2;
    //    private Double doubleValue;
    //    private boolean booleanValue;
    //
    //    public void setMessage(String message) {
    //        this.message = message;
    //    }
    //
    //    public void setTriggerMessage2(String triggerMessage2) {
    //        this.triggerMessage2 = triggerMessage2;
    //    }
    //
    //    public void setDoubleValue(Double doubleValue) {
    //        this.doubleValue = doubleValue;
    //    }
    //
    //    public void setBooleanValue(boolean booleanValue) {
    //        this.booleanValue = booleanValue;
    //    }
    
        @Override
        public void execute(JobExecutionContext context) throws JobExecutionException {
    
            //打印时间
            CutTime cutTime = new CutTime();
            cutTime.printNowDate();
    
    //        //获取JobKey 信息
    //        JobKey jobKey = context.getJobDetail().getKey();
    //        System.out.println(jobKey.getName());
    //        System.out.println(jobKey.getGroup());
    //        System.out.println(jobKey.getClass().getName());
    //
    //        //获取TriggerKey 信息
    //        TriggerKey triggerKey = context.getTrigger().getKey();
    //        System.out.println(" " + triggerKey.getName());
    //        System.out.println(" " + triggerKey.getGroup());
    
            //获取JobDataMap 信息
    //        JobDataMap jobDataMap = context.getJobDetail().getJobDataMap();
    //        JobDataMap triggerDataMap = context.getTrigger().getJobDataMap();
    //        System.out.println(
    //                "\nmessage：" + jobDataMap.getString("message") +
    //                "\nbooleanValue：" + jobDataMap.getBoolean("booleanValue") +
    //                "\ndoubleValue：" + jobDataMap.getDouble("doubleValue") +
    //                "\ntriggerMessage：" + triggerDataMap.getString("Message") +
    //                "\ntriggerMessage2：" + triggerDataMap.getString("triggerMessage2")
    //        );
    
    
            //合并 如果key相同会显示jobDateMap的值
    //        JobDataMap MergedJobDataMap = context.getMergedJobDataMap();
    //        System.out.println(
    //                "\nmessage：" + MergedJobDataMap.getString("message") +
    //                        "\nbooleanValue：" + MergedJobDataMap.getBoolean("booleanValue") +
    //                        "\ndoubleValue：" + MergedJobDataMap.getDouble("doubleValue") +
    //                        "\ntriggerMessage：" + MergedJobDataMap.getString("triggerMessage") +
    //                        "\ntriggerMessage2：" + MergedJobDataMap.getString("triggerMessage2")
    //        );
    
            //通过set属性方法获取DataMap值
    //        System.out.println(
    //                "\nmessage：" + message +
    //                        "\nbooleanValue：" + booleanValue +
    //                        "\ndoubleValue：" + doubleValue +
    //                        "\ntriggerMessage2：" + triggerMessage2
    //        );
    
    
    
            //业务逻辑
            System.out.println("哔哩哔哩：执行业务逻辑\n");
    
    
        }
    }

定时任务：

public class QuartzCronTriggerMain {
    
        public static void main(String[] args) throws SchedulerException {
    
    
            //创建JobDetail实例 绑定Job Class 也就是我们执行的业务DocumentJob类
            JobDetail jobDetail = JobBuilder.newJob(DocumentJob.class)
                    .withIdentity("jobName","group1")//创建唯一标识，name + 组
                    .build();
            //创建Trigger触发器实例  触发job实行 nowStart定义立即执行
            CronTrigger trigger = (CronTrigger) TriggerBuilder.newTrigger().withIdentity("Trigger","triggerGroup")
                    .withSchedule(
                            CronScheduleBuilder
    //                        .cronSchedule("* * * * * ? *"))
                            .cronSchedule("5/2 5 20 * * ?"))
                    .build();
    
            //cron表达式
            //* * * * * ? * 秒 分 小时 日 月 周 年(可缺省)  ? 不关心
            // 秒 分 0~59    小时 0-23   日期 0~31  月份 1~12  星期 1~7 （周日 1 ~ 周六 7）
            //,或 -至 *每 /每隔 #第 ?仅用于天 月和周 表示不指定 因为月和星期可能冲突 一个指定另一个需要设为?
            //0 30 10 ? * *            0秒 30分 10点 每月每天  每天10点30触发
            //0 0/5 20 * * ?           0秒 0/5 0分钟开始每隔5分钟触发 20点(20:00~20:59)  每月每天
            //0 15 10 ? * MON-FRI      周一至周五每天10点15分触发
            //0 15 10 ? * 6#3          每月第三周的周五开始触发（6代表星期五）
            //0/2 * 20 * * ?          每天20点开始每隔2秒执行1次
    
            //创建simpleSchedule 调度器实例
            SchedulerFactory schedulerFactory = new StdSchedulerFactory();
            Scheduler scheduler = schedulerFactory.getScheduler();
    
    //        DirectSchedulerFactory factory = DirectSchedulerFactory.getInstance();
    //        Scheduler scheduler = factory.getScheduler();
    
            //开始执行调度器
            scheduler.start();
    
            //绑定触发器和执行业务
            scheduler.scheduleJob(jobDetail,trigger);
    
        }
    }

**5.扩展思考**

**Quartz所用到的设计模式**  
Bulider模式  /  工厂模式  /  组件模式  /  链式写法组件模式:quarzt每个组件可插拔，组件耦合低，易于扩展  
链式写法：Trigger trigger = newTrigger().withIdentity(“name”,“group”).startNow().build();

**Quartz+Spring整合 / Quartz集群** 集群依赖于数据库，所以必须创建Quartz数据库表

**Quartz配置文件**  
组成：  
调度器属性  
线程池属性  
作业存储设置  
插件配置

配置文件

# Default Properties file for use by StdSchedulerFactory
    # to create a Quartz Scheduler Instance, if a different
    # properties file is not explicitly specified.
    #
    # ===========================================================================
    # Configure Main Scheduler Properties 调度器属性
    # ===========================================================================
    org.quartz.scheduler.instanceName: DefaultQuartzScheduler
    org.quartz.scheduler.instanceid:AUTO
    org.quartz.scheduler.rmi.export: false
    org.quartz.scheduler.rmi.proxy: false
    org.quartz.scheduler.wrapJobExecutionInUserTransaction: false
    # ===========================================================================  
    # Configure ThreadPool 线程池属性  
    # ===========================================================================
    #线程池的实现类（一般使用SimpleThreadPool即可满足几乎所有用户的需求）
    org.quartz.threadPool.class: org.quartz.simpl.SimpleThreadPool
    #指定线程数，至少为1（无默认值）(一般设置为1-100直接的整数合适)
    org.quartz.threadPool.threadCount: 10
    #设置线程的优先级（最大为java.lang.Thread.MAX_PRIORITY 10，最小为Thread.MIN_PRIORITY 1，默认为5）
    org.quartz.threadPool.threadPriority: 5
    #设置SimpleThreadPool的一些属性
    #设置是否为守护线程
    #org.quartz.threadpool.makethreadsdaemons = false
    #org.quartz.threadPool.threadsInheritContextClassLoaderOfInitializingThread: true
    #org.quartz.threadpool.threadsinheritgroupofinitializingthread=false
    #线程前缀默认值是：[Scheduler Name]_Worker
    #org.quartz.threadpool.threadnameprefix=swhJobThead;
    # 配置全局监听(TriggerListener,JobListener) 则应用程序可以接收和执行 预定的事件通知
    # ===========================================================================
    # Configuring a Global TriggerListener 配置全局的Trigger监听器
    # MyTriggerListenerClass 类必须有一个无参数的构造函数，和 属性的set方法，目前2.2.x只支持原始数据类型的值（包括字符串）
    # ===========================================================================
    #org.quartz.triggerListener.NAME.class = com.swh.MyTriggerListenerClass
    #org.quartz.triggerListener.NAME.propName = propValue
    #org.quartz.triggerListener.NAME.prop2Name = prop2Value
    # ===========================================================================
    # Configuring a Global JobListener 配置全局的Job监听器
    # MyJobListenerClass 类必须有一个无参数的构造函数，和 属性的set方法，目前2.2.x只支持原始数据类型的值（包括字符串）
    # ===========================================================================
    #org.quartz.jobListener.NAME.class = com.swh.MyJobListenerClass
    #org.quartz.jobListener.NAME.propName = propValue
    #org.quartz.jobListener.NAME.prop2Name = prop2Value
    # ===========================================================================  
    # Configure JobStore 存储调度信息（工作，触发器和日历等）
    # ===========================================================================
    # 信息保存时间 默认值60秒
    org.quartz.jobStore.misfireThreshold: 60000
    #保存job和Trigger的状态信息到内存中的类
    org.quartz.jobStore.class: org.quartz.simpl.RAMJobStore
    # ===========================================================================  
    # Configure SchedulerPlugins 插件属性 配置
    # ===========================================================================
    # 自定义插件  
    #org.quartz.plugin.NAME.class = com.swh.MyPluginClass
    #org.quartz.plugin.NAME.propName = propValue
    #org.quartz.plugin.NAME.prop2Name = prop2Value
    #配置trigger执行历史日志（可以看到类的文档和参数列表）
    org.quartz.plugin.triggHistory.class = org.quartz.plugins.history.LoggingTriggerHistoryPlugin  
    org.quartz.plugin.triggHistory.triggerFiredMessage = Trigger {1}.{0} fired job {6}.{5} at: {4, date, HH:mm:ss MM/dd/yyyy}  
    org.quartz.plugin.triggHistory.triggerCompleteMessage = Trigger {1}.{0} completed firing job {6}.{5} at {4, date, HH:mm:ss MM/dd/yyyy} with resulting trigger instruction code: {9}  
    #配置job调度插件  quartz_jobs(jobs and triggers内容)的XML文档  
    #加载 Job 和 Trigger 信息的类   （1.8之前用：org.quartz.plugins.xml.JobInitializationPlugin）
    org.quartz.plugin.jobInitializer.class = org.quartz.plugins.xml.XMLSchedulingDataProcessorPlugin
    #指定存放调度器(Job 和 Trigger)信息的xml文件，默认是classpath下quartz_jobs.xml
    org.quartz.plugin.jobInitializer.fileNames = my_quartz_job2.xml  
    #org.quartz.plugin.jobInitializer.overWriteExistingJobs = false  
    org.quartz.plugin.jobInitializer.failOnFileNotFound = true  
    #自动扫描任务单并发现改动的时间间隔,单位为秒
    org.quartz.plugin.jobInitializer.scanInterval = 10
    #覆盖任务调度器中同名的jobDetail,避免只修改了CronExpression所造成的不能重新生效情况
    org.quartz.plugin.jobInitializer.wrapInUserTransaction = false
    # ===========================================================================  
    # Sample configuration of ShutdownHookPlugin  ShutdownHookPlugin插件的配置样例
    # ===========================================================================
    #org.quartz.plugin.shutdownhook.class = \org.quartz.plugins.management.ShutdownHookPlugin
    #org.quartz.plugin.shutdownhook.cleanShutdown = true
    #
    # Configure RMI Settings 远程服务调用配置
    #
    #如果你想quartz-scheduler出口本身通过RMI作为服务器，然后设置“出口”标志true(默认值为false)。
    #org.quartz.scheduler.rmi.export = false
    #主机上rmi注册表(默认值localhost)
    #org.quartz.scheduler.rmi.registryhost = localhost
    #注册监听端口号（默认值1099）
    #org.quartz.scheduler.rmi.registryport = 1099
    #创建rmi注册，false/never：如果你已经有一个在运行或不想进行创建注册
    # true/as_needed:第一次尝试使用现有的注册，然后再回来进行创建
    # always:先进行创建一个注册，然后再使用回来使用注册
    #org.quartz.scheduler.rmi.createregistry = never
    #Quartz Scheduler服务端端口，默认是随机分配RMI注册表
    #org.quartz.scheduler.rmi.serverport = 1098
    #true:链接远程服务调度(客户端),这个也要指定registryhost和registryport，默认为false
    # 如果export和proxy同时指定为true，则export的设置将被忽略
    #org.quartz.scheduler.rmi.proxy = false

**6.参考文献**  
浅谈Trigger：[https://www.cnblogs.com/qlqwjy/p/8721963.html][https_www.cnblogs.com_qlqwjy_p_8721963.html]  
Quartz特性及其集群特性：[https://blog.csdn.net/superli90/article/details/50054325][https_blog.csdn.net_superli90_article_details_50054325]  
慕课网：imooc.com [xiangzepro][]大佬的课程

**7.更多讨论**

**韩亚博：除了quartz 还有什么**  
A：jdk原生的timmer，ScheduledExecutor和Calendar实现，JCronTab，elastic-job

**宋尚：如果我们设定2分钟一个任务，但是这个任务本身执行时间有10分钟，会发生什么**  
A：  
刚才理解错了  
还以为说的是单独一个线程的一个任务  
你说的是一个线程开始以后没结束又开始一个调度线程  
我说的调度器结束时间，不在一个频道  
要是这样的话有线程池的话就会阻塞了，可以配置单独一个执行

**韩亚博：任务执行过程中被阻塞怎么处理？**  
A：根据配置可以配置单独的一个线程处理，或者单条线程处理完任务再进行下一个，有很多办法，主要是线程池的配置和线程的使用问题

#### 分享到此结束 ####

谢谢大家

[Quartz]: http://www.quartz-scheduler.org/documentation/quartz-2.2.x/quick-start.html
[W3C Quartz]: https://www.w3cschool.cn/quartz_doc/
[cron]: http://cron.qqe2.com/
[o_b84f2c82-dc72-3c24-9388-766dc415cdb8.gif]: /images/20220518/72f290c4bb9145ca90a6d6cbfec421fd.png
[https_www.cnblogs.com_qlqwjy_p_8721963.html]: https://www.cnblogs.com/qlqwjy/p/8721963.html
[https_blog.csdn.net_superli90_article_details_50054325]: https://blog.csdn.net/superli90/article/details/50054325
[xiangzepro]: https://www.imooc.com/t/4264265