定时任务调度框架:Quartz
1 概述
- Quartz 是一个完全由 Java 编写的开源作业调度框架,为在 Java 应用程序中进行作业调度提供了简单却强大的机制。
- Quartz 可以与 J2EE 与 J2SE 应用程序相结合也可以单独使用。
- Quartz 允许程序开发人员根据时间的间隔来调度作业。
- Quartz 实现了作业和触发器的多对多的关系,还能把多个作业与不同的触发器关联。
1.1 Quartz核心概念
- Job 表示一个工作,要执行的具体内容。此接口中只有一个方法,如下:
- JobDetail 表示一个具体的可执行的调度程序,Job 是这个可执行程调度程序所要执行的内容,另外 JobDetail 还包含了这个任务调度的方案和策略。
- Trigger 代表一个调度参数的配置,什么时候去调。
- Scheduler 代表一个调度容器,一个调度容器中可以注册多个 JobDetail 和 Trigger。当 Trigger 与 JobDetail 组合,就可以被 Scheduler 容器调度了。
2 Quartz基本使用
2.1 导入Quartz像个依赖
<dependencies>
<dependency>
<groupId>org.quartz-scheduler</groupId>
<artifactId>quartz</artifactId>
<version>2.2.3</version>
</dependency>
</dependencies>
2.2 定义Job类
public class HelloJob implements Job {
@Override
public void execute(JobExecutionContext jobExecutionContext) throws JobExecutionException {
System.out.println("工作中:" + new Date());
}
}
2.3 测试
public class QuartzTest {
public static void main(String[] args) throws SchedulerException {
Scheduler scheduler = StdSchedulerFactory.getDefaultScheduler();
Trigger trigger = TriggerBuilder.newTrigger()
.withIdentity("t1", "g1")
.startNow()
.withSchedule(SimpleScheduleBuilder
.simpleSchedule().withIntervalInSeconds(1)
.repeatForever())
.endAt(new GregorianCalendar(2021, 1, 27, 10, 0, 0).getTime())
.build();
JobDetail jobDetail = JobBuilder.newJob(HelloJob.class)
.withIdentity("j1", "g1").build();
scheduler.scheduleJob(jobDetail, trigger);
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
3 触发器:Trigger
3.1 SimpleTrigger
- 以一定的时间间隔(单位是毫秒)执行的任务。
- 指定起始和截止时间(时间段)
- 指定时间间隔、执行次数
- 示例:
SimpleTrigger trigger = TriggerBuilder.newTrigger()
.withIdentity("trigger1", "group1")
.startNow()
.withSchedule(SimpleScheduleBuilder.simpleSchedule()
.withIntervalInSeconds(1)
.repeatForever())
.endAt(new GregorianCalendar(2020, 4, 7, 2, 24, 0).getTime())
.build();
3.2 CornTrigger(重点)
- 适合于更复杂的任务,它支持类型于Linux Cron的语法(并且更强大)。
- 示例:
CronTrigger trigger = TriggerBuilder.newTrigger()
.withIdentity("t1", "g1")
.withSchedule(CronScheduleBuilder.cronSchedule("0 0/2 10-12 * * ?")).build();
3.3 Corn表达式
- 表达式组成
- “秒 分 时 日 月 星期几 [年]” ,其中"年" 是可选的,一般不指定。
- 如:"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 # |
7 | 年份(可选) | | , - * / |
符号 | 语义 |
---|
星号(*) | 可用在所有字段中,表示对应时间域的每一个时刻,例如, 在分钟字段时,表示“每分钟” |
问号(?) | 该字符只在日期和星期字段中使用,它通常指定为“不确定值” |
减号(-) | 表达一个范围,如在小时字段中使用“10-12”,则表示从10到12点,即10,11,12 |
逗号(,) | 表达一个列表值,如在星期字段中使用“MON,WED,FRI”,则表示星期一,星期三和星期五 |
斜杠(/) | x/y表达一个等步长序列,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,它的意思是当月的最后一个工作日 |
4 Spring整合Quartz
4.1 导入相关依赖
<properties>
<springframework.version>5.3.3</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类
public class MyJob implements Job {
@Override
public void execute(JobExecutionContext jobExecutionContext) throws JobExecutionException {
System.out.println("job执行中。。。" + new Date());
}
}
4.3 配置applicationContext.xml
<?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">
<bean name="jobDetail" class="org.springframework.scheduling.quartz.JobDetailFactoryBean">
<property name="name" value="job1"/>
<property name="group" value="job_group1"/>
<property name="jobClass" value="job.MyJob"/>
</bean>
<bean id="cronTrigger" class="org.springframework.scheduling.quartz.CronTriggerFactoryBean">
<property name="name" value="trigger1"/>
<property name="group" value="trigger_group1"/>
<property name="jobDetail" ref="jobDetail"/>
<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>
4.4 测试
public class QuartzTest {
public static void main(String[] args) throws InterruptedException, SchedulerException {
ApplicationContext context = new ClassPathXmlApplicationContext("applicationContext.xml");
System.out.println("=======开始工作======");
StdScheduler scheduler = (StdScheduler) context.getBean("scheduler");
System.out.println(scheduler.getClass());
Thread.sleep(3000);
System.out.println("=======暂停工作======");
scheduler.pauseJob(JobKey.jobKey("job1", "job_group1"));
Thread.sleep(3000);
System.out.println("=======恢复工作======");
scheduler.resumeJob(JobKey.jobKey("job1", "job_group1"));
Thread.sleep(3000);
GroupMatcher<JobKey> group1 = GroupMatcher.groupEquals("group1");
scheduler.pauseJobs(group1);
Thread.sleep(2000);
scheduler.resumeJobs(group1);
Thread.sleep(2000);
System.out.println("=======删除工作======");
scheduler.deleteJob(JobKey.jobKey("job1", "job_group1"));
}
}