quartz基本概念

入门案例

java 复制代码

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

public class HelloJob implements Job {

    private String j1;

    public void setJ1(String j1) {
        this.j1 = j1;
    }

    @Override
    public void execute(JobExecutionContext context) throws JobExecutionException {
        System.out.println("************任务开始执行***********");

        System.out.println(j1);

        System.out.println("任务执行结束！");
    }
}

java 复制代码

import org.quartz.*;
import org.quartz.impl.StdSchedulerFactory;

import static org.quartz.JobBuilder.*;
import static org.quartz.TriggerBuilder.*;

public class Main {
    public static void main(String[] args) throws Exception {
        JobDetail job1 = newJob(HelloJob.class)
                // 往JobDataMap中传入数据
                .usingJobData("j1", "我是job1")
                // 给JobDetail定义一个唯一标识，group+name唯一确定一个JobDetail
                .withIdentity("job1", "group1")
                .build();
        
        Trigger trigger = newTrigger()
                // 给Trigger定义一个唯一标识，group+name唯一确定一个Trigger
                .withIdentity("trigger1", "group1")
                // 往JobDataMap中传入数据
                .usingJobData("t1", "v1")
                // 规定Trigger触发时间，这里是每秒触发一次
                .withSchedule(SimpleScheduleBuilder.simpleSchedule().withIntervalInSeconds(1).repeatForever())
                .build();

        Scheduler scheduler = StdSchedulerFactory.getDefaultScheduler();
        // 把Trigger和JobDetail绑定起来
        scheduler.scheduleJob(job1, trigger);
        scheduler.start();
    }
}

执行结果

java 复制代码

************任务开始执行***********
我是job1
任务执行结束！
************任务开始执行***********
我是job1
任务执行结束！

基本概念

Job

源码

java 复制代码

public interface Job {
    
    void execute(JobExecutionContext context)
        throws JobExecutionException;
}

这只是一个接口类，定义execute()方法，所有定时任务实现这个接口，在execute()中编写定时任务的具体执行逻辑。我们称实现Job接口的类为任务定义类 ，比如这里的HelloJob类。

JobDetail

可以理解为任务定义类的载体或者为任务定义类的特殊实例。

为什么有了Job还要有JobDetail？

因为Job只是定义任务的执行过程，JobDetail可以附加上任务执行时的特有属性。

你可以只创建一个job类，然后创建多个与该job关联的JobDetail实例，每一个实例都有自己的属性集和JobDataMap，最后，将所有的实例都加到scheduler中。

比如，你创建了一个实现Job接口的类"SalesReportJob"。该job需要一个参数（通过JobdataMap传入），表示负责该销售报告的销售员的名字。因此，你可以创建该job的多个实例（JobDetail），比如"SalesReportForJoe"、"SalesReportForMike"，将"joe"和"mike"作为JobDataMap的数据传给对应的job实例。

Trigger

触发器，用来触发Job的，可以在这里面定义触发时间，比如每周执行一次。

Schedule

scheduler 调度器，定义任务的执行规则。当scheduler执行任务时，创建任务定义类（即实现Job接口的类）的实例，执行完毕后，丢弃该实例的引用，该实例就会被垃圾回收。所以任务定义类中不能使用有状态的数据属性。

JobStore

这个接口主要是定义Job和Trigger的存储机制，比如官方提供的RAMJobStore存储到本地内存，也可以自己实现这个接口实现自己的存储机制。

JobDataMap

包含无限的、序列化的数据对象，可以在任务定义类中通过JobExecutionContext获取到。

JobExecutionContext中的JobDataMap是JobDetail中的JobDataMap和Trigger中的JobDataMap的并集，但是如果存在相同的数据，则后者会覆盖前者的值。

java 复制代码

public class HelloJob implements Job {

    @Override
    public void execute(JobExecutionContext context) throws JobExecutionException {
        System.out.println("************任务开始执行***********");

        JobDataMap jobDataMap = context.getJobDetail().getJobDataMap();
        Object j1 = jobDataMap.get("j1");
        System.out.println(j1);

        System.out.println("任务执行结束！");
    }
}

如果在任务定义类中，给存储在JavaDataMap中的key定义了set方法，那么在任务定义类中不需要显示的从JobDataMap中取数据了。

java 复制代码

public class HelloJob implements Job {

    private String j1;

    public void setJ1(String j1) {
        this.j1 = j1;
    }

    @Override
    public void execute(JobExecutionContext context) throws JobExecutionException {
        System.out.println("************任务开始执行***********");
        System.out.println(j1);
        System.out.println("任务执行结束！");
    }
}