142 Quartz

最新推荐文章于 2024-11-05 08:15:00 发布

悬浮海

最新推荐文章于 2024-11-05 08:15:00 发布

阅读量404

点赞数

CC 4.0 BY-SA版权

分类专栏： # Spring体系框架应用文章标签： quartz

本文链接：https://blog.youkuaiyun.com/wang_luwei/article/details/108541381

Spring体系框架应用专栏收录该内容

46 篇文章

订阅专栏

一、引言

1.1简介

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

package com.wlw.job;

import org.quartz.*;

import java.util.Date;

//定义一个JOb类  这是一个任务
public class HelloJob implements Job {
    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());//任务group
        System.out.println("hello quartz" + new Date());
    }
}

2.3API测试

package com.wlw.job;

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. 触发器：
        SimpleTrigger trigger = TriggerBuilder.newTrigger().withIdentity("trigger1", "group1")
                .startNow()
                .withSchedule(SimpleScheduleBuilder.simpleSchedule()
                        .withIntervalInMilliseconds(1) //每隔一秒执行一次
                        //.repeatForever()  //一直执行，直到结束时间
                        .withRepeatCount(10)) //共执行十次
                .endAt(new GregorianCalendar(2020, 8, 8, 14, 44, 50).getTime())
                .build();
        // 3. JobDetail
        JobDetail jobDetail = JobBuilder.newJob(HelloJob.class).withIdentity("job1","group1").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.threadPool.threadPriority = 5
# 非持久化job
org.quartz.jobStore.class = org.quartz.simpl.RAMJobStore

2.5核心类说明

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

三、Trgger

3.1 SimpleTrigger

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

指定起始和截止时间(时间段)
指定时间间隔、执行次数
示例:

SimpleTrigger trigger = TriggerBuilder.newTrigger()
    			.withIdentity("trigger1", "group1")
                .startNow()
                .withSchedule(SimpleScheduleBuilder.simpleSchedule()
                        .withIntervalInMilliseconds(1) //每隔一秒执行一次
                        .repeatForever()  //一直执行，直到结束时间
                .endAt(new GregorianCalendar(2020, 8, 8, 14, 44, 50).getTime())
                .build();

SimpleTrigger trigger = TriggerBuilder.newTrigger()
    			.withIdentity("trigger1", "group1")
                .startNow()
                .withSchedule(SimpleScheduleBuilder.simpleSchedule()
                        .withIntervalInMilliseconds(1) //每隔一秒执行一次
                        .withRepeatCount(10)) //共执行十次
                .endAt(new GregorianCalendar(2020, 8, 8, 14, 44, 50).getTime())
                .build();

3.2 CronTrigger [重点]

适合于更复杂的任务，它支持类型于Linux Cron的语法(并且更强大)
指定Cron表达式即可
示例:

CronTrigger trigger = TriggerBuilder.newTrigger().withIdentity("trigger1", "group1")
                .withSchedule(CronScheduleBuilder.cronSchedule("*/2 * * 8 9 ?"))
    			//9月8日 每隔2秒执行一次
                .build();

3.2.1 Cron表达式组成

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

如: "10 20 18 3 5 ？"代表"5月3日18点20分10秒，星期几不确定”

位置	时间域	允许值	特殊值
1	秒	0-59	，- * /
2	分钟	0-59	，- * /
3	小时	0-23	，- * /
4	日期	1-31	, - * ? / L W
5	月份	1-12	，- * /
6	星期	1-7	, - * ? / L W
7	年份(可选)		，- * /

3.2.2 Cron表达式符号

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

在这里插入图片描述

3.2.3 Cron表达式示例

演示实例

在这里插入图片描述

四、Spring整合Quartz 【重点】

4.1依赖

<properties>
        <springframework.version>5.1.6.RELEASE</springframework.version>
        <quartz.version>2.2.3</quartz.version>
    </properties>

    <dependencies>

        <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>

4.2定义job

定义一个job类

package com.wlw.quartz;

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

import java.util.Date;

public class MyJob implements Job {
    public void execute(JobExecutionContext context) throws JobExecutionException {
        System.out.println("job 执行了");
        System.out.println(new Date());
    }
}

4.3配置

调度器SchedulerFactoryBean
触发器CronTriggerFactoryBean
JobDetail JobDetailFactoryBean
applicationContext.xml （Spring配置文件中）

<?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="lxJob" 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.wlw.quartz.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="lxJob"/>
        <!-- 指定Cron 的表达式 ，当前是每隔5s运行一次 -->
        <property name="cronExpression" value="*/2 * * * * ?" />
    </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 static void main(String[] args) throws InterruptedException, SchedulerException {
		// 工厂启动，任务启动，工厂关闭，任务停止
        ApplicationContext context = new ClassPathXmlApplicationContext("applicationContext.xml");
       
    }

4.4.2任务操作

4.4.2.1删除任务

package com.wlw.test;

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

public class QuartzTest {

    public static void main(String[] args) throws InterruptedException, SchedulerException {

        ApplicationContext context = new ClassPathXmlApplicationContext("applicationContext.xml");

        Thread.sleep(5000);

        StdScheduler stdScheduler = (StdScheduler) context.getBean("scheduler");
        //任务删除
        stdScheduler.deleteJob(JobKey.jobKey("job1","job_group1")); //每秒执行一次，执行了6次，因为第一次不算 
    }
}

4.4.2.2暂停、恢复

package com.wlw.test;

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

public class QuartzTest {

    public static void main(String[] args) throws InterruptedException, SchedulerException {

        ApplicationContext context = new ClassPathXmlApplicationContext("applicationContext.xml");

        Thread.sleep(5000);
StdScheduler stdScheduler = (StdScheduler) context.getBean("scheduler");
        //任务暂停
        stdScheduler.pauseJob(JobKey.jobKey("job1","job_group1"));
        Thread.sleep(3000);
        //任务恢复
        stdScheduler.resumeJob(JobKey.jobKey("job1","job_group1"));
    }
}

4.4.2.5批量操作

package com.wlw.test;

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

public class QuartzTest {

    public static void main(String[] args) throws InterruptedException, SchedulerException {

        ApplicationContext context = new ClassPathXmlApplicationContext("applicationContext.xml");

        Thread.sleep(5000);

        StdScheduler stdScheduler = (StdScheduler) context.getBean("scheduler");

     	// 批量操作
        stdScheduler.pauseJobs(GroupMatcher.<JobKey>groupEquals("job_group1"));
        Thread.sleep(3000);
        stdScheduler.resumeJobs(GroupMatcher.<JobKey>groupEquals("job_group1"));
    }
}