Quartz入门以及相关表达式使用

Posted 2020-11-23 huangting

目的：

　　1、Quartz简介及应用场景

　　2、Quartz简单触发器 SimpleTrigger介绍

　　3、Quartz表达式触发器CronTirgger介绍

　　4、Quartz中参数传递

　　5、Spring task Vs Quartz

---

Quartz简介及应用场景

•  Quartz介绍

任务调度框架“Quartz”是OpenSymphony开源组织在Job scheduling领域又一个开源项目，是完全由java开发的一个开源的任务日程管理系统，

“任务进度管理器”就是一个在预先确定（被纳入日程）的时间到达时，负责执行（或者通知）其他软件组件的系统。

   

简单来说就是实现“计划(或定时)任务”的系统，例如：订单下单后未付款，15分钟后自动撤消订单，并自动解锁锁定的商品

•  Quartz的触发器　

  触发器用来告诉调度程序作业什么时候触发。框架提供了5种触发器类型，但两个最常用的SimpleTrigger和CronTrigger。

   五种类型的Trigger(定时器)

   SimpleTrigger，CronTirgger，DateIntervalTrigger，NthIncludedDayTrigger和Calendar类（ org.quartz.Calendar）。

 

   场景：

   SimpleTrigger：执行N次，重复N次

   CronTrigger：几秒 几分 几时 哪日 哪月 哪周 哪年，执行

•  存储方式

    RAMJobStore(内存作业存储类型)和JDBCJobStore(数据库作业存储类型)，两种方式对比如下：

　　1.优点 ：

RAMJobStore  不要外部数据库，配置容易，运行速度快    因为调度程序信息是存储在被分配给JVM的内存里面，所以，当应用程序停止运行时，所有调度信息将被丢失。
另外因为存储到JVM内存里面，所以可以存储多少个Job和Trigger将会受到限制

　　2.缺点：

JDBCJobStor  支持集群，因为所有的任务信息都会保存    运行速度的快慢取决与连接数据库的快慢
                到数据库中，可以控制事物，还有就是如
                果应用服务器关闭或者重启，任务信息都
                不会丢失，并且可以恢复因服务器关闭或
                者重启而导致执行失败的任务 

quartz工作流程图解见下：

 

（在线生成表达式网址：http://cron.qqe2.com/）

　　quartz相关表达式

子表达式:

位置	意义	有效值	可用特殊字符
1	Seconds	0－59	, - * /
2	Minutes	0－59	, - * /
3	Hours	0 - 23	, - * /
4	Day-of-Month	1 - 31 ( 注意一些特别的月份)	, - * / ? L W
5	Month	0 - 11 或 字符串 “JAN, FEB, MAR, APR, MAY, JUN, JUL, AUG, SEP, OCT, NOV DEC”	, - * /
6	Day-of-Week(每周)	1 - 7 或 字符串“SUN, MON, TUE, WED, THU, FRI, SAT”表示 * 注意: 1==SUN	, - * / ? L #
7	Year(年 可选字段)	empty 或者 1970-2099	, - * /

 

 

特殊字符 :

 

符号	表示	举例说明
/	每	与当前子表达式结合使用占用一个子表达式位置 例: "3/15" 放在第二个子表达式位上, 表示第三分钟开始执行,每15分钟执行一次
?	某一天	只存在与 Day-of-Month 和 Day-of-Week 中使用,来解决 这两个表达式的冲突问题 在其中一个子表达式有值的情况下 ?写在另一个表达式上表示匹配任意值,这样我们就不会再用* 去来表示匹配任意值了 例: 每月15号的早上4点 : "0 0 4 15 * ?" 每周五晚上11点: "0 0 23 ? * FRI"
L	每月 或每周 的最后一天	只存在与 Day-of-Month 和 Day-of-Week 中使用, 在 Day-of-Month 子表达式中，“L”表示一个月的最后一天 在 Day-of-Week 子表达式中，“L”表示一个星期的最后一天，也就是SAT 例: “0 15 10 ? * 6L” 表示 每月最后一个星期五10:15分运行。 "0 15 10 2L * ?" 表示 每月倒数第二天10:15分运行。
W	最近工作日	只存在与 Day-of-Month 最近的工作日: 例: "0 15 10 15W * ?" 每个月距离15日最近的工作日 如 15日是周六则执行时间是14日 若15日是周日 则执行时间是16 如15号是工作日就15执行 就近匹配不会跨出当前月
#	第几个星期几	只存在与 Day-of-Week 中 每月第n个工作日 例:“0 15 10 ? * 6#3” 表示每个月第三个星期五 “0 15 10 ? * 4#2” 表示每个月第二个星期三
,	多个	例: "0 0 0,13,18,21 * * ?": 每天的0点、13点、18点、21点都执行一次：
-	区间	例: "0 0-5 14 * * ?" : 在每天下午2点到下午2:05期间的每1分钟触发
*	补位符	补位 但是 注意: Day-of-Month 和 Day-of-Week 肯定有一个为 ? 也不能两个 ?

 

 

