当前位置：首页 > article >正文

Spring Boot 集成 Quartz 实现定时任务（Cron 表达式示例）

article 2025/3/23 14:52:00

Spring Boot 集成 Quartz 实现定时任务（Cron 表达式示例）

- - 前言
  - 1. 添加 Quartz 依赖
  - 2. 创建 Quartz 任务
  - 3. 配置 Quartz 任务调度
  - 4. 启动 Spring Boot 观察定时任务执行
  - 5. Quartz Cron 表达式详解
  - 6. 结论

前言

在 Spring Boot 项目中，我们经常需要定时执行某些任务，例如定期清理数据库、同步数据、发送通知等。Quartz 是一个强大的任务调度框架，可以通过 Cron 表达式 实现灵活的任务调度。本篇文章将介绍如何在 Spring Boot 中集成 Quartz 并使用 Cron 表达式 进行任务调度。

1. 添加 Quartz 依赖

在 Spring Boot 项目中，首先需要引入 Quartz 相关依赖。

如果使用 Maven，在 pom.xml 中添加以下依赖：

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

如果使用 Gradle，则添加：

implementation 'org.springframework.boot:spring-boot-starter-quartz'

2. 创建 Quartz 任务

在 Quartz 中，每个定时任务需要继承 org.quartz.Job 接口，并实现 execute 方法。

import org.quartz.Job;
import org.quartz.JobExecutionContext;
import org.quartz.JobExecutionException;
import java.time.LocalDateTime;

public class MyQuartzJob implements Job {
    @Override
    public void execute(JobExecutionContext context) throws JobExecutionException {
        System.out.println("Quartz 定时任务执行中：" + LocalDateTime.now());
    }
}

3. 配置 Quartz 任务调度

Spring Boot 允许通过 SchedulerFactoryBean 配置 Quartz 任务，并使用 @Bean 方式定义任务的调度规则。

import org.quartz.*;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class QuartzConfig {

    // 定义 JobDetail
    @Bean
    public JobDetail myJobDetail() {
        return JobBuilder.newJob(MyQuartzJob.class)
                .withIdentity("myQuartzJob")  // 任务名称
                .storeDurably()
                .build();
    }

    // 定义触发器，使用 Cron 表达式
    @Bean
    public Trigger myJobTrigger() {
        return TriggerBuilder.newTrigger()
                .forJob(myJobDetail())
                .withIdentity("myQuartzTrigger") // 触发器名称
                .withSchedule(CronScheduleBuilder.cronSchedule("0 0/5 0-7 ? * * *")) // Cron 表达式
                .build();
    }
}

在上述配置中，我们的定时任务：

每 5 分钟执行一次
每天从 00:00 到 07:59 之间执行
使用 Cron 表达式 0 0/5 0-7 ? * * *

如果需要 08:00 也执行一次，可以修改 Cron 表达式为：

0 0/5 0-8 ? * * *

4. 启动 Spring Boot 观察定时任务执行

启动 Spring Boot 项目，观察控制台输出：

Quartz 定时任务执行中：2024-03-19T00:00:00
Quartz 定时任务执行中：2024-03-19T00:05:00
Quartz 定时任务执行中：2024-03-19T00:10:00
...
Quartz 定时任务执行中：2024-03-19T07:55:00

如果 Cron 表达式修改为 0 0/5 0-8 ? * * *，则会多执行一次：

Quartz 定时任务执行中：2024-03-19T08:00:00

5. Quartz Cron 表达式详解

Quartz 的 Cron 表达式有 7 个字段，每个字段的含义如下：

字段	允许值	说明
秒（Seconds）	0-59	任务触发的秒数
分（Minutes）	0-59	任务触发的分钟数
小时（Hours）	0-23	任务触发的小时数
日期（Day of month）	1-31	任务触发的日期（不能与 Day of week 同时指定）
月份（Month）	1-12 或 JAN-DEC	任务触发的月份
星期（Day of week）	1-7 或 SUN-SAT	任务触发的星期几
年（可选）	空或 1970-2099	任务触发的年份