Quartz定时任务

Quartz

Quartz主要三部分组成，一个任务Job实现类，一个触发器Trigger，一个Scheduler
Scheduler将job和Trigger组合起来，就会触发定时执行Job

引入依赖

<!-- https://mvnrepository.com/artifact/org.quartz-scheduler/quartz -->
<dependency>
    <groupId>org.quartz-scheduler</groupId>
    <artifactId>quartz</artifactId>
    <version>2.3.2</version>
</dependency>

Job

具体的定时任务执行内容，通过JobBuilder构造器来创建

Trigger

定时任务执行的时间，是通过ScheduleBuilder构造器来创建的，但是它有四种构造器

1. SimpleScheduleBuilder
   描述：用于创建简单的重复调度计划，可以设置重复次数和间隔时间。
   示例代码：

   import org.quartz.SimpleScheduleBuilder;
   
   SimpleScheduleBuilder schedule = SimpleScheduleBuilder.simpleSchedule()
       .withIntervalInSeconds(10) // 每10秒执行一次
       .repeatForever(); // 无限次重复
   

   适用场景：适用于需要定期重复执行任务的场景，如每10秒执行一次的任务。

2. CronScheduleBuilder
   描述：用于创建基于 Cron 表达式的调度计划，非常灵活，可以按分钟、小时、天等周期执行。
   示例代码：

   import org.quartz.CronScheduleBuilder;
   
   CronScheduleBuilder schedule = CronScheduleBuilder.cronSchedule("0 0/15 * * * ?");
   // 每15分钟执行一次
   

   适用场景：适用于需要定时执行任务的场景，如每天凌晨1点执行，每15分钟执行一次。

3. DailyTimeIntervalScheduleBuilder
   描述：用于创建每天在固定时间段内重复执行的任务。
   示例代码：

   import org.quartz.DailyTimeIntervalScheduleBuilder;
   import org.quartz.TimeOfDay;
   
   DailyTimeIntervalScheduleBuilder schedule = DailyTimeIntervalScheduleBuilder.dailyTimeIntervalSchedule()
       .startingDailyAt(TimeOfDay.hourAndMinuteOfDay(9, 0)) // 每天9点开始
       .onEveryDay() // 每天
       .withIntervalInHours(1); // 每小时执行一次
   

   适用场景：适用于每天在特定时间段内定期执行任务的场景，如每天9点开始，每小时执行一次。

4. CalendarIntervalScheduleBuilder
   描述：用于创建基于日历单位（如天、周、月等）的调度计划。
   示例代码：

   import org.quartz.CalendarIntervalScheduleBuilder;
   
   CalendarIntervalScheduleBuilder schedule = CalendarIntervalScheduleBuilder.calendarIntervalSchedule()
       .withIntervalInDays(1); // 每天执行一次
   

   适用场景：适用于按日历单位执行任务的场景，如每天、每周、每月执行一次。

一般使用cron表达式来构建时间即可，各种情况都能满足。

Scheduler

将Job和Trigger结合在一起，组成一个定时任务

代码实例

要执行业务逻辑的任务类

import org.quartz.Job;
import org.quartz.JobExecutionContext;
import org.quartz.JobExecutionException;

import java.time.LocalDateTime;

/**
 * 当调度器根据定义的触发器条件触发此任务时，ScheduleJob中的execute方法会被调用执行。它是Quartz调度框架中具体执行业务逻辑的部分。
 */
public class ScheduleJob implements Job {
    @Override
    public void execute(JobExecutionContext jobExecutionContext) throws JobExecutionException {
        System.out.println("--------------"+ LocalDateTime.now());
    }
}

构建调度器并执行定时任务

    public static void main(String[] args) throws SchedulerException {
        /**
         * 构建一个JobDetail，ScheduleJob表示一个具体的任务类，这个类要实现Job接口
         * withIdentity：用于设置 Quartz 任务（Job）或触发器（Trigger）的身份标识，每个任务和触发器都需要有一个唯一的组合标识，以避免冲突并便于调度和管理
         */
        JobDetail jobDetail = JobBuilder.newJob(ScheduleJob.class)
                .withIdentity("job1", "group1").build();

        /**
         * 构建一个SimpleTrigger触发器，
         * withIdentity：用于设置 Quartz 任务（Job）或触发器（Trigger）的身份标识，每个任务和触发器都需要有一个唯一的组合标识，以避免冲突并便于调度和管理
         * withSchedule：配置触发器的调度策略，这里使用SimpleScheduleBuilder，它表示一个简单的调度策略，withIntervalInSeconds指定间隔时间1秒。repeatForever表示一直重复执行
         */
        SimpleTrigger trigger = TriggerBuilder.newTrigger().withIdentity("trigger1", "group1").startNow()
                .withSchedule(SimpleScheduleBuilder.simpleSchedule().withIntervalInSeconds(1)
                        .repeatForever()).build();

        //创建了一个默认的调度器实例scheduler，通过StdSchedulerFactory类获取默认的调度器工厂
        Scheduler scheduler = StdSchedulerFactory.getDefaultScheduler();
        //将JobDetail和SimpleTrigger关联起来
        scheduler.scheduleJob(jobDetail, trigger);
        //开始调度器
        scheduler.start();
    }

jobDataMap

本质就是一个Map，在构建builder的时候，键值对存储在jobDataMap中 ，然后在具体的任务类执行execute的时候，再获取到。可以存到JobDetail中，也可以存到Trigger中，调用的方法都叫usingJobData

• 存值

        JobDetail jobDetail = JobBuilder.newJob(ScheduleJob.class)
                .usingJobData("job1Key", "job1Value")
                .withIdentity("job1", "group1").build();

• 取值

public class ScheduleJob implements Job {
    @Override
    public void execute(JobExecutionContext jobExecutionContext) throws JobExecutionException {
        JobDataMap jobDataMap = jobExecutionContext.getTrigger().getJobDataMap();
        jobDataMap.forEach((k,v)-> System.out.println(k+"--"+v));
        System.out.println("--------------"+ LocalDateTime.now());
    }
}

• 合并JobDetail和Trigger，

JobDataMap mergedJobDataMap = jobExecutionContext.getMergedJobDataMap();

在execute中，可以通过这个方法，把JobDetail和Trigger的jobDataMap合并到一起获取，但是会出现一个问题，就是相同的key会被覆盖

• 自动赋值
  任务类中，如果有对应的属性，给它对应的set方法，在构造器存过值的话，会自动赋值给任务类，当前，JobDetail和Trigger同时存了相同的key，依旧会出现覆盖的问题

        JobDetail jobDetail = JobBuilder.newJob(ScheduleJob.class)
                .usingJobData("job1Key", "job1Value")
                .usingJobData("name","zhangsan")
                .withIdentity("job1", "group1").build();

public class ScheduleJob implements Job {

    private String name;

    public void setName(String name) {
        this.name = name;
    }

    @Override
    public void execute(JobExecutionContext jobExecutionContext) throws JobExecutionException {
        System.out.println("执行任务参数：" + name);
        System.out.println("--------------"+ LocalDateTime.now());
    }
}