Springboot 整合 Quartz 走起！助力任务调度轻而易举！

后端

2023-06-03 14:38:58

在 Springboot 中利用 Quartz 调度任务

任务调度在现代软件开发中至关重要，因为它可以自动化和管理各种任务，例如数据处理、电子邮件发送和系统维护。在 Springboot 中，Quartz 是一个强大的任务调度库，可以让你轻松地调度和管理任务。

Quartz 简介

Quartz 是一个开源的、强大的任务调度框架，用于在分布式系统中计划和执行作业。它提供了全面的功能，包括：

作业调度和执行
触发器管理
持久化和恢复
集群支持
日志记录和审计

Springboot 集成 Quartz

要将 Quartz 集成到 Springboot 中，请遵循以下步骤：

添加 Quartz 依赖项

在你的项目中添加 Quartz 依赖项：

<dependency>
    <groupId>org.quartz-scheduler</groupId>
    <artifactId>quartz</artifactId>
    <version>2.3.2</version>
</dependency>

配置 Quartz

在 application.properties 中配置 Quartz：

# Quartz配置
spring.quartz.job-store-type=jdbc
spring.datasource.url=jdbc:mysql://localhost:3306/quartz
spring.datasource.username=root
spring.datasource.password=123456

启用调度

在项目启动类中添加 @EnableScheduling 注解以启用调度：

@SpringBootApplication
@EnableScheduling
public class App {

    public static void main(String[] args) {
        SpringApplication.run(App.class, args);
    }
}

创建作业

作业是需要调度的可执行代码块。在 Springboot 中，你可以使用 @Component 注解创建作业：

@Component
public class MyJob implements Job {

    @Override
    public void execute(JobExecutionContext context) {
        // 执行任务
        System.out.println("任务执行中...");
    }
}

创建触发器

触发器定义了作业何时应该执行。Springboot 提供了各种触发器选项：

SimpleTrigger：基于固定时间间隔触发作业。
CronTrigger：基于 Cron 表达式触发作业。

以下代码创建了一个每秒重复一次的简单触发器：

@Bean
public JobDetailFactoryBean myJobDetail() {
    JobDetailFactoryBean jobDetailFactory = new JobDetailFactoryBean();
    jobDetailFactory.setJobClass(MyJob.class);
    jobDetailFactory.setName("myJob");
    jobDetailFactory.setDescription("这是我的任务");
    jobDetailFactory.setDurability(true);
    return jobDetailFactory;
}

@Bean
public SimpleTriggerFactoryBean myTrigger() {
    SimpleTriggerFactoryBean triggerFactory = new SimpleTriggerFactoryBean();
    triggerFactory.setJobDetail(myJobDetail().getObject());
    triggerFactory.setName("myTrigger");
    triggerFactory.setDescription("这是我的触发器");
    triggerFactory.setRepeatInterval(1000);
    triggerFactory.setRepeatCount(SimpleTrigger.REPEAT_INDEFINITELY);
    return triggerFactory;
}

启动和关闭调度器

在你的项目中启动和关闭调度器：

@PostConstruct
public void start() {
    schedulerFactory.getScheduler().start();
}

@PreDestroy
public void destroy() {
    schedulerFactory.getScheduler().shutdown();
}

示例代码

以下是一个完整的示例代码：

@SpringBootApplication
@EnableScheduling
public class App {

    public static void main(String[] args) {
        SpringApplication.run(App.class, args);
    }
}

@Component
public class MyJob implements Job {

    @Override
    public void execute(JobExecutionContext context) {
        System.out.println("任务执行中...");
    }
}

@Bean
public JobDetailFactoryBean myJobDetail() {
    JobDetailFactoryBean jobDetailFactory = new JobDetailFactoryBean();
    jobDetailFactory.setJobClass(MyJob.class);
    jobDetailFactory.setName("myJob");
    jobDetailFactory.setDescription("这是我的任务");
    jobDetailFactory.setDurability(true);
    return jobDetailFactory;
}

@Bean
public SimpleTriggerFactoryBean myTrigger() {
    SimpleTriggerFactoryBean triggerFactory = new SimpleTriggerFactoryBean();
    triggerFactory.setJobDetail(myJobDetail().getObject());
    triggerFactory.setName("myTrigger");
    triggerFactory.setDescription("这是我的触发器");
    triggerFactory.setRepeatInterval(1000);
    triggerFactory.setRepeatCount(SimpleTrigger.REPEAT_INDEFINITELY);
    return triggerFactory;
}

@PostConstruct
public void start() {
    schedulerFactory.getScheduler().start();
}

@PreDestroy
public void destroy() {
    schedulerFactory.getScheduler().shutdown();
}