Quartz是一种定时任务调度框架,在项目开发时会用到这种开发技术,学习了解一下!!!

一、引言

Quartz : http://www.quartz-scheduler.org/
是一个定时任务调度框架。比如你遇到这样的问题:

  • 想在30分钟后,查看订单是否支付,未支付则取消订单
  • 想在每月29号,信用卡自动还款
  • 想定时在某个时间,去做某件事(任务)。

Quartz是要做定时任务的调度,设置好触发时间规则,以及相应的任务(Job)即可。

二、Quartz使用

2.1 导入依赖

<dependencies>
	<!--Quartz任务调度-->
	<!-- https://mvnrepository.com/artifact/org.quartz-scheduler/quartz-->
	<dependency>
		<groupId>org.quartz-scheduler</groupId>
		<artifactId>quartz</artifactId>
		<version>2.2.3</version>
	</dependency>
</dependencies>

2.2 定义job

/**
*工作类的具体实现,即需要定时执行的"某件事”
**/
public class He1loQuartz implements Job {
	//执行
	public void execute(JobExecutionContext context) throws JobExecutionException {
		//创建工作详情
		JobDetail jobDetail=context.getJobDetail();//获取工作的名称
		String jobName = jobDetail.getKey(). getName();//任务名
		String jobGroup = jobDetail. getKey().getGroup();//任务group
		System.out.println(" job执行,job: "+jobName+" group : "+jobGroup);
		system.out.println(new Date());
}

2.3 API测试

package com.zpd;

import org.quartz.*;
import org.quartz.impl.StdSchedulerFactory;

import java.util.GregorianCalendar;
public class HelloQuartz {
    public static void main(String[] args) throws SchedulerException {
        //quartz API
        //1. 调度器 Scheduler
        Scheduler scheduler = StdSchedulerFactory.getDefaultScheduler();
        //2. 触发器:描述时间规则,描述任务该如何触发
        //2.1	withIntervalInSeconds(2)每隔2s执行一次
        //2.2	repeatForever一直执行
        SimpleTrigger trigger = TriggerBuilder.newTrigger()
                .withIdentity("trigger01", "group01")
                .startNow()
.withSchedule(SimpleScheduleBuilder.simpleSchedule().withIntervalInSeconds(2).repeatForever())
                .endAt(new GregorianCalendar(2022, 11, 20, 21, 00, 10).getTime())
                .build();
        //3.JobDetail  这是真正的执行逻辑所在
        JobDetail jobDetail = JobBuilder.newJob(HelloJob.class).withIdentity("job01", "group01").build();

        //4. 将 JobDetail 和触发器增加到调度器中
        scheduler.scheduleJob(jobDetail,trigger);
        //5. 启动 调度器开始工作
        scheduler.start();
    }
}

2.4 配置

#名为:quartz.properties,放置在classpath下,如果没有此配置则按默认配置启动
#指定调度器名称,非实现类
org.quartz.scheduler.instanceName =DefaultQuartzScheduler
#指定线程池实现类  任务开始执行时会单独开启一个线程
org.quartz.threadPool.class = org.quartz.simpl.SimpleThreadPool
#线程池线程数量
org. quartz.threadPool.threadCount = 10
#优先级,默认5
org. quartz.threadPoo1.threadPriority =5
#非持久化job
org.quartz.jobStore.class = org.quartz.simp1.AMJobStore

2.5 核心类说明

Scheduler:调度器。所有的调度都是由它控制,是Quartz的大脑,所有任务都是由它来管理

Job:任务,想定时执行的事情(定义业务逻辑)

JobDetail:基于Job,进一步包装。其中关联一个Job,并为Job指定更详细的属性,比如标识等

Trigger:触发器。可以指定给某个任务,指定任务的触发机制。

三、Trigger

3.1 simpleTrigger

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

  • 指定起始时间和截止时间(时间段)

  • 指定时间间隔、执行次数

示例:

SimpleTrigger trigger = TriggerBuilder.newTrigger()
                .withIdentity("trigger01", "group01")
                .startNow()
                .withSchedule(SimpleScheduleBuilder
                .simpleSchedule()
                	.withIntervalInSeconds(2)//每2s执行一次
                	.repeatForever())//不限制执行次数
                .endAt(new GregorianCalendar(2022, 11, 20, 21, 00, 10).getTime())
                .build();
SimpleTrigger trigger = TriggerBuilder.newTrigger()
                .withIdentity("trigger01", "group01")
                .startNow()
                .withSchedule(SimpleScheduleBuilder
                .simpleSchedule()
                	.withIntervalInMinutes(1)//每1分钟执行一次
                	.withRepeatCount(5))//执行次数不超过5次?
                .endAt(new GregorianCalendar(2022, 11, 20, 21, 00, 10).getTime())
                .build();

3.2 CronTrigger(重点)

适合复杂的任务,支持的类型于Linux Cron的语法(并且更加强大)