首先新建一个项目并且选择我们需要用的一些常见jar包

　　

 　　在新项目pom中导入quartz所需要的依赖

        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-aspects</artifactId>
        </dependency>
        <dependency>
            <groupId>org.quartz-scheduler</groupId>
            <artifactId>quartz</artifactId>
            <version>2.2.1</version>
        </dependency>
        <dependency>
            <groupId>org.quartz-scheduler</groupId>
            <artifactId>quartz-jobs</artifactId>
            <version>2.2.1</version>
        </dependency>

设定一个专门放quartz定时任务业务内容的类 RamJob

 

package com.ting.quartz01.job;
import org.quartz.Job;
import org.quartz.JobExecutionContext;
import org.quartz.JobExecutionException;
/**
 * @author 黄大娘
 * @company dogsun公司
 * @create 2019-11-14 19:11
 *
 * 基于内存RAM
 */
public class RamJob implements Job {
    @Override
    public void execute(JobExecutionContext jobExecutionContext) throws JobExecutionException{
        //此处为quartz定时任务执行的业务内容
        System.out.println("常记溪亭日暮，沉醉不知归路");
    }
}

 

---

Quartz简单触发器 SimpleTrigger

每次执行 * 长时间，每次间隔 * 长时间

 　　Dome1.java

package com.ting.quartz01.demo;
import com.ting.quartz01.job.RamJob;
import org.quartz.*;
import org.quartz.impl.StdSchedulerFactory;
import static org.quartz.JobBuilder.newJob;
/**
 * @author 黄大娘
 * @company dogsun公司
 * @create 2019-11-14 19:15
 *
 * 讲解简单触发器（每个N秒执行，一共执行多少次）
 */
public class Demo1 {
    public static void main(String[] args) throws SchedulerException {
//        schedule、jobDetail、trigger
        SchedulerFactory factory = new StdSchedulerFactory();
        Scheduler scheduler = factory.getScheduler();

        JobDetail jobDetail= newJob(RamJob.class)
                .withIdentity("job1","group1")
                .withDescription("这是第一quartz定时任务")
                .build();
        Trigger trigger =(Trigger)TriggerBuilder.newTrigger()
                .withSchedule(SimpleScheduleBuilder.repeatSecondlyForTotalCount(3,6))
                .withIdentity("triggerl","group1")
                .withDescription("一个触发器")
                .build();

        scheduler.scheduleJob(jobDetail,trigger);
        scheduler.start();
    }
}

效果：

 

---

Quartz表达式触发器

　　　Demo2.java

package com.ting.quartz01.demo;
import com.ting.quartz01.job.RamJob;
import org.quartz.*;
import org.quartz.impl.StdSchedulerFactory;
import static org.quartz.JobBuilder.newJob;

/**
 * @author 黄大娘
 * @company dogsun公司
 * @create 2019-11-14 19:15
 *
 * 讲解表达式触发器（可以定时定点无线循环代码路径）
 */
public class Demo2 {
    public static void main(String[] args) throws SchedulerException {
//        schedule、jobDetail、trigger
        SchedulerFactory factory = new StdSchedulerFactory();
        Scheduler scheduler = factory.getScheduler();

        JobDetail jobDetail= newJob(RamJob.class).withIdentity("job2","group2").withDescription("这是quartz定时任务").build();
        Trigger trigger =(Trigger)TriggerBuilder.newTrigger()
                //定点执行逻辑
                //.withSchedule(CronScheduleBuilder.cronSchedule("0 45 14 * * ?"))
                //每六秒循环执行
                .withSchedule(CronScheduleBuilder.cronSchedule("0/3 * * * * ?"))
                .withIdentity("trigger2","group2")
                .withDescription("this is a trigger")
                .build();

        scheduler.scheduleJob(jobDetail,trigger);
        scheduler.start();
    }
}

 

效果：

 

 

 

 

---

Quartz中参数传递

 　　给执行类中添加参数，并且给它定时三秒

　　

