分布式定时任务调度框架Quartz

一、Quartz引言

Quartz是一个定时任务调度框架,比如你遇到这样的问题:

  • 比如淘宝的待支付功能,后台会在你生成订单后24小时后,查看订单是否支付,未支付则取消订单
  • 比如vip的每月自动续费功能
  • 想定时在某个时间,去做某件事

Quartz是一套轻量级的任务调度框架,只需要定义了 Job(任务),Trigger(触发器)和 Scheduler(调度器),即可实现一个定时调度能力。支持基于数据库的集群模式,可以做到任务幂等执行。

二、Quartz使用

2.1 导入依赖

        
        <dependency>
            <groupId>org.quartz-schedulergroupId>
            <artifactId>quartzartifactId>
            <version>2.2.3version>
        dependency>

2.2 定义Job

  • 定义一个HelloJob类实现Job类
package com.lyx.job;

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

import java.util.Date;

public class HelloJob implements Job {
    @Override
    public void execute(JobExecutionContext jobExecutionContext) throws JobExecutionException {
        System.out.println("hello job exec"+new Date());
    }
}

2.3 API测试

  • 写个主函数,在主函数里面完成整个Quartz的API的操作过程
package com.lyx.job;

import org.quartz.*;
import org.quartz.impl.StdSchedulerFactory;
import java.util.GregorianCalendar;

public class HelloQuartz {
    public static void main(String[] args) throws SchedulerException {
        //1. 调度器
        Scheduler defaultScheduler = StdSchedulerFactory.getDefaultScheduler();
        //2. trigger触发器
        SimpleTrigger trigger = TriggerBuilder.newTrigger().withIdentity("trigger1","group1")
                .startNow()
                .withSchedule(SimpleScheduleBuilder.simpleSchedule().withIntervalInSeconds(3).repeatForever())
                .endAt(new GregorianCalendar(2022,5,11,16,05,30).getTime())
                .build();
        //3. JobDetail
        JobDetail jobDetail = JobBuilder.newJob(HelloJob.class).withIdentity("job1","group1").build();
        //4. 将JobDetail和trigger增加到调度器
        defaultScheduler.scheduleJob(jobDetail,trigger);
        //5. 启动调度器
        defaultScheduler.start();
    }
}

2.3.1 细节

分布式定时任务调度框架Quartz_第1张图片

  • 任务是有标识的,可以在HelloJob中获取
  • 在上面定义的HelloJob.java中添加代码如下
import org.quartz.*;
import java.util.Date;

public class HelloJob implements Job {
    @Override
    public void execute(JobExecutionContext jobExecutionContext) throws JobExecutionException {
        JobDetail jobDetail = jobExecutionContext.getJobDetail();
        JobKey key = jobDetail.getKey();
        System.out.println(key.getName());
        System.out.println(key.getGroup());
        System.out.println("hello job exec"+new Date());
    }
}

2.4 配置

分布式定时任务调度框架Quartz_第2张图片

#指定调度器名称,非实现类
org.quartz.scheduler.instanceName=DefaultQuartzScheduler
#指定线程池实现类
org.quartz.threadPool.class=org.quartz.simpl.SimpleThreadPool
#线程池线程数量
org.quartz.threadPool.threadCount = 10
#优先级,默认5
org.quartz.threadPool.threadPriority = 5
#非持久化job
org.quartz.jobStore.class=org.quartz.simpl.RAMJobStore

2.5 核心类说明

Scheduler:调度器。所有的调度都是由它控制,是Quartz的大脑,所有任务都是由它来管理
Job:任务,想定时执行的事情(定义业务逻辑)
JobDetail:基于Job,进一步包装,其中关联一个Job,并为Job指定更详细的属性,比如标识等
Trigger:触发器。可以指定给某个任务,指定任务的触发机制

三、Trigger触发器


触发器在Quartz中有很多种

3.1 SimpleTrigger

以一定的时间间隔(单位是毫秒)执行的任务

  • 指定起始和截止时间(时间端)
  • 指定时间间隔、执行次数

分布式定时任务调度框架Quartz_第3张图片

SimpleTrigger trigger = TriggerBuilder.newTrigger().withIdentity("trigger1","group1")
                .startNow()
                .withSchedule(SimpleScheduleBuilder.simpleSchedule()
                        .withIntervalInSeconds(3)//每3秒执行一次
                        .repeatForever())//不限执行次数
                .endAt(new GregorianCalendar(2022,5,5,16,05,30).getTime())
                .build();