  • 指定Cron表达式即可

示例:

// 每天10:00-12:00,每隔两分钟执行一次
	CronTrigger trigger = TriggerBuilder.newTrigger()
				.withIndentidy("t1","g1")
				.withSchedule(CronScheduleBuilder.cronSchedule("0 0/2 10-12 * * ?")).build();

3.2.1 Corn表达式

表达式组成:“秒 分 时 日 月 星期几[年]”,其中"年"是可选的,一般不指定

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

3.2.2 Cron表达式符号

表达式中使用的特殊符号的含义如下

符号语义
星号(*)可用在所有字段中,表示对应时间域的每一个时刻,例如,在分钟字段时,表示“每分钟”
问号(?)该字符只在日期和星期字段中使用,它通常指定为“不确定值”
减号(-)表达一个范围,如在小时字段中使用“10-12”,则表示从10到12点,即10,11,12
逗号(,)表达一个列表值,如在星期字段中使用“MON,WED,FRI”,则表示星期一,星期三和星期五
斜杠(/)xy表达一个等步长序列,x为起始值,y为增量步长值。如在分钟字段中使用0/15,则表示为0,15,30和45秒,而5/15在分钟字段中表示5,20,35,50
井号(#)该字符只用在星期字段中,"4#2"代表第二个星期3,“5#4”代表第4个星期四
L该字符只在日期和星期字段中使用,代表“Last”的意思,但它在两个字段中意思不同。
如果L用在星期字段里,则表示星期六,等同于7
L出现在星期字段里,而且在前面有一个数值x,则表示“这个月的最后一个周x”,例如,6L表示该月的最后星期五
L在日期字段中,表示这个月份的最后一天,如一月的31号,非闰年二月的28号
W该字符只能出现在日期字段里,是对前导日期的修饰,表示离该日期最近的工作日
例如15W表示离该月15号最近的工作日,如果该月15号是星期六,则匹配14号星期五;如果15日是星期日,则匹配16号星期一;如果15号是星期二,那结果就是15号星期二;但必须注意关联的匹配日期不能够跨月
LW组合在日期字段可以组合使用LW,它的意思是当月的最后一个工作日

3.2.3 Corn表达式示例

演示示例:

表达式说明
0 0 12 * * ?每天12点运行
0 15 10 * * ?每天10:15运行
0 15 10 * * ? 2008在2008年的每天10:15运行
0 * 14 * * ?每天14点到15点之间每分钟运行一次,开始于14:00,结束于14:59。
0 0/5 14 * * ?每天14点到15点每5分钟运行一次,开始于14:00,结束于14:55。
0 0/5 14,18 * * ?每天14点到15点每5分钟运行一次,此外每天18点到19点每5钟也运行一次。
0 0-514 * * ?每天14:00点到14:05,每分钟运行一次。
0 0-5/2 14 * * ?每天14:00点到14:05,每2分钟运行一次。
0 10,44 14 ? 343月每周三的14:10分和14:44,每分钟运行一次。
0 15 10 ? * 2-6每周一,二,三,四,五的10:15分运行。
0 15 10 15 * ?每月15日10:15分运行。
0 15 10L* ?每月最后一天10:15分运行。
0 15 10 ? * 6L每月最后一个星期五10:15分运行。【此时天必须是"?"】
0 15 10 ? * 6L 2007-2009在2007,2008,2009年每个月的最后一个星期五的10:15分运行。

四、Spring整合Quartz【重点】

4.1 导入依赖

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>org.example</groupId>
    <artifactId>Quartz01</artifactId>
    <version>1.0-SNAPSHOT</version>

    <properties>
        <!--    <maven.compiler.source>8</maven.compiler.source>
                <maven.compiler.target>8</maven.compiler.target>-->
        <springframework.version>5.1.6.RELEASE</springframework.version>
        <quartz.version>2.2.3</quartz.version>

    </properties>
    <dependencies>
        <!--Quartz任务调度-->
        <!-- https://mvnrepository.com/artifact/org.quartz-scheduler/quartz-->
        <dependency>
            <groupId>org.quartz-scheduler</groupId>
            <artifactId>quartz</artifactId>
            <version>2.2.3</version>
        </dependency>

        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-context-support</artifactId>
            <version>${springframework.version}</version>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-tx</artifactId>
            <version>${springframework.version}</version>
        </dependency>
        <dependency>
            <groupId>org.quartz-scheduler</groupId>
            <artifactId>quartz</artifactId>
            <version>${quartz.version}</version>
        </dependency>

    </dependencies>
    <build>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-compiler-plugin</artifactId>
                <version>3.8.0</version>
                <configuration>
                    <source>1.8</source>
                    <target>1.8</target>
                </configuration>
            </plugin>
        </plugins>
    </build>
</project>

4.2 定义Job

定义一个job

public class Myjob implements Job {
    @Override
    public void execute(JobExecutionContext jobExecutionContext) throws JobExecutionException {
        System.out.println("Job执行了");
        System.out.println(new Date()) ;
    }
}

4.3 配置整合文件

JobDetail JobDetailFactorvBean

触发器 CronTriggerFactoryBean

调度器SchedulerFactoryBean

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd">
    <!--
        Spring整合Quartz进行配置遵循下面的步骤:
        1:定义工作任务的Job
        2:定义触发器Trigger,并将触发器与工作任务绑定
        3:定义调度器,并将Trigger注册到Scheduler
    -->
    <!--1∶定义任务的bean ,这里使用JobDetailFactoryBean,也可以使用MethodInvokingJobDetailFactoryBean ,配置类似-->
    <bean name="Job" class="org.springframework.scheduling.quartz.JobDetailFactoryBean ">
        <!--指定job的名称-->
        <property name="name" value="job1"/>
        <!--指定job的分组-->
        <property name="group" value="job_group1"/>
        <!--指定具体的job类-->
        <property name="jobClass" value="com.spring.Myjob"/>
    </bean>

    <!--2:定义触发器的bean,定义一个Cron的Trigger,一个触发器只能和一个任务进行绑定-->
    <bean id="cronTrigger" class="org.springframework.scheduling.quartz.CronTriggerFactoryBean">
        <!--指定Trigger的名称-->
        <property name="name" value="trigger1"/>
        <!--指定Trigger的名称-->
        <property name="group" value="trigger_group1"/>
        <!--指定Tirgger绑定的JobDetail -->
        <property name="jobDetail" ref="Job"/>
        <!--指定Cron的表达式,当前是每隔5s运行一次-->
        <property name="cronExpression" value="* * * * * ?"/>
    </bean>

    <!--3.定义调度器,并将Trigger注册到调度器中-->
    <bean id="scheduler" class="org.springframework.scheduling.quartz.SchedulerFactoryBean">
        <property name="triggers">
            <list>
                <ref bean="cronTrigger"/>
            </list>
        </property>
        <!--添加quartz配置,如下两种方式均可-->
        <!--<property name= " configLocation" value="classpath:quartz.properties"></property>-->
        <property name="quartzProperties">
            <value>
                #指定调度器名称,实际类型为:QuartzScheduler
                org. quartz.scheduler.instanceName = MyScheduler
                #指定连接池
                org.quartz.threadPool.class = org.quartz.simpl.SimpleThreadPool
                #连接池线程数量
                org. quartz.threadPool.threadCount = 11
                #优先级
                org.quartz.threadPool.threadPriority = 5
                #不持久化job
                org.quartz.jobStore.class = org.quartz.simpl.RAMJobStore
            </value>
        </property>
    </bean>
</beans>

4.4 操作

4.4.1 启动任务

工厂启动,调度器启动,任务调度开始

public class QuartzTest {
  public static void main(String[] args) throws InterruptedException, SchedulerException {
  ApplicationContext applicationContext = new ClassPathXmlApplicationContext("applicationContext.xml");
  }
}

4.4.2 删除任务

public class QuartzTest {
    public static void main(String[] args) throws InterruptedException, SchedulerException {
        ApplicationContext applicationContext = new ClassPathXmlApplicationContext("applicationContext.xml");
        Thread.sleep(5000);
        StdScheduler stdScheduler = (StdScheduler) applicationContext.getBean("scheduler");
        //任务删除
        stdScheduler.deleteJob(JobKey.jobKey("job1","job_group1"));
    }
}

4.4.3 暂停、恢复

public class QuartzTest {
    public static void main(String[] args) throws InterruptedException, SchedulerException {
        ApplicationContext applicationContext = new ClassPathXmlApplicationContext("applicationContext.xml");
        Thread.sleep(5000);
        StdScheduler stdScheduler = (StdScheduler) applicationContext.getBean("scheduler");
        
        stdScheduler.pauseJob(JobKey.jobKey("job1","job_group1"));
        System.out.println("暂停");
        Thread.sleep(3000);
        System.out.println("恢复");
        stdScheduler.resumeJob(JobKey.jobKey("job1","job_group1"));
    }
}

4.4.4 批量操作

public class QuartzTest {
    public static void main(String[] args) throws InterruptedException, SchedulerException {
        ApplicationContext applicationContext = new ClassPathXmlApplicationContext("applicationContext.xml");
        Thread.sleep(5000);
        StdScheduler stdScheduler = (StdScheduler) applicationContext.getBean("scheduler");
        stdScheduler.pauseJobs(GroupMatcher.jobGroupEquals("job_group1"));
        System.out.println("暂停");
        Thread.sleep(3000);
        System.out.println("恢复");
        stdScheduler.resumeJobs(GroupMatcher.jobGroupEquals("job_group1"));
    }
}
  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值