Quartz框架入门及应用场景

最新推荐文章于 2025-03-11 14:30:56 发布

licmi

最新推荐文章于 2025-03-11 14:30:56 发布

阅读量976

点赞数

分类专栏： quartz 文章标签： quartz 触发器

本文链接：https://blog.youkuaiyun.com/licmi/article/details/110531308

版权

quartz 专栏收录该内容

2 篇文章

订阅专栏

Quartz入门案例及应用场景

Quartz简介及应用场景
案例
- Quartz简单触发器 SimpleTrigger介绍
Quartz表达式触发器CronTirgger介绍
Quartz中参数传递
Spring task Vs Quartz

Quartz简介及应用场景

1. Quartz介绍

任务调度框架“Quartz”是OpenSymphony开源组织在Job scheduling领域又一个开源项目，是完全由java开发的一个开源的任务日程管理系统，
“任务进度管理器”就是一个在预先确定（被纳入日程）的时间到达时，负责执行（或者通知）其他软件组件的系统。

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

2. Quartz的触发器

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

五种类型的Trigger(定时器)
SimpleTrigger，CronTirgger，DateIntervalTrigger，NthIncludedDayTrigger和Calendar类（ org.quartz.Calendar）。

场景：
SimpleTrigger：执行N次，重复N次
CronTrigger：几秒几分几时哪日哪月哪周哪年，执行

3. 存储方式

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

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

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

图解quartz工作流程
在这里插入图片描述

quartz相关表达式

在线生成表达式网址：http://cron.qqe2.com
quartz常用表达式
在这里插入图片描述

案例

创建项目
在这里插入图片描述
导入所需pom依赖

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

项目全部依赖

<?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 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.4.0</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.liuchunming</groupId>
    <artifactId>quartz01</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>quartz01</name>
    <description>Demo project for Spring Boot</description>

    <properties>
        <java.version>1.8</java.version>
    </properties>

    <dependencies>
        <!--<dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-jdbc</artifactId>
        </dependency>-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-quartz</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-thymeleaf</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <!--<dependency>
            <groupId>org.mybatis.spring.boot</groupId>
            <artifactId>mybatis-spring-boot-starter</artifactId>
            <version>2.1.4</version>
        </dependency>-->

        <!--<dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <scope>runtime</scope>
        </dependency>-->
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <optional>true</optional>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
        <dependency>
            <groupId>org.quartz-scheduler</groupId>
            <artifactId>quartz-jobs</artifactId>
            <version>2.2.1</version>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-aspects</artifactId>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>

</project>

Quartz简单触发器 SimpleTrigger介绍

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

package com.liuchunming.quartz01.quartz;

import com.liuchunming.quartz01.job.RamJob;
import org.quartz.*;
import org.quartz.impl.StdSchedulerFactory;

import static org.quartz.JobBuilder.newJob;

/**
 * @author liuchunming
 * @site www.liuchunming.com
 * @company xxx公司
 * @create  2020-12-03 10:10
 * 入门级案例
 */
public class Demo {
    public static void main(String[] args) throws Exception {
        SchedulerFactory factory = new StdSchedulerFactory();
//        调度器创建
        Scheduler scheduler = factory.getScheduler();

//        具体定时任务需要执行的代码
        JobDetail jobDetail = newJob(RamJob.class)
                .withIdentity("job1","group1")
                .withIdentity("这是一个作业类案例")
                .build();

        Trigger trigger = (Trigger)TriggerBuilder.newTrigger()
//                重复3次间隔6秒
                .withSchedule(SimpleScheduleBuilder.repeatSecondlyForTotalCount(3,6))
//                触发器标识
                .withIdentity("trigger1","group1")
                .withDescription("这是一个触发器")
                .build();

//       调度工厂绑定作业类及触发器
        scheduler.scheduleJob(jobDetail,trigger);
        scheduler.start();
    }
}

在这里插入图片描述

Quartz表达式触发器CronTirgger介绍

package com.liuchunming.quartz01.quartz;

import com.liuchunming.quartz01.job.RamJob;
import org.quartz.*;
import org.quartz.impl.StdSchedulerFactory;

import static org.quartz.JobBuilder.newJob;

