java--Quartz

最新推荐文章于 2023-06-10 16:26:02 发布

DataHamal Mr.张

最新推荐文章于 2023-06-10 16:26:02 发布

阅读量171

点赞数

package com.fync.quartz;

import java.text.SimpleDateFormat;
import java.util.Date;

import org.quartz.Job;
import org.quartz.JobExecutionContext;
import org.quartz.JobExecutionException;
/**
 * 创建要被定执行的任务类
 * @author long
 *
 */
public class MyJob implements Job{

    public void execute(JobExecutionContext context)
            throws JobExecutionException {
        
        System.out.println("任务MyJob");
    }

}

package com.fync.quartz;

import org.quartz.JobBuilder;
import org.quartz.JobDetail;
import org.quartz.Scheduler;
import org.quartz.SchedulerException;
import org.quartz.SchedulerFactory;
import org.quartz.SimpleScheduleBuilder;
import org.quartz.Trigger;
import org.quartz.TriggerBuilder;
import org.quartz.impl.StdSchedulerFactory;

/**
 * 创建任务调度，并执行
 * @author long    
 *
 */
public class MainScheduler {
    
    //创建调度器
    public static Scheduler getScheduler() throws SchedulerException{
        SchedulerFactory schedulerFactory = new StdSchedulerFactory();
        return schedulerFactory.getScheduler();
    }
    
    
    public static void schedulerJob() throws SchedulerException{
        //创建任务
        JobDetail jobDetail = JobBuilder.newJob(MyJob.class).withIdentity("job1", "group1").build();
        //创建触发器 每3秒钟执行一次
        Trigger trigger = TriggerBuilder.newTrigger().withIdentity("trigger1", "group3")
                            .withSchedule(SimpleScheduleBuilder.simpleSchedule().withIntervalInSeconds(3).repeatForever())
                            .build();
        Scheduler scheduler = getScheduler();
        //将任务及其触发器放入调度器
        scheduler.scheduleJob(jobDetail, trigger);
        //调度器开始调度任务
        scheduler.start();
        
    }
    
    public static void main(String[] args) throws SchedulerException {
        MainScheduler mainScheduler = new MainScheduler();
        mainScheduler.schedulerJob();
    }

}

MainScheduler.main()依次创建了scheduler（调度器）、job（任务）、trigger（触发器），其中，job指定了MyJob，trigger保存job的触发执行策略（每隔3s执行一次），scheduler将job和trigger绑定在一起，最后scheduler.start()启动调度，每隔3s触发执行JobImpl.execute()

原理分析：

1、job（任务）

job由若干个class和interface实现。

Job接口

开发者想要job完成什么样的功能，必须且只能由开发者自己动手来编写实现，比如demo中的MyJob，这点无容置疑。但要想让自己的job被quartz识别，就必须按照quartz的规则来办事，这个规则就是job实现类必须实现Job接口，比如MyJob就实现了Job。

Job只有一个execute(JobExecutionContext)，JobExecutionContext保存了job的上下文信息，比如绑定的是哪个trigger。job实现类必须重写execute()，执行job实际上就是运行execute()。

2、JobDetailImpl类 / JobDetail接口

JobDetailImpl类实现了JobDetail接口，用来描述一个job，定义了job所有属性及其get/set方法。了解job拥有哪些属性，就能知道quartz能提供什么样的能力，下面用表格列出job若干核心属性。

属性名	说明
class	必须是job实现类（比如`JobImpl`），用来绑定一个具体job
name	job名称。如果未指定，会自动分配一个唯一名称。所有job都必须拥有一个唯一name，如果两个job的name重复，则只有最前面的job能被调度
group	job所属的组名
description	job描述
durability	是否持久化。如果job设置为非持久，当没有活跃的trigger与之关联的时候，job会自动从scheduler中删除。也就是说，非持久job的生命期是由trigger的存在与否决定的
shouldRecover	是否可恢复。如果job设置为可恢复，一旦job执行时scheduler发生hard shutdown（比如进程崩溃或关机），当scheduler重启后，该job会被重新执行
jobDataMap	除了上面常规属性外，用户可以把任意kv数据存入jobDataMap，实现job属性的无限制扩展，执行job时可以使用这些属性数据。此属性的类型是`JobDataMap`，实现了`Serializable接口`，可做跨平台的序列化传输

3、JobBuilder类

1	`JobDetail jobDetail = JobBuilder.newJob(MyJob.class).withIdentity("job1",` `"group1").build();`

上面代码是demo一个片段，可以看出JobBuilder类的作用：接收job实现类MyJob，生成JobDetail实例，默认生成JobDetailImpl实例。

这里运用了建造者模式：JobImpl相当于Product；JobDetail相当于Builder，拥有job的各种属性及其get/set方法；JobBuilder相当于Director，可为一个job组装各种属性。

4、trigger（触发器）

trigger由若干个class和interface实现。

SimpleTriggerImpl类 / SimpleTrigger接口 / Trigger接口

SimpleTriggerImpl类实现了SimpleTrigger接口，SimpleTrigger接口继承了Trigger接口，它们表示触发器，用来保存触发job的策略，比如每隔几秒触发job。实际上，quartz有两大触发器：SimpleTrigger和CronTrigger，限于篇幅，本文仅介绍SimpleTrigger。

Trigger诸类保存了trigger所有属性，同job属性一样，了解trigger属性有助于我们了解quartz能提供什么样的能力，下面用表格列出trigger若干核心属性。

在quartz源码或注释中，经常使用fire（点火）这个动词来命名属性名，表示触发job。

属性名	属性类型	说明
name	所有trigger通用	trigger名称
group	所有trigger通用	trigger所属的组名
description	所有trigger通用	trigger描述
calendarName	所有trigger通用	日历名称，指定使用哪个Calendar类，经常用来从trigger的调度计划中排除某些时间段
misfireInstruction	所有trigger通用	错过job（未在指定时间执行的job）的处理策略，默认为`MISFIRE_INSTRUCTION_SMART_POLICY`。详见这篇blog [5]
priority	所有trigger通用	优先级，默认为`5`。当多个trigger同时触发job时，线程池可能不够用，此时根据优先级来决定谁先触发
jobDataMap	所有trigger通用	同job的jobDataMap。假如job和trigger的jobDataMap有同名key，通过`getMergedJobDataMap()`获取的jobDataMap，将以trigger的为准
startTime	所有trigger通用	触发开始时间，默认为当前时间。决定什么时间开始触发job
endTime	所有trigger通用	触发结束时间。决定什么时间停止触发job
nextFireTime	SimpleTrigger私有	下一次触发job的时间
previousFireTime	SimpleTrigger私有	上一次触发job的时间
repeatCount	SimpleTrigger私有	需触发的总次数
timesTriggered	SimpleTrigger私有	已经触发过的次数
repeatInterval	SimpleTrigger私有	触发间隔时间

5、TriggerBuilder类

Trigger trigger = TriggerBuilder.newTrigger().withIdentity("trigger1", "group3")
                            .withSchedule(SimpleScheduleBuilder.simpleSchedule().withIntervalInSeconds(3).repeatForever())
                            .build();

上面代码是demo一个片段，可以看出TriggerBuilder类的作用：生成Trigger实例，默认生成SimpleTriggerImpl实例。同JobBuilder一样，这里也运用了建造者模式。