quartz怎么玩？（基本使用和入门）

最新推荐文章于 2023-05-18 16:27:37 发布

不辞树

最新推荐文章于 2023-05-18 16:27:37 发布

阅读量2.7k

点赞数 4

分类专栏：定时任务文章标签： maven java quartz

本文链接：https://blog.csdn.net/weixin_44051191/article/details/119996885

版权

定时任务专栏收录该内容

1 篇文章 0 订阅

订阅专栏

一、什么是Quartz

Quartz是OpenSymphony开源组织在Job scheduling领域又一个开源项目

二、什么是Quartz

Quartz是一个强大任务调度框架，我工作时候会在这些情况下使用到quartz框架，当然还有很多的应用场景，在这里只列举2个实际用到的
餐厅系统会在每周四晚上的22点自动审核并生成报表
人事系统会在每天早晨8点给有待办的人员自动发送Email提醒

Quartz是一个完全由java编写的开源作业调度框架。不要让作业调度这个术语吓着你。
尽管Quartz框架整合了许多额外功能， 但就其简易形式看，你会发现它易用得简直让人受不了！
简单地创建一个实现org.quartz.Job接口的java类。Job接口包含唯一的方法：
public void execute(JobExecutionContext context)
throws JobExecutionException;
在你的Job接口实现类里面，添加一些逻辑到execute()方法。
一旦你配置好Job实现类并设定好调度时间表，Quartz将密切注意剩余时间。
当调度程序确定该是通知你的作业的时候，Quartz框架将调用你Job实现类（作业类）上的execute()方法并允许做它该做的事情。
无需报告任何东西给调度器或调用任何特定的东西。
仅仅执行任务和结束任务即可。如果配置你的作业在随后再次被调用，Quartz框架将在恰当的时间再次调用它。

三、使用Quartz之前的准备

1.建立一个Maven项目

2.引入quartz的依赖

使用quartz，我们仅仅需要在maven的pom文件中添加依赖即可。我使用的是版本2.3.0，大家可以在maven的仓库获取到最新的版本依赖，地址：http://mvnrepository.com/artifact/org.quartz-scheduler/quartz

<!-- https://mvnrepository.com/artifact/org.quartz-scheduler/quartz -->
<dependency>
    <groupId>org.quartz-scheduler</groupId>
    <artifactId>quartz</artifactId>
    <version>2.3.0</version>
</dependency>

四、编写第一个Quartz任务案例 - 每隔3秒钟打印一次HelloQuartz

先实现一下这个基本的Quartz的任务再来介绍一下Quartz的3个重要组成，JobDetail，Trigger，Scheduler

1.创建一个类 MyJob.java，这个类是编写我们的具体要实现任务（打印Hello Quartz）

这个类一定要实现job接口这个接口里只有一个方法 execute

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

public class MyJob implements Job {
    @Override
    public void execute(JobExecutionContext jobExecutionContext) throws JobExecutionException {

        System.out.println("Hello Quartz");

    }
}

2.创建一个类QuartzTest .java，这个是具体触发我们的任务

第二步虽然你写了一个类实现了job 你得让quartz知道它是来做什么工作这个类是你自己写的这里就涉及到一个组件 JobDetail

public class QuartzTest {
    public static void demo1()throws Exception{
        //1. 创建一个JobDetail，把实现了Job接口的类邦定到JobDetail 构建者模式 绑定job withIdentity这里起一个唯一的名字
        JobDetail jobDetail= JobBuilder.newJob(MyJob.class).withIdentity("demo1").build();
         //第二个组件 Trigger触发器
        //2.创建一个Trigger触发器的实例，定义该job立即执行，并且每2秒执行一次，一直执行 repeatForever重复
        SimpleTrigger trigger= TriggerBuilder
                .newTrigger()
                .withIdentity("trriger1")
                .startNow()
                .withSchedule(SimpleScheduleBuilder.simpleSchedule()
                        .withIntervalInSeconds(2)
                        .repeatForever())
                .build();
        //创建schedule实例  三 调度器   StdSchedulerFactory 工厂模式
        StdSchedulerFactory factory = new StdSchedulerFactory();
        //获取调度器实例
        Scheduler scheduler = factory.getScheduler();
        //开启调度器
        scheduler.start();
        //把SimpleTrigger和JobDetail注册给调度器
        scheduler.scheduleJob(jobDetail,trigger);
    }
        public static void main(String[] args) throws Exception {
         demo1();
    }
    }

3.执行main方法，Run 'QuartzTest .main()

4.一句话看懂quartz

1、创建调度工厂(); 　　 //工厂模式
2、根据工厂取得调度器实例(); 　　//工厂模式
3、Builder模式构建子组件<Job,Trigger> 　　 // builder模式, 如JobBuilder、TriggerBuilder、DateBuilder
4、通过调度器组装子组件调度器.组装<子组件1,子组件2…> 　　//工厂模式
5、调度器.start();　　 //工厂模式

五.图看quartz

shu

五、第二个案例 - 每日的9点40分触发任务打印HelloQuartz