package com.ting.quartz01.demo;
import com.ting.quartz01.job.RamJob;
import org.quartz.*;
import org.quartz.impl.StdSchedulerFactory;
import static org.quartz.JobBuilder.newJob;
public class Demo3 {
    public static void main(String[] args) throws SchedulerException {
//        schedule、jobDetail、trigger
        SchedulerFactory factory = new StdSchedulerFactory();
        Scheduler scheduler = factory.getScheduler();

        JobDetail jobDetail= newJob(RamJob.class)
                .withIdentity("job3","group3")
                .withDescription("这是一个quartz定时任务").build();

        String name = "大娘";
        String sex = "女";
        String aihao = "古乐";
        JobDataMap jobDataMap = jobDetail.getJobDataMap();
        jobDataMap.put("name",name);
        jobDataMap.put("sex",sex);
        jobDataMap.put("aihao",aihao);

        Trigger trigger =(Trigger)TriggerBuilder.newTrigger()
                //定点执行逻辑
                //.withSchedule(CronScheduleBuilder.cronSchedule("0 45 14 * * ?"))
                //每六秒循环执行
                .withSchedule(CronScheduleBuilder.cronSchedule("0/3 * * * * ?"))
                .withIdentity("trigger2","group2")
                .withDescription("this is a trigger")
                .build();

        scheduler.scheduleJob(jobDetail,trigger);
        scheduler.start();
    }
}

　　我们还要去定时执行任务内容的类中接收并且输出自定义的参数

　　RamJob

public class RamJob implements Job {
    @Override
    public void execute(JobExecutionContext jobExecutionContext) throws JobExecutionException{
        //此处为quartz定时任务执行的业务内容
        //System.out.println("常记溪亭日暮，沉醉不知归路");
        JobDataMap jobDataMap = jobExecutionContext.getJobDetail().getJobDataMap();
        System.out.println(jobDataMap.get("name"));
        System.out.println(jobDataMap.get("sex"));
        System.out.println(jobDataMap.get("aihao"));
    }
}

效果：

　　每三秒执行一次自定义的参数内容

 

---

Spring task Vs Quartz

•  Spring task

　　　　优点：无需整合spring，作业类中就可以调用业务service

　　　   缺点：单线程；不能做数据存储型的定时任务

• Quartz

　　　　优点：多线程；可以做数据存储型的定时任务，维护性高；
　　　　缺点：需要整合spring，不能直接调用业务层service；

在执行代码前记得在启动类中加一个 事务注解 

　　

单线程：

　　点击启动类启动，就会每隔十秒执行一次语句

SpringTask 类

@Component//主键
public class SpringTask {
    @Scheduled(cron = "1/10 * * * * ?")
    public void xxx(){
        SimpleDateFormat format = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
        System.err.println("Spring task启动"+ format.format(new Date()));
    }
}

效果：

在类中添加一段代码：

@Component//主键
public class SpringTask {
    @Scheduled(cron = "1/10 * * * * ?")
    public void xxx(){
        SimpleDateFormat format = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
        System.err.println("Spring task启动"+ format.format(new Date()));
        try {
            Thread.sleep(20*1000);
            System.out.println( "模拟正在处理大数据,,,,");
        } catch (InterruptedException e) {
            e.printStackTrace();
        }
    }
}

 

结果是spring task中的定时任务变成了30s执行一次

 

多线程

 Dome4

package com.ting.quartz01.demo;
import com.ting.quartz01.job.RamJob;
import org.quartz.*;
import org.quartz.impl.StdSchedulerFactory;
import static org.quartz.JobBuilder.newJob;
public class Demo4 {
    public static void main(String[] args) throws SchedulerException {
        SchedulerFactory factory = new StdSchedulerFactory();
        Scheduler scheduler = factory.getScheduler();

        JobDetail jobDetail = newJob(RamJob.class)
                .withIdentity("job2","group2")
                .withDescription("这是quartz定时任务")
                .build();

        Trigger trigger = (Trigger)TriggerBuilder.newTrigger()
                .withSchedule(CronScheduleBuilder.cronSchedule("0/5 * * * * ?"))
                .withIdentity("trigger2","group2")
                .withDescription("this is a trigger")
                .build();

        scheduler.scheduleJob(jobDetail,trigger);
        scheduler.start();
    }
}

RamJob

public class RamJob implements Job {
    @Override
    public void execute(JobExecutionContext jobExecutionContext) throws JobExecutionException {
        //此处为quartz定时任务执行的业务内容
            SimpleDateFormat format = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
            System.err.println("quartz task..."+format.format(new Date()));
            try {
                Thread.sleep(20*1000);
                System.out.println("模拟处理大数据量");
            } catch (InterruptedException e) {
                e.printStackTrace();
            }
    }
}

效果：

不管前一个定时任务的线程是否结束，都会开启下一个线程，依然每5s执行一次；

 

 

 

 

谢谢观看！