SpringQuartz动态定时任务

常用的动态定时任务

引入依赖

1
2
3
4
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-quartz</artifactId>
</dependency>

自定义定时任务

1
2
3
4
5
6
7
public class WatchVideoClearJob extends QuartzJobBean {

@Override
protected void executeInternal(JobExecutionContext jobExecutionContext) throws JobExecutionException {
// 任务逻辑
}
}

配置定时任务

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
@Bean
public JobDetail watchVideoClearJobDetail() {
// WatchVideoClearJob任务类
return JobBuilder.newJob(WatchVideoClearJob.class)
// 任务名称
.withIdentity("WatchVideoClearJob")
.storeDurably().build();
}

@Bean
public Trigger watchVideoClearJobTrigger() {
// 每天晚上12点执行
CronScheduleBuilder scheduleBuilder = CronScheduleBuilder.cronSchedule("0 0 0 * * ?");
// 返回任务触发器
return TriggerBuilder.newTrigger()
// 加入任务
.forJob(watchVideoClearJobDetail())
// 任务名称
.withIdentity("WatchVideoClearJob")
.withSchedule(scheduleBuilder)
.build();
}

工具类

使用接口实现动态定时任务功能

AdminQuartzDto

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
/**
* 任务id
*/
private String id;

/**
* 任务名称
*/
private String jobName;

/**
* 任务执行类
*/
private String jobClass;

/**
* 任务状态 启动还是暂停
*/
private Integer status;

/**
* 任务运行时间表达式
*/
private String time;

util工具类

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
/**
* 创建定时任务 定时任务创建之后默认启动状态
*
* @param scheduler 调度器
* @param adminQuartzDto 定时任务信息类
* @throws Exception
*/
public static void createScheduleJob(Scheduler scheduler, AdminQuartzDto adminQuartzDto) {
try {
//获取到定时任务的执行类 必须是类的绝对路径名称
//定时任务类需要是job类的具体实现 QuartzJobBean是job的抽象类。
Class<? extends Job> jobClass = (Class<? extends Job>) Class.forName(adminQuartzDto.getJobClass());
// 构建定时任务信息
JobDetail jobDetail = JobBuilder.newJob(jobClass).withIdentity(adminQuartzDto.getJobName()).build();
// 设置定时任务执行方式
CronScheduleBuilder scheduleBuilder = CronScheduleBuilder.cronSchedule(adminQuartzDto.getTime());
// 构建触发器trigger
CronTrigger trigger = TriggerBuilder.newTrigger().withIdentity(adminQuartzDto.getJobName()).withSchedule(scheduleBuilder).build();
scheduler.scheduleJob(jobDetail, trigger);
} catch (ClassNotFoundException e) {
log.error("定时任务类路径出错:请输入类的绝对路径");
} catch (SchedulerException e) {
log.error("创建定时任务出错:" + e.getMessage());
}
}

/**
* 根据任务名称暂停定时任务
*
* @param scheduler 调度器
* @param jobName 定时任务名称
* @throws SchedulerException
*/
public static void pauseScheduleJob(Scheduler scheduler, String jobName) {
JobKey jobKey = JobKey.jobKey(jobName);
try {
scheduler.pauseJob(jobKey);
} catch (SchedulerException e) {
log.error("暂停定时任务出错:" + e.getMessage());
}
}

/**
* 根据任务名称恢复定时任务
*
* @param scheduler 调度器
* @param jobName 定时任务名称
* @throws SchedulerException
*/
public static void resumeScheduleJob(Scheduler scheduler, String jobName) {
JobKey jobKey = JobKey.jobKey(jobName);
try {
scheduler.resumeJob(jobKey);
} catch (SchedulerException e) {
log.error("启动定时任务出错:" + e.getMessage());
}
}

/**
* 根据任务名称立即运行一次定时任务
*
* @param scheduler 调度器
* @param jobName 定时任务名称
* @throws SchedulerException
*/
public static void runOnce(Scheduler scheduler, String jobName) {
JobKey jobKey = JobKey.jobKey(jobName);
try {
scheduler.triggerJob(jobKey);
} catch (SchedulerException e) {
log.error("运行定时任务出错:" + e.getMessage());
}
}

/**
* 更新定时任务
*
* @param scheduler 调度器
* @param adminQuartzDto 定时任务信息类
* @throws SchedulerException
*/
public static void updateScheduleJob(Scheduler scheduler, AdminQuartzDto adminQuartzDto) {
try {
//获取到对应任务的触发器
TriggerKey triggerKey = TriggerKey.triggerKey(adminQuartzDto.getJobName());
//设置定时任务执行方式
CronScheduleBuilder scheduleBuilder = CronScheduleBuilder.cronSchedule(adminQuartzDto.getTime());
//重新构建任务的触发器trigger
CronTrigger trigger = (CronTrigger) scheduler.getTrigger(triggerKey);
trigger = trigger.getTriggerBuilder().withIdentity(triggerKey).withSchedule(scheduleBuilder).build();
//重置对应的job
scheduler.rescheduleJob(triggerKey, trigger);
} catch (SchedulerException e) {
log.error("更新定时任务出错:" + e.getMessage());
}
}

/**
* 根据定时任务名称从调度器当中删除定时任务
*
* @param scheduler 调度器
* @param jobName 定时任务名称
* @throws SchedulerException
*/
public static void deleteScheduleJob(Scheduler scheduler, String jobName) {
JobKey jobKey = JobKey.jobKey(jobName);
try {
scheduler.deleteJob(jobKey);
} catch (SchedulerException e) {
log.error("删除定时任务出错:" + e.getMessage());
}
}

相关文章

SpringCloud

服务注册与发现

服务调用

SpringCloud-GateWay工具类

SpringCloud-OpenFeign问题

DockerCompose常用软件配置

Redis集群搭建

redis分布式锁

服务链路追踪

K8S