初学Quartz任务调度

Quartz任务调度

官方文档

任务调度思维导图

1、基本环节准备

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

2、Demo案例

创建一个任务类实现Job接口

public class HelloJob implements Job {

    /**
     * 在jobDetail中如果传递的参数有message那么会自动通过set方法注入
     * 如果trigger 中也出现了相同名的这个属性
     * 那么会依赖于trigger中的message
     */
    private String message;

    public void setMessage(String message) {
        this.message = message;
    }

    @Override
    public void execute(JobExecutionContext jobExecutionContext) throws JobExecutionException {
        Date date = new Date();
        SimpleDateFormat simpleDateFormat = new SimpleDateFormat("yyyy/MM/dd  HH:mm:ss");
        String format = simpleDateFormat.format(date);
        System.out.println(format);

        System.out.println(jobExecutionContext.getJobDetail().getKey().getGroup());
        System.out.println(jobExecutionContext.getJobDetail().getKey().getClass());
        JobDataMap jobDataMap = jobExecutionContext.getJobDetail().getJobDataMap();
        System.out.println(jobDataMap.get("testMap"));

        //获取任务的实例对象
        System.out.println(jobExecutionContext.getJobInstance().getClass());

        //获取执行任务的实现
        Date fireTime = jobExecutionContext.getFireTime();

        System.out.println("message 的值是======》" + message);
    }
}

创建一个调度器实例，调度并开启任务

public class HelloScheduler {
    public static void main(String[] args) throws Exception{

        //创建调度器实例
        Scheduler defaultScheduler = StdSchedulerFactory.getDefaultScheduler();

        //创建任务实例
        JobDetail build = JobBuilder.newJob(HelloJob.class)
                .withIdentity("test1", "xiaoxiong")
                //将一些必要的参数传递给任务（HelloJob）  ，通过context即可获取
                .usingJobData("testMap","testValue")
                .usingJobData("message","jobDetail")
                .build();

        //创建触发器
        Trigger trigger = TriggerBuilder.newTrigger()
                .withIdentity("trigger1", "xiaoxiao")
								//也可以通过自定的时间段触发   .startAt(date)  endAt(date)
                .startNow() //立即开始
                .withSchedule(SimpleScheduleBuilder.repeatSecondlyForever(10)
															//设置执行次数  n+1次
															.withRepeatCount(n))
                .usingJobData("message", "trigger")
                .build();

        //产生关联
        defaultScheduler.scheduleJob(build, trigger);

        //启动
        defaultScheduler.start();
    }
}

3、有状态的job和无状态的job

有状态的Job可以理解为多次job调用期间可以持有一些状态信息，这些状态信息都存储在jobDataMap中，而默认无状态job每次调用都会创建一个新的jobDataMap。

在HelloJob类上加上@PersistJobDataAfterExecution 注解即可实现有状态的job,该注解保证每次执行任务都是同一个jobDataMap,不用新建

4、SimpleTrigger

• 注意事项
  • SimpleTrigger的属性有：开始时间、结束时间、重复次数（其值可以是0、正数、常量REPEAT_INDEFINITELY = -1）、时间间隔单位是毫秒
  • 如果有指定结束时间属性值，则结束时间属性的优先级要高于重复次数的优先级，这样的好处在于：当我们需要创建没间隔10秒触发一次直到指定的时间结束的Trigger，而无需去计算从开始到结束的重复次数，我们只需简单的自定结束时间和使用REPEAT_INDEFINITELY 作为重复次数的属性即可

5、CronTrigger

可以实现像日历那样按照日程开触发任务，而不是像SimpleTrigger那样每隔特定的时间间隔触发。它是基于日历的作业调度

• cron表达式

  例子 * * * * * *

  Cron表达式解释
  

  这个表达式可以在线生成不用自己计算：网站

6、任务、触发器、调度器之间的关系

7、quartz.properties

默认的配置文件内容如下

# Default Properties file for use by StdSchedulerFactory
# to create a Quartz Scheduler Instance, if a different
# properties file is not explicitly specified.
#
#调度的实例名
org.quartz.scheduler.instanceName: DefaultQuartzScheduler
org.quartz.scheduler.rmi.export: false
org.quartz.scheduler.rmi.proxy: false
org.quartz.scheduler.wrapJobExecutionInUserTransaction: false

#线程池相关属性配置
org.quartz.threadPool.class: org.quartz.simpl.SimpleThreadPool
org.quartz.threadPool.threadCount: 10
org.quartz.threadPool.threadPriority: 5
org.quartz.threadPool.threadsInheritContextClassLoaderOfInitializingThread: true

org.quartz.jobStore.misfireThreshold: 60000

org.quartz.jobStore.class: org.quartz.simpl.RAMJobStore

8、Quartz监听器

Quartz的监听器用于当任务中我们所关注事件发生时，能够及时获取这一事件的通知。主要的监听器有JobListener、TriggerListener、SchedulerListener三种

全局监听器能够接收到所有的Job/Trigger的事件通知，而非全局只能够接收到在其上注册的JOb或者Trigger的时间。