分布式定时任务调度框架Quartz_第4张图片

 SimpleTrigger trigger = TriggerBuilder.newTrigger().withIdentity("trigger1","group1")
                .startNow()
                .withSchedule(SimpleScheduleBuilder.simpleSchedule()
                        .withIntervalInSeconds(3)//每3秒执行一次
                        .withRepeatCount(3))//执行次数不超过3次
                .endAt(new GregorianCalendar(2022,5,5,16,05,30).getTime())
                .build();

3.2 CronTrigger(重点)

适合更复制的任务,它支持类似于于Linus Cron的语法(并且更强大)。

  • 指定Cron表达式即可

触发器不再使用startNow()、endAt()
只用withSchedule(CronScheduleBuilder.cronSchedule(“30 01 17 11 5 ?”))
分布式定时任务调度框架Quartz_第5张图片

""里面的数值依次对应:秒、分、时、日、月、周几(?:自动判断周几),时分秒的数值换成*,意思是每个时分秒都执行一次

示例:如下:

CronTrigger trigger = TriggerBuilder.newTrigger().withIdentity("trigger1","group1")
               		 .withSchedule(CronScheduleBuilder.cronSchedule(  "* * * 11 5 ?"))
              		 .build();
  • 意思是5月11日每小时的每分每秒都执行一次
CronTrigger trigger = TriggerBuilder.newTrigger().withIdentity("trigger1","group1")
               		 .withSchedule(CronScheduleBuilder.cronSchedule(  "*/2 * * 11 5 ?"))
               		 .build();
  • 意思是5月11日每小时的每分每2秒执行一次

3.2.1 Cron表达式组成

推荐一个cron在线校验工具:quartz/Cron表达式在线校验工具

表达式组成:“秒 分 时 日 月 星期几 [年]” ,年一般不写

  • 如 :“10 20 18 3 5 ?”代表“5月3日18点20分10秒,星期几不确定”
位置 时间域 允许值 特殊值
1 0~59 , - * /(4种字符)
2 分钟 0~59 , - * /(4种字符)
3 小时 0~23 , - * /(4种字符)
4 日期 1~31 , - * ?/ L W C(8种字符)
5 月份 1~12 , - * ?/ L # C(8种字符)
6 星期 1-7(1代表周日) , - * /(4种字符)
7 年份(可选) , - * /(4种字符)

3.2.2 Cron表达式符号

分布式定时任务调度框架Quartz_第6张图片

以下详细介绍

(1):表示匹配该域的任意值。假如在Minutes域使用, 即表示每分钟都会触发事件。

(2)?:只能用在DayofMonth和DayofWeek两个域。它也匹配域的任意值,但实际不会。因为DayofMonth和DayofWeek会相互影响。例如想在每月的20日触发调度,不管20日到底是星期几,则只能使用如下写法:
13 13 15 20 * ?, 其中最后一位只能用?,而不能使用*,如果使用*表示不管星期几都会触发,实际上并不是这样。

(3)-:表示范围。例如在Minutes域使用5-20,表示从5分到20分钟每分钟触发一次

(4)/:表示起始时间开始触发,然后每隔固定时间触发一次。例如在Minutes域使用5/20,则意味着5分钟触发一次,而25,45等分别触发一次.

(5),:表示列出枚举值。例如:在Minutes域使用5,20,则意味着在5和20分每分钟触发一次。

(6)L:表示最后Last,只能出现在DayofWeek和DayofMonth域。如果在DayofWeek域使用5L,意味着在最后的一个星期四触发。

(7)W:表示有效工作日(周一到周五),只能出现在DayofMonth域,系统将在离指定日期的最近的有效工作日触发事件。例如:在
DayofMonth使用5W,如果5日是星期六,则将在最近的工作日:星期五,即4日触发。如果5日是星期天,则在6日(周一)触发;如果5日在星期一到星期五中的一天,则就在5日触发。另外一点,W的最近寻找不会跨过月份

(8)LW:这两个字符可以连用,表示在某个月最后一个工作日,即最后一个星期五。

(9)#:用于确定每个月第几个星期几,只能出现在DayofWeek域。例如在4#2,表示某月的第二个星期三。

注意:

