介绍
Quartz
是OpenSymphony
开源组织在Job scheduling
领域又一个开源项目,是完全由java开发的一个开源的任务日程管理系统,“任务进度管理器”就是一个在预先确定(被纳入日程)的时间到达时,负责执行(或者通知)其他软件组件的系统。
Quartz
用一个小Java
库发布文件(.jar文件),这个库文件包含了所有Quartz
核心功能。这些功能的主要接口(API
)是Scheduler
接口。它提供了简单的操作,例如:将任务纳入日程或者从日程中取消,开始/停止/暂停日程进度。
触发器种类
Quartz
中五种类型的 Trigger:SimpleTrigger,CronTirgger,DateIntervalTrigger,NthIncludedDayTrigger
和Calendar
类( org.quartz.Calendar
)。
最常用的:
SimpleTrigger:
用来触发只需执行一次或者在给定时间触发并且重复N次且每次执行延迟一定时间的任务。CronTrigger:
按照日历触发,例如“每个周五”,每个月10日中午或者10:15分。
存储方式
存储方式分别有RAMJobStore和JDBCJobStore,一个是基于内存,一个是基于数据库
类型 | 优点 | 缺点 |
---|---|---|
RAMJobStore | 不要外部数据库,配置容易,运行速度快 | 因为调度程序信息是存储在被分配给JVM的内存里面,所以,当应用程序停止运行时,所有调度信息将被丢失。另外因为存储到JVM内存里面,所以可以存储多少个Job和Trigger将会受到限制 |
JDBCJobStore | 支持集群,因为所有的任务信息都会保存到数据库中,可以控制事物,还有就是如果应用服务器关闭或者重启,任务信息都不会丢失,并且可以恢复因服务器关闭或者重启而导致执行失败的任务 | 运行速度的快慢取决与连接数据库的快慢 |
表关系和解释
表名称 | 说明 |
---|---|
qrtz_blob_triggers | Trigger作为Blob类型存储(用于Quartz用户用JDBC创建他们自己定制的Trigger类型,JobStore 并不知道如何存储实例的时候) |
qrtz_calendars | 以Blob类型存储Quartz的Calendar日历信息, quartz可配置一个日历来指定一个时间范围 |
qrtz_cron_triggers | 存储Cron Trigger,包括Cron表达式和时区信息。 |
qrtz_fired_triggers | 存储与已触发的Trigger相关的状态信息,以及相联Job的执行信息 |
qrtz_job_details | 存储每一个已配置的Job的详细信息 |
qrtz_locks | 存储程序的悲观锁的信息(假如使用了悲观锁) |
qrtz_paused_trigger_graps | 存储已暂停的Trigger组的信息 |
qrtz_scheduler_state | 存储少量的有关 Scheduler的状态信息,和别的 Scheduler 实例(假如是用于一个集群中) |
qrtz_simple_triggers | 存储简单的 Trigger,包括重复次数,间隔,以及已触的次数 |
qrtz_triggers | 存储已配置的 Trigger的信息 |
qrzt_simprop_triggers |
核心类和关系
QuartzSchedulerThread
:负责执行向QuartzScheduler
注册的触发Trigger
的工作的线程。ThreadPool
:Scheduler
使用一个线程池作为任务运行的基础设施,任务通过共享线程池中的线程提供运行效率。QuartzSchedulerResources
:包含创建QuartzScheduler
实例所需的所有资源(JobStore
,ThreadPool
等)。SchedulerFactory
:提供用于获取调度程序实例的客户端可用句柄的机制。JobStore
:通过类实现的接口,这些类要为
org.quartz.core.QuartzScheduler的使用提供一个
org.quartz.Job和
org.quartz.Trigger存储机制。作业和触发器的存储应该以其名称和组的组合为
唯一性`。QuartzScheduler
:这是Quartz
的核心,它是org.quartz.Scheduler
接口的间接实现,包含调度org.quartz.Jobs
,注册org.quartz.JobListener
实例等的方法。Scheduler
:这是Quartz Scheduler
的主要接口,代表一个独立运行容器。调度程序维护JobDetails和触发器的注册表。 一旦注册,调度程序负责执行作业,当他们的相关联的触发器触发(当他们的预定时间到达时)。Trigger
:具有所有触发器通用属性的基本接口,描述了job
执行的时间出发规则。 - 使用TriggerBuilder实例化实际触发器。JobDetail
:传递给定作业实例的详细信息属性。JobDetails
将使用JobBuilder
创建/定义。Job:
要由表示要执行的“作业”的类实现的接口。只有一个方法void execute(jobExecutionContext context)
(jobExecutionContext
提供调度上下文各种信息,运行时数据保存在jobDataMap
中)
Job
有个子接口StatefulJob
,代表有状态任务。有状态任务不可并发,前次任务没有执行完,后面任务处于阻塞等到。
注意:一个job可以被多个Trigger 绑定,但是一个Trigger只能绑定一个job!
配置文件
quartz.properties
//调度标识名 集群中每一个实例都必须使用相同的名称 (区分特定的调度器实例)
org.quartz.scheduler.instanceName:DefaultQuartzScheduler
//ID设置为自动获取 每一个必须不同 (所有调度器实例中是唯一的)
org.quartz.scheduler.instanceId :AUTO
//数据保存方式为持久化
org.quartz.jobStore.class :org.quartz.impl.jdbcjobstore.JobStoreTX
//表的前缀
org.quartz.jobStore.tablePrefix : QRTZ_
//设置为TRUE不会出现序列化非字符串类到 BLOB 时产生的类版本问题
//org.quartz.jobStore.useProperties : true
//加入集群 true 为集群 false不是集群
org.quartz.jobStore.isClustered : false
//调度实例失效的检查时间间隔
org.quartz.jobStore.clusterCheckinInterval:20000
//容许的最大作业延长时间
org.quartz.jobStore.misfireThreshold :60000
//ThreadPool 实现的类名
org.quartz.threadPool.class:org.quartz.simpl.SimpleThreadPool
//线程数量
org.quartz.threadPool.threadCount : 10
//线程优先级
org.quartz.threadPool.threadPriority : 5(threadPriority 属性的最大值是常量 java.lang.Thread.MAX_PRIORITY,等于10。最小值为常量 java.lang.Thread.MIN_PRIORITY,为1)
//自创建父线程
//org.quartz.threadPool.threadsInheritContextClassLoaderOfInitializingThread: true
//数据库别名
org.quartz.jobStore.dataSource : qzDS
//设置数据源
org.quartz.dataSource.qzDS.driver:com.mysql.jdbc.Driver
org.quartz.dataSource.qzDS.URL:jdbc:mysql://localhost:3306/quartz
org.quartz.dataSource.qzDS.user:root
org.quartz.dataSource.qzDS.password:123456
org.quartz.dataSource.qzDS.maxConnection:10
JDBC插入表顺序
主要的JDBC操作类,执行sql顺序。
Simple_trigger :插入顺序
qrtz_job_details ---> qrtz_triggers ---> qrtz_simple_triggers
qrtz_fired_triggers
Cron_Trigger:插入顺序
qrtz_job_details ---> qrtz_triggers ---> qrtz_cron_triggers
qrtz_fired_triggers
首先大概了解了Quartz的基本知识后,在通过简单的例子入门,一步一个脚印的走下去。
下面介绍Quartz入门的示例,由于Quartz的存储方式分为RAM和JDBC,分别对这两种进行简单的说明
RAM方式案例
编写一个job
package com.shiguiwu.wuhuiit.quartz.ram;
import lombok.extern.slf4j.Slf4j;
import org.quartz.Job;
import org.quartz.JobExecutionContext;
import org.quartz.JobExecutionException;
import java.util.Date;
/**
* @description: 任务
* @author: stone
* @date: Created by 2024/1/22 21:40
* @version: 1.0.0
* @pakeage: com.shiguiwu.wuhuiit.quartz.ram
*/
@Slf4j
public class RAMJob implements Job {
@Override
public void execute(JobExecutionContext jobExecutionContext) throws JobExecutionException {
log.info("say hello quartz {}", new Date());
}
}
##编写测试代码
package com.shiguiwu.wuhuiit.quartz.ram;
import lombok.extern.slf4j.Slf4j;
import org.quartz.CronScheduleBuilder;
import org.quartz.JobBuilder;
import org.quartz.JobDetail;
import org.quartz.ScheduleBuilder;
import org.quartz.Scheduler;
import org.quartz.SchedulerException;
import org.quartz.SchedulerFactory;
import org.quartz.SimpleScheduleBuilder;
import org.quartz.SimpleTrigger;
import org.quartz.Trigger;
import org.quartz.TriggerBuilder;
import org.quartz.impl.StdSchedulerFactory;
import org.springframework.scheduling.quartz.SchedulerFactoryBean;
import java.util.Date;
/**
* @description: 内存的方法定时任务
* @author: stone
* @date: Created by 2024/1/22 21:39
* @version: 1.0.0
* @pakeage: com.shiguiwu.wuhuiit.quartz.ram
*/
@Slf4j
public class RamQuartzTests {
public static void main(String[] args) throws SchedulerException {
//1,创建一个调度工厂
SchedulerFactory sf = new StdSchedulerFactory();
//2,获取一个调度实例
Scheduler scheduler = sf.getScheduler();
//3,获取一个jobDetail
JobDetail jobDetail = JobBuilder.newJob(RAMJob.class)
.withDescription("this is my ram job")
.withIdentity("ramJob", "ramGroup")
.build();
JobDetail jobDetail1 = JobBuilder.newJob(RAMJob.class)
.withDescription("this is my ram job")
.withIdentity("ramJob1", "ramGroup")
.build();
//创建运行时间,只能对简单的触发器起作用
long l = System.currentTimeMillis() + 3 * 1000L;
Date date = new Date(l);
//4.1,创建一个简单的触发器
Trigger simpleTrigger = TriggerBuilder.newTrigger()
.withDescription("this is my simple trigger")
.withIdentity("simpleTrigger", "simpleGroup")
.withSchedule(SimpleScheduleBuilder.simpleSchedule())
.startAt(date)
.build();
//4.2,创建一个cron触发器
Trigger cronTrigger = TriggerBuilder.newTrigger()
.withDescription("this is my cron trigger")
.withIdentity("cronTrigger", "cronGroup")
.withSchedule(CronScheduleBuilder.cronSchedule("0/2 * * * * ?"))
.startAt(date)
.build();
//5,注册到容器中
scheduler.scheduleJob(jobDetail, simpleTrigger);
scheduler.scheduleJob(jobDetail1, cronTrigger);
//6,启动调度器
scheduler.start();
}
}
二、JDBC方式的代码编写案例
使用jdbc方式,就要配置quartz.properties文件,并且在开始的时候在数据库中新增表!
#JDBC驱动
org.quartz.dataSource.qzDS.driver:com.mysql.jdbc.Driver
org.quartz.dataSource.qzDS.URL:jdbc:mysql://localhost:3306/quartz_test
org.quartz.dataSource.qzDS.user:root
org.quartz.dataSource.qzDS.password:root
org.quartz.dataSource.qzDS.maxConnection:10
编写myJob
package com.dufy.jdbctest;
import java.text.SimpleDateFormat;
import java.util.Date;
import org.quartz.Job;
import org.quartz.JobExecutionContext;
import org.quartz.JobExecutionException;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
public class MyJob implements Job{
private static final Logger log = LoggerFactory.getLogger(MyJob.class);
@Override
public void execute(JobExecutionContext context)throws JobExecutionException {
log.info("MyJob is start ..................");
log.info("Hello quzrtz "+
new SimpleDateFormat("yyyy-MM-dd HH:mm:ss ").format(new Date()));
log.info("MyJob is end .....................");
}
}
编写测试类
package com.dufy.jdbctest;
import java.text.ParseException;
import java.util.List;
import org.quartz.CronScheduleBuilder;
import org.quartz.CronTrigger;
import org.quartz.JobBuilder;
import org.quartz.JobDetail;
import org.quartz.JobKey;
import org.quartz.Scheduler;
import org.quartz.SchedulerException;
import org.quartz.SchedulerFactory;
import org.quartz.SimpleScheduleBuilder;
import org.quartz.SimpleTrigger;
import org.quartz.Trigger;
import org.quartz.TriggerBuilder;
import org.quartz.TriggerKey;
import org.quartz.impl.StdSchedulerFactory;
public class QuartzJdbcTest {
public static void main(String[] args) throws SchedulerException,
ParseException {
startSchedule();
//resumeJob();
}
/**
* 开始一个simpleSchedule()调度
*/
public static void startSchedule() {
try {
// 1、创建一个JobDetail实例,指定Quartz
JobDetail jobDetail = JobBuilder.newJob(MyJob.class)
// 任务执行类
.withIdentity("job1_1", "jGroup1")
// 任务名,任务组
.build();
//触发器类型
SimpleScheduleBuilder builder = SimpleScheduleBuilder
// 设置执行次数
.repeatSecondlyForTotalCount(5);
//CronScheduleBuilder builder = CronScheduleBuilder.cronSchedule("0/2 * * * * ?");
// 2、创建Trigger
Trigger trigger = TriggerBuilder.newTrigger()
.withIdentity("trigger1_1", "tGroup1").startNow()
.withSchedule(builder)
.build();
// 3、创建Scheduler
Scheduler scheduler = StdSchedulerFactory.getDefaultScheduler();
scheduler.start();
// 4、调度执行
scheduler.scheduleJob(jobDetail, trigger);
try {
Thread.sleep(60000);
} catch (InterruptedException e) {
e.printStackTrace();
}
//关闭调度器
scheduler.shutdown();
} catch (SchedulerException e) {
e.printStackTrace();
}
}
/**
* 从数据库中找到已经存在的job,并重新开户调度
*/
public static void resumeJob() {
try {
SchedulerFactory schedulerFactory = new StdSchedulerFactory();
Scheduler scheduler = schedulerFactory.getScheduler();
JobKey jobKey = new JobKey("job1_1", "jGroup1");
List<? extends Trigger> triggers = scheduler.getTriggersOfJob(jobKey);
//SELECT TRIGGER_NAME, TRIGGER_GROUP FROM {0}TRIGGERS WHERE SCHED_NAME = {1} AND JOB_NAME = ? AND JOB_GROUP = ?
// 重新恢复在jGroup1组中,名为job1_1的 job的触发器运行
if(triggers.size() > 0){
for (Trigger tg : triggers) {
// 根据类型判断
if ((tg instanceof CronTrigger) || (tg instanceof SimpleTrigger)) {
// 恢复job运行
scheduler.resumeJob(jobKey);
}
}
scheduler.start();
}
} catch (Exception e) {
e.printStackTrace();
}
}
}
Cron和Simple类型,Simple类型的如果JobDetail没有设置.storeDurably(true),则job在运行完成之后会在数据库中删除!