/**
 * @author liuchunming
 * @site www.liuchunming.com
 * @company xxx公司
 * @create  2020-12-03 10:10
 * 表达式触发器
 * 定时定点执行
 */
public class Demo2 {
    public static void main(String[] args) throws Exception {
        //调度器
        SchedulerFactory schedulerFactory=new StdSchedulerFactory();
        Scheduler scheduler = schedulerFactory.getScheduler();
        //作业类
        JobDetail jobDetail=newJob(RamJob.class)
                .withIdentity("job1","group1")
                .withDescription("this is a job1")
                .build();
        //触发器
        Trigger trigger = (Trigger) TriggerBuilder.newTrigger()
                .withSchedule(CronScheduleBuilder.cronSchedule("0 43 10 * * ?"))
                .withIdentity("trigger1","group1")
                .withDescription("this is a trigger1")
                .build();

        //调度器组装作业类及触发器
        scheduler.scheduleJob(jobDetail,trigger);//绑定作业类
        scheduler.start();//启用调度器
    }
}

在这里插入图片描述
遵循某一规律

package com.liuchunming.quartz01.quartz;

import com.liuchunming.quartz01.job.RamJob;
import org.quartz.*;
import org.quartz.impl.StdSchedulerFactory;

import static org.quartz.JobBuilder.newJob;

/**
 * @author liuchunming
 * @site www.liuchunming.com
 * @company xxx公司
 * @create  2020-12-03 10:10
 * 表达式触发器
 *  遵循某一规律
 */
public class Demo3 {
    public static void main(String[] args) throws Exception {
        //调度器
        SchedulerFactory schedulerFactory=new StdSchedulerFactory();
        Scheduler scheduler = schedulerFactory.getScheduler();
        //作业类
        JobDetail jobDetail=newJob(RamJob.class)
                .withIdentity("job1","group1")
                .withDescription("this is a job1")
                .build();
        //触发器
        Trigger trigger = (Trigger) TriggerBuilder.newTrigger()
                .withSchedule(CronScheduleBuilder.cronSchedule("0/10 * * * * ?"))
                .withIdentity("trigger1","group1")
                .withDescription("this is a trigger1")
                .build();

        //调度器组装作业类及触发器
        scheduler.scheduleJob(jobDetail,trigger);//绑定作业类
        scheduler.start();//启用调度器
    }
}

在这里插入图片描述

Quartz中参数传递

Demo4

package com.liuchunming.quartz01.quartz;

import com.liuchunming.quartz01.job.RamJob;
import org.quartz.*;
import org.quartz.impl.StdSchedulerFactory;

import static org.quartz.JobBuilder.newJob;

/**
 * @author liuchunming
 * @site www.liuchunming.com
 * @company xxx公司
 * @create  2020-12-03 10:10
 * 定时任务传参数传递问题
 */
public class Demo4 {
    public static void main(String[] args) throws Exception {
        //调度器
        SchedulerFactory schedulerFactory=new StdSchedulerFactory();
        Scheduler scheduler = schedulerFactory.getScheduler();
        //作业类
        JobDetail jobDetail=newJob(RamJob.class)
                .withIdentity("job1","group1")
                .withDescription("this is a job1")
                .build();
        //将值存入作业类map集合中
        JobDataMap jobDataMap = jobDetail.getJobDataMap();
        jobDataMap.put("name","飞刀");
        jobDataMap.put("level","高级");
        jobDataMap.put("job","教员");
        //触发器
        Trigger trigger = (Trigger) TriggerBuilder.newTrigger()
                .withSchedule(CronScheduleBuilder.cronSchedule("0/10 * * * * ?"))
                .withIdentity("trigger1","group1")
                .withDescription("this is a trigger1")
                .build();

        //调度器组装作业类及触发器
        scheduler.scheduleJob(jobDetail,trigger);//绑定作业类
        scheduler.start();//启用调度器
    }
}

RamJob

package com.liuchunming.quartz01.job;

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

/**
 * @author liuchunming
 * @site www.liuchunming.com
 * @company xxx公司
 * @create  2020-12-03 10:15
 */
