定时任务框架Quartz

目录

一、Quartzh介绍

        1、Quartz的定义：

        2、Quartz完成定时任务的原理：

二、cron表达式

          1、cron表达式定义

          2、cron表达式规范 

三、spring自带调度器

四、Quartz内存版集成基本使用

        1、关于Quartz内存版集成的步骤

                 1、先到启动类中写好集成的步骤

                 2、再写一个任务类

                 3、优化Quartz内存方式

                 4、测试结果​

五、关于Job任务和Trigger触发器的介绍

        1、Job任务

                  1、定义

                  2、实例化的过程

        2、Trigger触发器

                 2.1介绍

                 2.2触发器常用属性

                 2.3触发器的优先级 

                 2.4常用触发器 在第四大点已经讲解到

---

一、Quartzh介绍

        1、Quartz的定义：

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

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

每周末凌晨备份数据

触发条件 5 分钟后发送邮件通知

30 分钟未支付取消订单

每 1 小时去拉取数据

        2、Quartz完成定时任务的原理：

        1、首先我们需要定义实现一个定时功能的接口，称之为Task（或Job），如定时发送邮件的task（Job），重启机器的task（Job），优惠券到期发送短信提醒的task（Job），实现接口如下：

        2、有了任务之后，还需要一个能够实现触发任务去执行的触发器，触发器Trigger最基本的功能是指定Job的执行时间，执行间隔，运行次数等。 

        3、有了Job和Trigger后，怎么样将两者结合起来呢？即怎样指定Trigger去执行指定的Job呢？这时需要一个Schedule，来负责这个功能的实现。 

由以上原理可得Quartz可以由以下三部分组成

• 调度器：Scheduler
• 任务：JobDetail
• 触发器：Trigger，包括SimpleTrigger（简单触发器）和CronTrigger

二、cron表达式

          1、cron表达式定义

cron表达式是一个字符串,以5或者6个空格隔开(示例中是被5个空格隔开),字符串被切割为6个或者7个域,每个域都代表不同的含义

          2、cron表达式规范 

秒 分 小时 天数 月 星期 年 

{Seconds} {Minutes} {Hours} {DayofMonth} {Month} {DayofWeek} {Year}

{Seconds} {Minutes} {Hours} {DayofMonth} {Month} {DayofWeek}

每个域都可以用数字表示,还可以出现如下特殊字符 

* : 表示匹配该域的任意值,比如Minutes域使用*,就表示每分钟都会触发

- : 表示范围,比如Minutes域使用10-20,就表示从10分钟到20分钟每分钟都会触发一次

, : 表示列出枚举值,比如Minutes域使用1,3.就表示1分钟和3分钟都会触发一次

/ : 表示间隔时间触发(开始时间/时间间隔),例如在Minutes域使用 5/10,就表示从第5分钟开始,每隔10分钟触发一次

? : 表示不指定值,简单理解就是忽略该字段的值,直接根据另一个字段的值触发执行

# : 表示该月第n个星期x(x#n),仅用星期域,如：星期：6#3,表示该月的第三个星期五

L : 表示最后,是单词"last"的缩写（最后一天或最后一个星期几）；仅出现在日和星期的域中,用在日则表示该月的最后一天,用在星期则表示该月的最后一个星期,如：星期域上的值为5L,则表示该月最后一个星期的星期四,在使用'L'时,不要指定列表','或范围'-',否则易导致出现意料之外的结果

W: 仅用在日的域中,表示距离当月给定日期最近的工作日（周一到周五）,是单词"weekday"的缩写

注意：天数和星期不能同时出现！！!

三、spring自带调度器

           1、创建一个简单项目（不要任何工具注入），将开启调度器注解注入启动类中

@EnableScheduling

           2、写一个任务类Task

package com.zj.code;


import lombok.extern.slf4j.Slf4j;
import org.springframework.scheduling.annotation.Scheduled;
import org.springframework.stereotype.Component;

import java.time.LocalDateTime;

@Component
@Slf4j
public class Task {
    @Scheduled(fixedRate = 2000)
    //上⼀次开始执⾏时间点之后2秒再执⾏
    public void task(){
        log.warn("现在时间：" + LocalDateTime.now());
    }
}

关于调度器的几个注解：

@Scheduled(fixedRate=5000):上⼀次开始执⾏时间点之后5秒再执⾏@Scheduled(fixedDelay=5000):上⼀次执⾏完毕时间点之后5秒再执⾏@Scheduled(initialDelay=1000, fixedRate=5000):第⼀次延迟1秒后执⾏,之后按fixedRate的规则每5秒执⾏⼀次@Scheduled(cron="*/5 * * * * *"):通过cron表达式定义规则

           3、进行测试

四、Quartz内存版集成基本使用

        1、关于Quartz内存版集成的步骤

                 1、先到启动类中写好集成的步骤

//1、先实例化调度器工厂

//2、得到调度器

//3、创建任务

//4.创建触发器

//5.将触发器和任务绑定到调度器中去

//6.启动调度器

package com.zj.code;

import org.junit.jupiter.api.Test;
import org.quartz.*;
import org.quartz.impl.StdSchedulerFactory;
import org.springframework.boot.test.context.SpringBootTest;

import java.util.Date;

import static org.quartz.JobBuilder.newJob;
import static org.quartz.SimpleScheduleBuilder.simpleSchedule;

@SpringBootTest
class Quartz01ApplicationTests {