与上一个的简单案例的区别在于，SimpleTrigger/CronTrigger. 简单的定时任务,可以采用SimpleTrigger,复杂的任务一般采用CronTrigger.cronTrigger不仅可以设定单的触发时间表,更可以设定非常复杂的触发时间表。 CronTrigger 是基于 Unix类似于 cron 表达式,如果对cron表达式比较熟悉,那么学习起来经非常简单. 即使对cron表达式不熟悉,花一会儿的功夫也可以学会。（在工作中我们直接使用网上的在线生成表达式即可又快又准确）生成地址：http://cron.qqe2.com/
先上代码，然后介绍一下cron表达式生成规则。

1.编写任务类 SecondJob.java，具体情况编写具体内容，如生成报表，发送邮件。

public class SecondJob implements Job{
 public void execute(JobExecutionContext jobExecutionContext) throws JobExecutionException {
        //打印当前的执行时间 
        Date date = new Date();
        SimpleDateFormat sf = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
        System.out.println("现在的时间是："+ sf.format(date));
        //具体的业务逻辑
        System.out.println("开始生成任务报表 或 开始发送邮件");
    }
}

2.编写任务触发类 QuartzTest.java

public static void demo2()throws Exception{
        //1. 创建一个JobDetail，把实现了Job接口的类邦定到JobDetail
        JobDetail jobDetail= JobBuilder.newJob(SecondJob.class).withIdentity("demo2").build();
        //每日的10点50分45秒触发任务
        CronTrigger trigger=TriggerBuilder.newTrigger().withIdentity("trriger2").withSchedule(CronScheduleBuilder.cronSchedule("45 50 10 * * ?")).build();
        //创建schedule实例
        StdSchedulerFactory factory = new StdSchedulerFactory();
        //获取调度器实例
        Scheduler scheduler = factory.getScheduler();
        //开启调度器
        scheduler.start();
        //把SimpleTrigger和JobDetail注册给调度器
        scheduler.scheduleJob(jobDetail,trigger);

    }

六、cron表达式编写规则

今年的8月30是星期一那么明年30号就不是星期一了

1.　Quartz Cron 表达式支持7个域 ,分别是秒/分/时/日/月/周/年.期中年是非必须项.如下图

注意在cron表达式中不区分大小写.

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

问号（?）：该字符只在日期和星期字段中使用，它通常指定为“无意义的值”，相当于点位符；

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

2.官方的一些案例

在这里插入图片描述

七、Quartz的三个基本要素

Quartz对任务调度的领域问题进行了高度的抽象，提出了调度器、任务和触发器这3个核心的概念，并在org.quartz通过接口和类对重要的这些核心概念进行描述：

●Job：是一个接口，只有一个方法void execute(JobExecutionContext context)，开发者实现该接口定义运行任务，JobExecutionContext类提供了调度上下文的各种信息。Job运行时的信息保存在JobDataMap实例中；

●JobDetail：Quartz在每次执行Job时，都重新创建一个Job实例，所以它不直接接受一个Job的实例，相反它接收一个Job实现类，以便运行时通过newInstance()的反射机制实例化Job。因此需要通过一个类来描述Job的实现类及其它相关的静态信息，如Job名字、描述、关联监听器等信息，JobDetail承担了这一角色。

通过该类的构造函数可以更具体地了解它的功用：JobDetail(java.lang.String name, java.lang.String group, java.lang.Class jobClass)，该构造函数要求指定Job的实现类，以及任务在Scheduler中的组名和Job名称；

●Trigger：是一个类，描述触发Job执行的时间触发规则。主要有SimpleTrigger和CronTrigger这两个子类。当仅需触发一次或者以固定时间间隔周期执行，SimpleTrigger是最适合的选择；而CronTrigger则可以通过Cron表达式定义出各种复杂时间规则的调度方案：如每早晨9:00执行，周一、周三、周五下午5:00执行等；

●Calendar：org.quartz.Calendar和java.util.Calendar不同，它是一些日历特定时间点的集合（可以简单地将org.quartz.Calendar看作java.util.Calendar的集合——java.util.Calendar代表一个日历时间点，无特殊说明后面的Calendar即指org.quartz.Calendar）。一个Trigger可以和多个Calendar关联，以便排除或包含某些时间点。

假设，我们安排每周星期一早上10:00执行任务，但是如果碰到法定的节日，任务则不执行，这时就需要在Trigger触发机制的基础上使用Calendar进行定点排除。针对不同时间段类型，Quartz在org.quartz.impl.calendar包下提供了若干个Calendar的实现类，如AnnualCalendar、MonthlyCalendar、WeeklyCalendar分别针对每年、每月和每周进行定义；

●Scheduler：代表一个Quartz的独立运行容器，Trigger和JobDetail可以注册到Scheduler中，两者在Scheduler中拥有各自的组及名称，组及名称是Scheduler查找定位容器中某一对象的依据，Trigger的组及名称必须唯一，JobDetail的组和名称也必须唯一（但可以和Trigger的组和名称相同，因为它们是不同类型的）。Scheduler定义了多个接口方法，允许外部通过组及名称访问和控制容器中Trigger和JobDetail。