public class RamJob implements Job {
    @Override
    public void execute(JobExecutionContext jobExecutionContext) throws JobExecutionException {
        System.out.println("定时任务具体执行的业务逻辑代码");
        JobDataMap jobDataMap = jobExecutionContext.getJobDetail().getJobDataMap();//通过作业类获取参数
        System.out.println(jobDataMap.get("name").toString() + ":" + jobDataMap.get("level").toString() + ":" + jobDataMap.get("job").toString());
        
    }
}

在这里插入图片描述

Spring task Vs Quartz

Spring task
优点：无需整合spring，作业类中就可以调用业务service
缺点：单线程；不能做数据存储型的定时任务

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

论证是String task是单线程,看下方代码如果是单线程30秒打印如果是多线程就是10秒打印
SpringTask

package com.liuchunming.quartz01.task;

import org.springframework.scheduling.annotation.Scheduled;
import org.springframework.stereotype.Component;

import java.text.SimpleDateFormat;
import java.util.Date;

/**
 * @author liuchunming
 * @site www.liuchunming.com
 * @company xxx公司
 * @create  2020-12-03 14:15
 */
@Component
public class SpringTask {

    //论证是String task是单线程
    //单线程30秒打印 如果是多线程就是10秒打印
    @Scheduled(cron = "0/10 * * * * ?")
    public void xxx(){
        SimpleDateFormat format = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
        System.err.println(format.format(new Date())+" : 这是一个spring task...");

        try {
            Thread.sleep(20*1000);
            System.out.println("模拟正在处理大数据....");
        } catch (InterruptedException e) {
            e.printStackTrace();
        }
    }

}

在这里插入图片描述
论证quartz是异步，看下方代码如果是十秒打印一次证明是异步，不会被其他线程干扰
Demo5

package com.liuchunming.quartz01.quartz;

import com.liuchunming.quartz01.job.RamJob;
import org.quartz.*;
import org.quartz.impl.StdSchedulerFactory;

import static org.quartz.JobBuilder.newJob;

/**
 * @author liuchunming
 * @site www.liuchunming.com
 * @company xxx公司
 * @create  2020-12-03 14:32
 */
public class Demo5 {
    public static void main(String[] args) throws SchedulerException {
        SchedulerFactory factory = new StdSchedulerFactory();
//        调度器创建
        Scheduler scheduler = factory.getScheduler();

//        具体定时任务需要执行的代码
        JobDetail jobDetail = newJob(RamJob.class)
                .withIdentity("job2", "group1")
                .withIdentity("这是一个作业类案例")
                .build();

        Trigger trigger = (Trigger) TriggerBuilder.newTrigger()
//                每10s执行一次
                .withSchedule(CronScheduleBuilder.cronSchedule("0/10 * * * * ?"))
//                触发器标识
                .withIdentity("trigger2", "group1")
                .withDescription("这是一个触发器")
                .build();

//       调度工厂绑定作业类及触发器
        scheduler.scheduleJob(jobDetail, trigger);
        scheduler.start();
    }
}

RamJob

package com.liuchunming.quartz01.job;

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

import java.text.SimpleDateFormat;
import java.util.Date;

/**
 * @author liuchunming
 * @site www.liuchunming.com
 * @company xxx公司
 * @create  2020-12-03 10:15
 */
public class RamJob implements Job {
    @Override
    public void execute(JobExecutionContext jobExecutionContext) throws JobExecutionException {
//        System.out.println("定时任务具体执行的业务逻辑代码");
//        JobDataMap jobDataMap = jobExecutionContext.getJobDetail().getJobDataMap();//通过作业类获取参数
//        System.out.println(jobDataMap.get("name").toString() + ":" + jobDataMap.get("level").toString() + ":" + jobDataMap.get("job").toString());

        SimpleDateFormat format = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
        System.err.println(format.format(new Date())+" : 基于RAM的quartz调度框架定时任务...");
        //论证quartz是异步
        //如果是十秒打印一次证明是异步，不会被其他线程干扰
        try {
            Thread.sleep(20*1000);
            System.out.println("模拟正在处理大数据....");
        } catch (InterruptedException e) {
            e.printStackTrace();
        }
    }
}

在这里插入图片描述