一、Quartz介绍
在很多情况下任务并非需要立即执行,而是需要往后或定期执行,这不可能人工去操作,所以定时任务就出现了
使用定时任务的情况:
- 每周末凌晨备份数据
- 触发条件 5 分钟后发送邮件通知
- 30 分钟未支付取消订单
- 每 1 小时去拉取数据
二、Quartz 的使用思路
1)job - 任务- 你要做什么事?
2)Trigger - 触发器- 你什么时候去做?
3)Scheduler - 任务调度- 你什么时候需要去做什么事?
三、基本使用案例
定时任务也是spring的,所以在建立项目的时候也是建立sping项目
1.Scheduled创建定时任务
①开启定时任务
在启动类里面打上注解
@EnableScheduling
②写任务类Task
package com.xhy.code; import lombok.extern.slf4j.Slf4j; import org.springframework.scheduling.annotation.Scheduled; import org.springframework.stereotype.Component; import java.time.LocalDateTime; /** * @author zjjt */ @Component @Slf4j public class Task { @Scheduled(fixedRate = 1000)//1000毫秒=1秒运行一次 public void test(){ log.warn("现在时间:" + LocalDateTime.now()); } }
导入pom文件
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
</dependency>
③测试
2.Scheduled参数
- @Scheduled(fixedRate=5000):上⼀次开始执⾏时间点之后5秒再执⾏
- @Scheduled(fixedDelay=5000):上⼀次执⾏完毕时间点之后5秒再执⾏
- @Scheduled(initialDelay=1000, fixedRate=5000):第⼀次延迟1秒后执⾏,之后fixedRate的规则每5秒执⾏⼀次
- @Scheduled(cron="*/5 * * * * *"):通过cron表达式定义规则
3.cron表达式
cron表达式是一个字符串,以5或者6个空格隔开(示例中是被5个空格隔开),字符串被切割为6个或者7个域,每个域都代表不同的含义
{Seconds} {Minutes} {Hours} {DayofMonth} {Month} {DayofWeek} {Year}
{Seconds} {Minutes} {Hours} {DayofMonth} {Month} {DayofWeek}
每个域都可以用数字表示,还可以出现如下特殊字符
* : 表示匹配该域的任意值,比如Minutes域使用*,就表示每分钟都会触发
- : 表示范围,比如Minutes域使用10-20,就表示从10分钟到20分钟每分钟都会触发一次
, : 表示列出枚举值,比如Minutes域使用1,3.就表示1分钟和3分钟都会触发一次
/ : 表示间隔时间触发(开始时间/时间间隔),例如在Minutes域使用 5/10,就表示从第5分钟开始, 每隔10分钟触发一次? : 表示不指定值,简单理解就是忽略该字段的值,直接根据另一个字段的值触发执行
# : 表示该月第n个星期x(x#n),仅用星期域,如:星期:6#3,表示该月的第三个星期五
L : 表示最后,是单词"last"的缩写(最后一天或最后一个星期几);仅出现在日和星期的域中,用在日则表示该月的最后一天,用在星期则表示该月的最后一个星期,如:星期域上的值为5L,则表示该月最后一个星期的星期四,在使用'L'时,不要指定列表','或范围'-',否则易导致出现意料之外的结果
W: 仅用在日的域中,表示距离当月给定日期最近的工作日(周一到周五),是词"weekday"的缩写
案例:
*/10 * * * * ? 每隔十秒触发一次,每分钟触发6次
0 */5 * * * ? 每隔5分钟触发一次,在这一分钟的第0秒执行
0 2,22,32 * * * ? 在第2分钟,22分钟,32分钟的第0秒都会执行一次
0 0 4-8 * * ? 在第4个小时和第8小时之间的第0分第0秒执行
0 0 2 * * ? 每天的凌晨2点整执行
0 0 2 1 * ? 每个月的1号的凌晨2点整执行
0 * 14 * * ? 每天中午俩点执行一次
0 0/5 14,18 * * ? 每天的14点和18点每隔5分钟都会执行一次
0 0-5 14 * * ? 中午的14点的0到5分钟的第0秒都会执行一次
0 10,44 14 ? 3 3 3月份的星期三的下午俩点的10分和44分的第0秒执行一次
0 15 10 ? * MON-FRI 星期一到星期五10点15分的第0秒执行一次
0 15 10 L * ? 这个月的最后一天10点15分的第0秒执行一次
0 15 10 ? * 6L 2002-2005 2002年到2005年的最后一个星期5的10点15分的第0秒执行一次
- 星期里,1表示的是星期天,2表示的是星期一,以此类推,7表示的是星期六,?只存在于某天或某星期中,且不能同时存在(还不支持同时指定某天和星期),'L'和'W'字符也可以在日期字段中组合以产生'LW',这转换为“最后一个工作日”,法定字符以及月份和星期的名称不区分大小写,如MON 与mon相同
cron表达式生成器
4.Quratz创建定时任务
(1)quratz定时任务的俩种储存方式:
内存方式(RAMJobStore):将任务临时存储到内存中,仅支持单项目部署,项目重启后任务会失效,不支持由调度器控制任务漂移,不建议使用。
数据库方式(JDBCJobStore): Quartz提供了多种数据库的所需表结构脚本,它内部通过 DataSource来操作数据,支持分布式方式部署、支持任务漂移,项目重启后任务不会丢失,直到任务执行完成后才会被从数据库内清除。
(2)使用
①导入quratz官方启动器
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-quartz</artifactId>
</dependency>
②创建SchedulerFactory 调度器工厂,Scheduler 调度器,job定时任务
Scheduler 调度器
用于与调度程序交互的主程序接口.
Scheduler维护了一个JobDetails和Triggers 的注册表。
一旦在Scheduler注册过了,当定时任务触发时间一到,调度程序就会负责执行预先定义的Job调度程序创建之后,处于“待机”状态,必须调用 scheduler 的 start() 方法启用调度程序
可以使用 shutdown() 方法关闭调度程序,使用 isShutdown() 方法判断该调度程序是否已经处于关闭状态通过 Scheduler.scheduleJob(…) 方法将任务纳入调度程序中,当任务触发时间到了的时候,该任务将被执行
job定时任务
任务是一个实现 org.quartz.Job 接口的类,任务类必须含有空构造器
当关联这个任务实例的触发器表明的执行时间到了的时候,调度程序 Scheduler 会调用这个方法来执行
任务,任务内容就可以在这个方法中执行
③新建一个任务job、
*job和jobDetai的区别:一个是模板和一个是实例
package com.xhy.code; import lombok.extern.slf4j.Slf4j; import org.quartz.Job; import org.quartz.JobExecutionContext; import org.quartz.JobExecutionException; @Slf4j public class MyJob implements Job { @Override public void execute(JobExecutionContext jobExecutionContext) throws JobExecutionException { //定义方法工作 log.warn("搞卫生"); } }
④创建一个触发器
Trigger 触发器
触发器使用 TriggerBuilder 来实例化,有一个 TriggerKey 关联,在一个 Scheduler 中必须是唯一的。
多个触发器可以指向同一个工作,但一个触发器只能指向一个工作。
触发器可以传送数据给 job,通过将数据放进触发器的 JobDataMap。
触发器常用属性
触发器也有很多属性,这些属性都是在使用 TriggerBuilder 定义触发器时设置的。
TriggerKey,唯一标识,在一个 Scheduler 中必须是唯一的
startTime,开始时间,通常使用 startAt(java.util.Date)
endTime,结束时间,设置了结束时间则在这之后,不再触发
⑤ 将触发器和任务绑定到调度器
⑥启动(总代码)
package com.xhy.code; import org.junit.jupiter.api.Test; import org.quartz.*; import org.quartz.impl.StdSchedulerFactory; import org.springframework.boot.test.context.SpringBootTest; import org.springframework.context.annotation.Primary; import org.springframework.core.annotation.Order; import java.util.Date; import static org.quartz.JobBuilder.newJob; import static org.quartz.SimpleScheduleBuilder.simpleSchedule; @SpringBootTest class Quartz01ApplicationTests { @Test void contextLoads() throws Exception { //1.实例化调度器工厂 SchedulerFactory factory = new StdSchedulerFactory(); //2.得到调度器 Scheduler scheduler=factory.getScheduler(); //3.创建任务 JobDetail jobDetail = newJob(MyJob.class) .withDescription("开年大扫除")//描述 .withIdentity("a", "b")//任务id .usingJobData("name","张三") .build();//构建 // 4.创建触发器 Trigger trigger = TriggerBuilder.newTrigger() .withDescription("大扫除触发器") .withIdentity("b", "c") .startAt(new Date()) .build(); //5.将触发器和任务绑定到调度器 scheduler.scheduleJob(jobDetail, trigger); //6.启动调度器 scheduler.start(); while (true) { } } }
只执行了一次
触发器优先级
如果没有使用 withIdentity(..) 会自动生成一个触发器名称
有时候,会安排很多任务,但是 Quartz 并没有更多的资源去处理它。
这种情况下,必须需要很好地控制哪个任务先执行。这时候可以设置 priority 属性(使用方法
withPriority(int))来控制触发器的优先级。
优先级只有触发器出发时间一样的时候才有意义。
当一个任务请求恢复执行时,它的优先级和原始优先级是一样的
常见触发器
TriggerBuilder 用于创建 Trigger,如果没有调用 withSchedule(..) 方法,会使用默认的 schedule 。
简单触发器 SimpleTrigger
SimpleTrigger 包含几个特点:开始时间、结束时间、重复次数以及重复执行的时间间隔例如:
Trigger trigger = TriggerBuilder.newTrigger()
.withDescription("")
.withIdentity("clean", "clean1")
.startAt(new Date())
.withSchedule(
simpleSchedule()
.withIntervalInSeconds(10)
.withRepeatCount(10) //SimpleTrigger.REPEAT_INDEFINITELY
)
.build();基于 Cron 表达式的触发器 CronTrigger
Trigger trigger = TriggerBuilder.newTrigger()
.withIdentity("test", "test")
.withDescription("测试的触发器")
.withSchedule(CronScheduleBuilder.cronSchedule("2 * * * * *"))
.build();