    @Test
    void contextLoads() throws Exception {
        //1、先实例化调度器工厂
        SchedulerFactory factory = new StdSchedulerFactory();
        //2、得到调度器
        Scheduler scheduler = factory.getScheduler();
        //3、创建任务
        JobDetail jobDetail = newJob(MyJob.class)
                .withDescription("开年大扫除")
                .withIdentity("a", "b")
                .usingJobData("name", "王阿姨")
                .build();

        //4.创建触发器
        Trigger trigger = TriggerBuilder.newTrigger()
                .withDescription("大扫除触发器")
                .withIdentity("b", "c")
                .startAt(new Date())
//                .withSchedule(
//                        simpleSchedule()
//                                .withIntervalInSeconds(1)
//                                .withRepeatCount(10) //SimpleTrigger.REPEAT_INDEFINITELY
//                )
//                .withSchedule(
//                        CronScheduleBuilder.cronSchedule("* * * * * ?")
//                )
                .build();
        //5.将触发器和任务绑定到调度器中去
        scheduler.scheduleJob(jobDetail, trigger);
        //6.启动调度器
        scheduler.start();
    }

}

                 2、再写一个任务类

MyJob：

package com.zj.code;

import lombok.extern.slf4j.Slf4j;
import org.quartz.Job;
import org.quartz.JobExecutionContext;
import org.quartz.JobExecutionException;


/**
 * @author T440s
 */
@Slf4j
public class MyJob implements Job {
    @Override
    public void execute(JobExecutionContext context) throws JobExecutionException {
        Object name = context.getJobDetail().getJobDataMap().get("name");//先得到任务，之后就得到map中的名字
        log.warn(name + "搞卫生");
    }
}

                 3、优化Quartz内存方式

当我们做定时任务时，时常不能让他只执行一次，而是要在我指定时间去完成定时任务，这时候就涉及到常用触发器

触发器分为常用触发器和基于cron表达式的触发器

常用触发器：

Trigger trigger = TriggerBuilder.newTrigger()       
.withDescription("")       
.withIdentity("clean", "clean1")       
.startAt(new Date())       
.withSchedule(            
        simpleSchedule()               
        .withIntervalInSeconds(10)                
        .withRepeatCount(10) //SimpleTrigger.REPEAT_INDEFINITELY       
)       
.build();

基于cron表达式的触发器

Trigger trigger = TriggerBuilder.newTrigger()       
     .withIdentity("test", "test")       
     .withDescription("测试的触发器")       
     .withSchedule(
           CronScheduleBuilder.cronSchedule("2 * * * * *")
                  )       
     .build();

                 4、测试结果

五、关于Job任务和Trigger触发器的介绍

        1、Job任务

                  1、定义

任务是一个实现 org.quartz.Job 接口的类，任务类必须含有空构造器当关联这个任务实例的触发器表明的执行时间到了的时候，调度程序 Scheduler 会调用这个方法来执行任务，任务内容就可以在这个方法中执行，JobDataMap 提供了一种“初始化成员属性数据的机制”,在实现该 Job 接口的时候可以取到需要的数据，就如第四点的Myjob类一样

package com.zj.code;

import lombok.extern.slf4j.Slf4j;
import org.quartz.Job;
import org.quartz.JobExecutionContext;
import org.quartz.JobExecutionException;


/**
 * @author T440s
 */
@Slf4j
public class MyJob implements Job {
    @Override
    public void execute(JobExecutionContext context) throws JobExecutionException {
        Object name = context.getJobDetail().getJobDataMap().get("name");//先得到任务，之后就得到map中的名字
        log.warn(name + "搞卫生");
    }
}

                  2、实例化的过程

创建一个 Job 类，在调度程序中可以创建很多个 JobDetai，分别设置不同的 JobDataMap，JobBuilder 用于创建 JobDetail，如果没有调用 withIdentity 指定 job 的名字，会自动生成一个。

JobDetail jobDetail = newJob(MyJob.class)               
.withDescription("开年大扫除")               
.withIdentity("大扫除", "厕所")               
.usingJobData("name", "王阿姨")               
.build();

        2、Trigger触发器

                 2.1介绍

触发器使用 TriggerBuilder 来实例化，有一个 TriggerKey 关联，在一个 Scheduler 中必须是唯一的。多个触发器可以指向同一个工作，但一个触发器只能指向一个工作。触发器可以传送数据给 job，通过将数据放进触发器的 JobDataMap。

                 2.2触发器常用属性

触发器也有很多属性，这些属性都是在使用 TriggerBuilder 定义触发器时设置的。TriggerKey，唯一标识，在一个 Scheduler 中必须是唯一的

startTime，开始时间，通常使用 startAt(java.util.Date)

endTime，结束时间，设置了结束时间则在这之后，不再触发

 Trigger trigger = TriggerBuilder.newTrigger()               
.withDescription("大扫除触发器")               
.withIdentity("大扫除", "厕所")               
.startAt(new Date())               
.build();

 如果没有使用 withIdentity(..) 会自动生成一个触发器名称。

                 2.3触发器的优先级 

有时候，会安排很多任务，但是 Quartz 并没有更多的资源去处理它。

这种情况下，必须需要很好地控制哪个任务先执行。这时候可以设置 priority 属性（使用方法withPriority(int)）来控制触发器的优先级。

优先级只有触发器出发时间一样的时候才有意义。

当一个任务请求恢复执行时，它的优先级和原始优先级是一样的。

                 2.4常用触发器 在第四大点已经讲解到

今天的知识就分享到这了，希望对你有帮助！