浅谈JobExecutionContext与JobDataMap

Posted 2020-10-29 Qiao_Zhi

tags:

篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了浅谈JobExecutionContext与JobDataMap相关的知识，希望对你有一定的参考价值。

1.JobExecutionContext简介

(1)当Scheduler调用一个Job，就会将JobExecutionContext传递给job的execute方法

　　quartz无法调用job的有参构造函数，所以创建job的实例的时候是运用反射机制，通过newInstance创建实例，并且通过JobDetail描述的name与group属性然后给Job设置一些属性。

(2)Job能通过JobExecutionContext对象访问到Quartz运行时候的环境以及Job本身的明细数据。

2.JobDataMap简介:

1.JobDataMap是什么?

(1)在进行任务调度时JobDataMap存储在JobExecutionContext中，非常方便获取

(2)JobDataMap可以用来装载任何可以序列化的数据对象，当job实例对象被执行时这些参数对象会传递给它

(3)JobDataMap实现了JDK的Map接口，并且添加了一些非常方便的方法用来存取数据基本数据类型。

2.获取JobDataMap的两种方式:

第一种方式:从JobExecutionContext实例中获取

(1)从实例中获取JobDetail与Trigger单独的JobDataMap的方法

例如:

HelloJob.java(JobExecutionContext获取JobDataMap以及获取JobDetail和Trigger的标识信息)

package cn.qlq.quartz;

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

import org.quartz.Job;
import org.quartz.JobDataMap;
import org.quartz.JobExecutionContext;
import org.quartz.JobExecutionException;
import org.quartz.JobKey;
import org.quartz.TriggerKey;

public class HelloJob implements Job {
    public void execute(JobExecutionContext context) throws JobExecutionException {
        //打印当前的时间
        Date date = new Date();
        SimpleDateFormat sf = new SimpleDateFormat("yyyy-MM-dd hh:mm:ss");
        System.out.println("current time is:"+sf.format(date));
        // 编写具体的业务逻辑
        JobKey key = context.getJobDetail().getKey();//获取JobDetail的标识信息
        System.out.println("JobDetail\'s name and group are "+key.getName()+":"+key.getGroup());
        TriggerKey triggerKey = context.getTrigger().getKey();//获取Trigger的标识信息
        System.out.println("Trigger\'s name and group are "+triggerKey.getName()+":"+triggerKey.getGroup());
        //获取JobDetail通过JobDataMap传递的参数信息
        JobDataMap jobDataMap = context.getJobDetail().getJobDataMap();
        String jobMessage = jobDataMap.getString("message");
        Float floatValue = jobDataMap.getFloat("floatValue");
        System.out.println(jobMessage+"\\t"+floatValue);
        //获取Trigger通过JobDataMap传递的信息
        JobDataMap triggerDataMap = context.getTrigger().getJobDataMap();
        String triggerMessage = triggerDataMap.getString("message");
        Double DoubleValue = triggerDataMap.getDouble("DoubleValue");
        System.out.println(triggerMessage+"\\t"+DoubleValue);
        
    }
}

HelloScheduler.java 通过usingJobData传递一些参数(JobDetail和Trigger都能使用此方法传递参数)

package cn.qlq.quartz;

import static org.quartz.DateBuilder.newDate;
import static org.quartz.JobBuilder.newJob;
import static org.quartz.SimpleScheduleBuilder.simpleSchedule;
import static org.quartz.TriggerBuilder.newTrigger;

import java.util.GregorianCalendar;

import org.quartz.JobDetail;
import org.quartz.Scheduler;
import org.quartz.SimpleScheduleBuilder;
import org.quartz.Trigger;
import org.quartz.TriggerBuilder;
import org.quartz.impl.StdSchedulerFactory;
import org.quartz.impl.calendar.AnnualCalendar;

public class HelloScheduler {