“/”字符用来指定数值的增量   例如:在子表达式(分钟)里的“0/15”表示从第0分钟开始,每15分钟 在子表达式(分钟)里的“3/20”表示从第3分钟开始,每20分钟(它和“3,23,43”)的含义一样
“?”字符仅被用于天(月)和天(星期)两个子表达式,表示不指定值 当2个子表达式其中之一被指定了值以后,为了避免冲突,需要将另一个子表达式的值设为“?”
 
 “L” 字符仅被用于天(月)和天(星期)两个子表达式,它是单词“last”的缩写   但是它在两个子表达式里的含义是不同的。 在天(月)子表达式中,“L”表示一个月的最后一天 在天(星期)自表达式中,“L”表示一个星期的最后一天,也就是SAT,如果在“L”前有具体的内容,它就具有其他的含义了   例如:“6L”表示这个月的倒数第6天,“FRIL”表示这个月的最一个星期五
  注意:在使用“L”参数时,不要指定列表或范围,因为这会导致问题

3.2.3 Cron表达式示例

三、常用表达式例子

(0)0/20 * * * * ? 表示每20秒 调整任务

(1)0 0 2 1 * ? 表示在每月的1日的凌晨2点调整任务

(2)0 15 10 ? * MON-FRI 表示周一到周五每天上午10:15执行作业

(3)0 15 10 ? 6L 2002-2006 表示2002-2006年的每个月的最后一个星期五上午10:15执行作

(4)0 0 10,14,16 * * ? 每天上午10点,下午2点,4点

(5)0 0/30 9-17 * * ? 朝九晚五工作时间内每半小时

(6)0 0 12 ? * WED 表示每个星期三中午12点

(7)0 0 12 * * ? 每天中午12点触发

(8)0 15 10 ? * * 每天上午10:15触发

(9)0 15 10 * * ? 每天上午10:15触发

(10)0 15 10 * * ? * 每天上午10:15触发

(11)0 15 10 * * ? 2005 2005年的每天上午10:15触发

(12)0 * 14 * * ? 在每天下午2点到下午2:59期间的每1分钟触发

(13)0 0/5 14 * * ? 在每天下午2点到下午2:55期间的每5分钟触发

(14)0 0/5 14,18 * * ? 在每天下午2点到2:55期间和下午6点到6:55期间的每5分钟触发

(15)0 0-5 14 * * ? 在每天下午2点到下午2:05期间的每1分钟触发

(16)0 10,44 14 ? 3 WED 每年三月的星期三的下午2:10和2:44触发

(17)0 15 10 ? * MON-FRI 周一至周五的上午10:15触发

(18)0 15 10 15 * ? 每月15日上午10:15触发

(19)0 15 10 L * ? 每月最后一日的上午10:15触发

(20)0 15 10 ? * 6L 每月的最后一个星期五上午10:15触发

(21)0 15 10 ? * 6L 2002-2005 2002年至2005年的每月的最后一个星期五上午10:15触发

(22)0 15 10 ? * 6#3 每月的第三个星期五上午10:15触发

四、Spring整合Quartz(重点)

4.1 依赖

  
        <dependency>
            <groupId>org.quartz-schedulergroupId>
            <artifactId>quartzartifactId>
            <version>2.2.3version>
        dependency>
        
        <dependency>
            <groupId>org.springframeworkgroupId>
            <artifactId>spring-context-supportartifactId>
            <version>5.1.6.RELEASEversion>
        dependency>
         <dependency>
            <groupId>org.springframeworkgroupId>
            <artifactId>spring-txartifactId>
            <version>5.3.16version>
        dependency>
  • tx不要忘记

4.2 定义Job

分布式定时任务调度框架Quartz_第7张图片

4.3 application.xml中添加配置

接下来用配置文件,替换以下方法中的代码
分布式定时任务调度框架Quartz_第8张图片

  • spring和mybatis和springmvc的配置就不写了,这里只写quartz的配置

<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:context="http://www.springframework.org/schema/context"
       xmlns:aop="http://www.springframework.org/schema/aop"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xsi:schemaLocation="http://www.springframework.org/schema/aop
                           http://www.springframework.org/schema/aop/spring-aop.xsd
                           http://www.springframework.org/schema/beans
                           http://www.springframework.org/schema/beans/spring-beans.xsd
                           http://www.springframework.org/schema/context
                           http://www.springframework.org/schema/context/spring-context.xsd"
