SpringBoot Quartz实现动态定时任务

技术教程
2025-06-27 12:14:05

quartz是一个用于调度定时任务的框架，涉及到以下几个主要概念：

Scheduler：调度器，负责控制所有调度和管理所有任务。

Job：任务，定义具体的业务逻辑。

JobDetail：基于Job的进一步封装，关联一个Job并提供更详细的信息。

Trigger：触发器，用于指定任务的触发机制。

一、创建简单任务

1.1 Quartz依赖

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-quartz</artifactId>
</dependency>

1.2 创建任务

任务创建需要实现Job接口，重写execute(JobExecutionContext jobExecutionContext)方法，添加定时任务的业务逻辑，这里我们只是简单地打印定时任务执行的时间。

@Slf4j
public class SimpleJob implements Job {
    @Override
    public void execute(JobExecutionContext jobExecutionContext) throws JobExecutionException {
        log.info("任务执行时间---" + new Date());
    }
}

1.3 JobDetail增加属性

可以为JobDetail增加属性，以便在Job实现类中获取这些属性来处理业务逻辑。

JobDetail jobDetail = JobBuilder.newJob(SimpleJob.class)
                                .withIdentity("job1", "group1")
                                .usingJobData("name", "J*a旅途")
                                .usingJobData("age", 18)
                                .build();

1.4 Trigger实现

Trigger分为两种类型：SimpleTrigger和CronTrigger。SimpleTrigger是通过Quartz的API实现的简单触发行为，而CronTrigger使用cron表达式进行触发。这里我们先使用SimpleTrigger进行实现。

SimpleTrigger simpleTrigger = TriggerBuilder.newTrigger()
                                            .withIdentity("trigger1", "group1")
                                            .startNow()
                                            .endAt(new Date(System.currentTimeMillis() + 10 * 1000))
                                            .withSchedule(
                                                SimpleScheduleBuilder.simpleSchedule()
                                                .withIntervalInSeconds(1)
                                                .repeatForever()
                                            )
                                            .build();

1.5 启动任务

@Autowired
private Scheduler scheduler;
<p>scheduler.scheduleJob(jobDetail, simpleTrigger);

1.6 执行效果

启动项目后，任务会立即执行，每秒执行一次，10秒后停止。执行效果如下：

SpringBoot Quartz实现动态定时任务

二、动态操作定时任务

钉钉 AI 助理

钉钉AI助理汇集了钉钉AI产品能力，帮助企业迈入智能新时代。

204 查看详情钉钉 AI 助理

有时除了已经开发好的定时任务外，还需要手动创建任务并控制任务的执行。

2.1 创建任务

@GetMapping("create")
public void createJob(String jobName, String jobGroup, String cron, String triggerName, String triggerGroup) throws SchedulerException {
JobKey jobKey = new JobKey(jobName, jobGroup);
if (scheduler.checkExists(jobKey)) {
scheduler.deleteJob(jobKey);
}
JobDetail jobDetail = JobBuilder.newJob(SimpleJob.class)
.withIdentity(jobKey)
.build();
CronScheduleBuilder cronScheduleBuilder = CronScheduleBuilder.cronSchedule(cron);
Trigger trigger = TriggerBuilder.newTrigger()
.withIdentity(triggerName, triggerGroup)
.withSchedule(cronScheduleBuilder).build();
scheduler.scheduleJob(jobDetail, trigger);
}

2.2 暂停任务

@GetMapping("pause")
public void pauseJob(String jobName, String jobGroup) throws SchedulerException {
JobKey jobKey = JobKey.jobKey(jobName, jobGroup);
JobDetail jobDetail = scheduler.getJobDetail(jobKey);
if (jobDetail == null) {
return;
}
scheduler.pauseJob(jobKey);
}

2.3 恢复暂停的任务

@GetMapping("resume")
public void resumeJob(String jobName, String jobGroup) throws SchedulerException {
JobKey jobKey = JobKey.jobKey(jobName, jobGroup);
JobDetail jobDetail = scheduler.getJobDetail(jobKey);
if (jobDetail == null) {
return;
}
scheduler.resumeJob(jobKey);
}

2.4 删除定时任务

@GetMapping("remove")
public void removeJob(String jobName, String jobGroup, String triggerName, String triggerGroup) throws SchedulerException {
TriggerKey triggerKey = TriggerKey.triggerKey(triggerName, triggerGroup);
JobKey jobKey = JobKey.jobKey(jobName, jobGroup);
Trigger trigger = scheduler.getTrigger(triggerKey);
if (trigger == null) {
return;
}
scheduler.pauseTrigger(triggerKey);
scheduler.unscheduleJob(triggerKey);
scheduler.deleteJob(jobKey);
}

三、任务持久化

Quartz默认使用RAMJobStore将任务存储在内存中，但也支持使用JDBC将任务存储在数据库中，以防止任务丢失，通常会将任务存储在数据库中。

这里使用MySQL进行存储。在Quartz的源码包中找到文件tables_mysql_innodb.sql，然后在客户端运行该SQL文件。如果不方便下载源码包，可以直接从GitHub获取表结构。数据表如下：

SpringBoot Quartz实现动态定时任务

3.1 增加MySQL和JDBC依赖

<dependency>
<;groupId>mysql</groupId>
<artifactId>mysql-connector-j*a</artifactId>
<version>8.0.11</version>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-jdbc</artifactId>
</dependency>

3.2 指定使用JDBC存储

Quartz默认使用内存存储，这里修改为使用JDBC进行存储，并配置JDBC的相关信息。

spring:
quartz:
job-store-type: jdbc
datasource:
driver-class-name: com.mysql.cj.jdbc.Driver
url: jdbc:mysql://localhost:3306/simple_fast
username: root
password: root

3.3 创建任务

启动项目，调用create接口创建任务后，数据库中就会新增任务相关的数据。

SpringBoot Quartz实现动态定时任务