    public static void main(String[] args) {
        try {
            //1. 创建一个JodDetail实例 将该实例与Hello job class绑定    (链式写法)
            JobDetail jobDetail = newJob(HelloJob.class) // 定义Job类为HelloQuartz类，这是真正的执行逻辑所在
                    .withIdentity("myJob") // 定义name/group
                    .usingJobData("message","Hello myjob1")//使用JobDataMap传递参数给Job，传递一个string类型参数
                    .usingJobData("floatValue",8.5f)//使用JobDataMap传递参数给Job，传递一个float类型
                    .build();

            //2. 定义一个Trigger，定义该job立即执行，并且每两秒钟执行一次，直到永远
            Trigger trigger = TriggerBuilder.newTrigger().withIdentity("myTrigger", "group1")// 定义名字和组
                    .startNow()//现在开始
                    .withSchedule(SimpleScheduleBuilder.simpleSchedule().withIntervalInSeconds(2).repeatForever())
                    .usingJobData("message","Hello trigger1")
                    .usingJobData("DoubleValue",2.5D)
                    .build();
            
            //3. 创建scheduler
            Scheduler scheduler = StdSchedulerFactory.getDefaultScheduler();

            //4. 将trigger和jobdetail加入这个调度
            scheduler.scheduleJob(jobDetail, trigger);

            //5. 启动scheduler
            scheduler.start();

        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

结果:

current time is:2018-04-04 09:53:15
JobDetail\'s name and group are myJob:DEFAULT
Trigger\'s name and group are myTrigger:group1
Hello myjob1 8.5
Hello trigger1 2.5

(2)从实例中获取JobDetail与Trigger合并的JobDataMap的方法

　　理论上是将JobDatail的JobDataMap和Trigger的JobDataMap合并，当我们获取两者有相同的key值的时候，优先获取的是Trigger的值，也就是JobDatail的会被覆盖

例如:

HelloJob.java(获取两者合并后的JobDataMap)

package cn.qlq.quartz;

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

import org.quartz.Job;
import org.quartz.JobDataMap;
import org.quartz.JobExecutionContext;
import org.quartz.JobExecutionException;
import org.quartz.JobKey;
import org.quartz.TriggerKey;

public class HelloJob implements Job {
    public void execute(JobExecutionContext context) throws JobExecutionException {
        //打印当前的时间
        Date date = new Date();
        SimpleDateFormat sf = new SimpleDateFormat("yyyy-MM-dd hh:mm:ss");
        System.out.println("current time is:"+sf.format(date));
        // 编写具体的业务逻辑
        JobKey key = context.getJobDetail().getKey();//获取JobDetail的标识信息
        System.out.println("JobDetail\'s name and group are "+key.getName()+":"+key.getGroup());
        TriggerKey triggerKey = context.getTrigger().getKey();//获取Trigger的标识信息
        System.out.println("Trigger\'s name and group are "+triggerKey.getName()+":"+triggerKey.getGroup());
        //获取JobDetail通过JobDataMap传递的参数信息(获取两者合并后的JobDataMap)
        JobDataMap jobDataMap = context.getMergedJobDataMap();
        String message = jobDataMap.getString("message");
        Float floatValue = jobDataMap.getFloat("floatValue");
        System.out.println("message is :"+message);
        System.out.println("floatValue is :"+floatValue);
        Double DoubleValue = jobDataMap.getDouble("DoubleValue");
        System.out.println("DoubleValue is :"+DoubleValue);
        
    }
}

HelloScheduler.java

package cn.qlq.quartz;

import static org.quartz.DateBuilder.newDate;
import static org.quartz.JobBuilder.newJob;
import static org.quartz.SimpleScheduleBuilder.simpleSchedule;
import static org.quartz.TriggerBuilder.newTrigger;

import java.util.GregorianCalendar;

import org.quartz.JobDetail;
import org.quartz.Scheduler;
import org.quartz.SimpleScheduleBuilder;
import org.quartz.Trigger;
import org.quartz.TriggerBuilder;
import org.quartz.impl.StdSchedulerFactory;
import org.quartz.impl.calendar.AnnualCalendar;

public class HelloScheduler {

    public static void main(String[] args) {
        try {
            //1. 创建一个JodDetail实例 将该实例与Hello job class绑定    (链式写法)
            JobDetail jobDetail = newJob(HelloJob.class) // 定义Job类为HelloQuartz类，这是真正的执行逻辑所在
                    .withIdentity("myJob") // 定义name/group
                    .usingJobData("message","Hello myjob1")//使用JobDataMap传递参数给Job，传递一个string类型参数
                    .usingJobData("floatValue",8.5f)//使用JobDataMap传递参数给Job，传递一个float类型
                    .build();

            //2. 定义一个Trigger，定义该job立即执行，并且每两秒钟执行一次，直到永远
            Trigger trigger = TriggerBuilder.newTrigger().withIdentity("myTrigger", "group1")// 定义名字和组
                    .startNow()//现在开始
                    .withSchedule(SimpleScheduleBuilder.simpleSchedule().withIntervalInSeconds(2).repeatForever())
                    .usingJobData("message","Hello trigger1")
                    .usingJobData("DoubleValue",2.5D)
                    .build();
            
            //3. 创建scheduler
            Scheduler scheduler = StdSchedulerFactory.getDefaultScheduler();

            //4. 将trigger和jobdetail加入这个调度
            scheduler.scheduleJob(jobDetail, trigger);

            //5. 启动scheduler
            scheduler.start();

        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

运行结果:(如果JobDetail和Trigger的传递参数相同，使用合并后的JobDataMap获取的时候优先获取Trigger的参数)

第二种方式:Job实现类添加setter方法对应JobDataMap的键值(Quartz框架默认的JobFactory实现类在初始化job实例对象时会自动调用这些setter方法)

例如:

HelloJob.java(添加成员属性，并且添加对应的get，set方法，类似于struts的属性注入，当我们在使用JobDataMap添加数据的时候会自动映射到这个类的成员实现方法中，需要注意的是成员属性的名字要和jobDataMap添加时候的key值相同)

package cn.qlq.quartz;

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

import org.quartz.Job;
import org.quartz.JobDataMap;
import org.quartz.JobExecutionContext;
import org.quartz.JobExecutionException;
import org.quartz.JobKey;
import org.quartz.TriggerKey;

public class HelloJob implements Job {
    
    private String message;
    private Float floatValue;
    private Double DoubleValue;

    public void execute(JobExecutionContext context) throws JobExecutionException {
        //打印当前的时间
        Date date = new Date();
        SimpleDateFormat sf = new SimpleDateFormat("yyyy-MM-dd hh:mm:ss");
        System.out.println("current time is:"+sf.format(date));
        // 编写具体的业务逻辑
        JobKey key = context.getJobDetail().getKey();//获取JobDetail的标识信息
        System.out.println("JobDetail\'s name and group are "+key.getName()+":"+key.getGroup());
        TriggerKey triggerKey = context.getTrigger().getKey();//获取Trigger的标识信息
        System.out.println("Trigger\'s name and group are "+triggerKey.getName()+":"+triggerKey.getGroup());
        System.out.println("message is :"+message);
        System.out.println("floatValue is :"+floatValue);
        System.out.println("DoubleValue is :"+DoubleValue);
    }

    public String getMessage() {
        return message;
    }

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

    public Float getFloatValue() {
        return floatValue;
    }

    public void setFloatValue(Float floatValue) {
        this.floatValue = floatValue;
    }

    public Double getDoubleValue() {
        return DoubleValue;
    }

    public void setDoubleValue(Double doubleValue) {
        DoubleValue = doubleValue;
    }
    
}

HelloScheduler.java

package cn.qlq.quartz;

import static org.quartz.DateBuilder.newDate;
import static org.quartz.JobBuilder.newJob;
import static org.quartz.SimpleScheduleBuilder.simpleSchedule;
import static org.quartz.TriggerBuilder.newTrigger;

import java.util.GregorianCalendar;

import org.quartz.JobDetail;
import org.quartz.Scheduler;
import org.quartz.SimpleScheduleBuilder;
import org.quartz.Trigger;
import org.quartz.TriggerBuilder;
import org.quartz.impl.StdSchedulerFactory;
import org.quartz.impl.calendar.AnnualCalendar;

public class HelloScheduler {
    public static void main(String[] args) {
        try {
            //1. 创建一个JodDetail实例 将该实例与Hello job class绑定    (链式写法)
            JobDetail jobDetail = newJob(HelloJob.class) // 定义Job类为HelloQuartz类，这是真正的执行逻辑所在
                    .withIdentity("myJob") // 定义name/group
                    .usingJobData("message","Hello myjob1")//使用JobDataMap传递参数给Job，传递一个string类型参数
                    .usingJobData("floatValue",8.5f)//使用JobDataMap传递参数给Job，传递一个float类型
                    .build();

            //2. 定义一个Trigger，定义该job立即执行，并且每两秒钟执行一次，直到永远
            Trigger trigger = TriggerBuilder.newTrigger().withIdentity("myTrigger", "group1")// 定义名字和组
                    .startNow()//现在开始
                    .withSchedule(SimpleScheduleBuilder.simpleSchedule().withIntervalInSeconds(2).repeatForever())
                    .usingJobData("message","Hello trigger1")
                    .usingJobData("DoubleValue",2.5D)
                    .build();
            
            //3. 创建scheduler
            Scheduler scheduler = StdSchedulerFactory.getDefaultScheduler();

            //4. 将trigger和jobdetail加入这个调度
            scheduler.scheduleJob(jobDetail, trigger);

            //5. 启动scheduler
            scheduler.start();

        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

结果：

current time is:2018-04-04 10:11:29
JobDetail\'s name and group are myJob:DEFAULT
Trigger\'s name and group are myTrigger:group1
message is :Hello trigger1
floatValue is :8.5
DoubleValue is :2.5

以上是关于浅谈JobExecutionContext与JobDataMap的主要内容，如果未能解决你的问题，请参考以下文章

Quartz框架实现任务调度

Quartz JobDataMap 获取方法在Job 实现类中添加setter 方法

Quartz--简单示例

quartz2.3.0job任务监听器，监听任务执行前后取消手动处理方法

浅谈Spark中Job-Stage-Task之间的关系