Scheduler可以将Trigger绑定到某一JobDetail中，这样当Trigger触发时，对应的Job就被执行。一个Job可以对应多个Trigger，但一个Trigger只能对应一个Job。可以通过SchedulerFactory创建一个Scheduler实例。Scheduler拥有一个SchedulerContext，它类似于ServletContext，保存着Scheduler上下文信息，Job和Trigger都可以访问SchedulerContext内的信息。SchedulerContext内部通过一个Map，以键值对的方式维护这些上下文数据，SchedulerContext为保存和获取数据提供了多个put()和getXxx()的方法。可以通过Scheduler# getContext()获取对应的SchedulerContext实例；

●ThreadPool：Scheduler使用一个线程池作为任务运行的基础设施，任务通过共享线程池中的线程提高运行效率。

Job有一个StatefulJob子接口，代表有状态的任务，该接口是一个没有方法的标签接口，其目的是让Quartz知道任务的类型，以便采用不同的执行方案。无状态任务在执行时拥有自己的JobDataMap拷贝，对JobDataMap的更改不会影响下次的执行。而有状态任务共享共享同一个JobDataMap实例，每次任务执行对JobDataMap所做的更改会保存下来，后面的执行可以看到这个更改，也即每次执行任务后都会对后面的执行发生影响。

正因为这个原因，无状态的Job可以并发执行，而有状态的StatefulJob不能并发执行，这意味着如果前次的StatefulJob还没有执行完毕，下一次的任务将阻塞等待，直到前次任务执行完毕。有状态任务比无状态任务需要考虑更多的因素，程序往往拥有更高的复杂度，因此除非必要，应该尽量使用无状态的Job。

如果Quartz使用了数据库持久化任务调度信息，无状态的JobDataMap仅会在Scheduler注册任务时保持一次，而有状态任务对应的JobDataMap在每次执行任务后都会进行保存。

Trigger自身也可以拥有一个JobDataMap，其关联的Job可以通过JobExecutionContext#getTrigger().getJobDataMap()获取Trigger中的JobDataMap。不管是有状态还是无状态的任务，在任务执行期间对Trigger的JobDataMap所做的更改都不会进行持久，也即不会对下次的执行产生影响。

Quartz拥有完善的事件和监听体系，大部分组件都拥有事件，如任务执行前事件、任务执行后事件、触发器触发前事件、触发后事件、调度器开始事件、关闭事件等等，可以注册相应的监听器处理感兴趣的事件。

八.JobDetail & Job和JobDataMap

JobDetail是任务的定义，而Job是任务的执行逻辑。在JobDetail里会引用一个Job Class定义。

每一个JobDetail都会有一个JobDataMap。JobDataMap本质就是一个Map的扩展类，只是提供了一些更便捷的方法，比如getString()之类的。

1.编写触发类

public static void demo2()throws Exception{
        //1. 创建一个JobDetail，把实现了Job接口的类邦定到JobDetail
        JobDetail jobDetail= JobBuilder.newJob(SecondJob.class).withIdentity("demo2")
                .usingJobData("name","zhangan")
                .usingJobData("age",22)
                .build();
        CronTrigger trigger=TriggerBuilder.newTrigger().withIdentity("trriger2").withSchedule(CronScheduleBuilder.cronSchedule("45 50 10 * * ?")).build();
        //创建schedule实例
        StdSchedulerFactory factory = new StdSchedulerFactory();
        //获取调度器实例
        Scheduler scheduler = factory.getScheduler();
        //开启调度器
        scheduler.start();
        //把SimpleTrigger和JobDetail注册给调度器
        scheduler.scheduleJob(jobDetail,trigger);

    }

2.编写具体任务类

public class SecondJob implements Job {
    @Override
    public void execute(JobExecutionContext jobExecutionContext) throws JobExecutionException {
        //打印当前的执行时间 例如 2021-08-30 10:12:00
        Date date = new Date();
		//格式化时间
        SimpleDateFormat sf = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
        System.out.println("现在的时间是："+ sf.format(date));
        //具体的业务逻辑
        System.out.println("开始生成任务报表 或 开始发送邮件");
        JobDataMap jobDataMap = jobExecutionContext.getJobDetail().getJobDataMap();
        String name= jobDataMap.getString("name");
        int age= jobDataMap.getInt("age");
        System.out.println("name="+name+",age="+age);

    }
}

不辞树

关注

4
点赞
踩
10

收藏

觉得还不错? 一键收藏
0
评论
quartz怎么玩？（基本使用和入门）

一、什么是QuartzQuartz是OpenSymphony开源组织在Job scheduling领域又一个开源项目二、什么是QuartzQuartz是一个强大任务调度框架，我工作时候会在这些情况下使用到quartz框架，当然还有很多的应用场景，在这里只列举2个实际用到的餐厅系统会在每周四晚上的22点自动审核并生成报表人事系统会在每天早晨8点给有待办的人员自动发送Email提醒Quartz是一个完全由java编写的开源作业调度框架。不要让作业调度这个术语吓着你。尽管Quartz框架整合了许多额
复制链接

扫一扫