>
    

    
    <bean name="lxJob" class="org.springframework.scheduling.quartz.JobDetailFactoryBean">
        <property name="name" value="job1"/>
        <property name="group" value="group1"/>
        <property name="jobClass" value="com.lyx.job.HelloJob"/>
    bean>

    
    <bean id="cronTrigger" class="org.springframework.scheduling.quartz.CronTriggerFactoryBean">
        <property name="name" value="trigger1"/>
        <property name="group" value="group1"/>
        <property name="jobDetail" ref="lxJob"/>
        
        <property name="cronExpression" value="*/5 * * * * ?"/>
    bean>

    
    <bean id="scheduler" class="org.springframework.scheduling.quartz.SchedulerFactoryBean">
        <property name="triggers">
            <list>
                <ref bean="cronTrigger"/>
            list>
        property>
        
        <property name="configLocation" value="classpath:quartz.properties">property>
    bean>
beans>

quartz.properties

#指定调度器名称,非实现类
org.quartz.scheduler.instanceName=DefaultQuartzScheduler
#指定线程池实现类
org.quartz.threadPool.class=org.quartz.simpl.SimpleThreadPool
#线程池线程数量
org.quartz.threadPool.threadCount = 10
#优先级,默认5
org.quartz.threadPool.threadPriority = 5
#非持久化job
org.quartz.jobStore.class=org.quartz.simpl.RAMJobStore

4.4 操作

4.4.1 启动任务

import org.springframework.context.support.ClassPathXmlApplicationContext;

public class QuartzTest {
    public static void main(String[] args) {
        ClassPathXmlApplicationContext context = new ClassPathXmlApplicationContext("application.xml");
    }
}

4.4.2 任务操作

4.4.2.1 删除任务

  • 上面配置文件中定义cron表达式是每秒执行一次
import org.quartz.impl.StdScheduler;
import org.springframework.context.support.ClassPathXmlApplicationContext;

public class QuartzTest {
    public static void main(String[] args) throws InterruptedException, SchedulerException {
        ClassPathXmlApplicationContext context = new ClassPathXmlApplicationContext("application.xml");
        Thread.sleep(3000);
        StdScheduler stdScheduler = (StdScheduler) context.getBean("scheduler");   
        //删除 
      	stdScheduler.deleteJob(JobKey.jobKey("job1","group1"));

    }
}

  • 上面jobKey()的值要和我们配置文件中定义的一致
  • 这里休眠3秒后再执行删除job,运行当前删除方法可以看到3秒后直接job方法不再执行,
  • 运行结果,定义的方法运行3次后被删除

分布式定时任务调度框架Quartz_第9张图片

4.4.2.2 暂停、恢复

import org.quartz.JobKey;
import org.quartz.SchedulerException;
import org.quartz.impl.StdScheduler;
import org.springframework.context.support.ClassPathXmlApplicationContext;

public class QuartzTest {
    public static void main(String[] args) throws InterruptedException, SchedulerException {
        ClassPathXmlApplicationContext context = new ClassPathXmlApplicationContext("applicationContext.xml");
        Thread.sleep(2000);
        StdScheduler stdScheduler = (StdScheduler) context.getBean("scheduler");
        //暂停
        stdScheduler.pauseJob(JobKey.jobKey("job1","group1"));
        //5秒后恢复
        Thread.sleep(5000);
        stdScheduler.resumeJob(JobKey.jobKey("job1","group1"));


    }
}

4.4.2.3 批量操作

  • 定义job时,标识的时候添加了name和group两个值
  • 这个group名,如果有多个job都在这个组中,即group的值都一样
  • 我们就可以同过组名对job方法实现批量操作
  • 暂停和恢复
  • 这里用pauseJobs()方法、resumeJobs()方法
import org.quartz.JobKey;
import org.quartz.SchedulerException;
import org.quartz.impl.StdScheduler;
import org.quartz.impl.matchers.GroupMatcher;
import org.springframework.context.support.ClassPathXmlApplicationContext;

public class QuartzTest {
    public static void main(String[] args) throws InterruptedException, SchedulerException {
        ClassPathXmlApplicationContext context = new ClassPathXmlApplicationContext("applicationContext.xml");
        Thread.sleep(2000);
        StdScheduler stdScheduler = (StdScheduler) context.getBean("scheduler");

        //group1中的job全部暂停
        stdScheduler.pauseJobs(GroupMatcher.groupEquals("group1"));
        //5秒后恢复
        Thread.sleep(5000);
        stdScheduler.resumeJobs(GroupMatcher.groupEquals("group1"));
        


    }
}

你可能感兴趣的:(高级框架,分布式,java,开发语言)