Quartz与Spring的整合使用——建立JobDetail的方式及Trigger

以前说到过Quartz的基本使用（猛戳这里看文章），在实际使用中，咱们一般会将定时任务交由spring容器来管理，因此今天咱们来讲说Quartz与spring的整合。

我们仍是按照Quartz的三大元素的顺序来聊聊整合使用。

做业任务

在spring中对于Quartz的做业任务管理主要提供了两种方式，JobDetailFactoryBean和MethodInvokingJobDetailFactoryBean，它们都在org.springframework.scheduling.quartz这个包下。下面咱们来看看它们的使用。

• JobDetailFactoryBean

spring对这个类的解释为：A Spring FactoryBean for creating a Quartz JobDetail instance, supporting bean-style usage for JobDetail configuration. 
一个用于建立Quartz JobDetail实例的，支持以bean定义风格来配置JobDetail的工厂bean。

对于在spring中的使用也是很简单，首先咱们须要建立一个具体的做业任务的实现类。使用JobDetailFactoryBean来管理做业任务时，咱们的做业任务实现类须要继承QuartzJobBean类，并覆盖其executeInternal方法。就像下面这样。

public class SimpleJob extends QuartzJobBean {

    @Override
    protected void executeInternal(JobExecutionContext arg0)
            throws JobExecutionException {
        System.out.println("如今时间为："+new Date());
        //能够经过上下文获取到JobDataMap，这里面能够存放一些参数类型的数据
        JobDataMap dataMap=arg0.getMergedJobDataMap();
        String wish=(String) dataMap.get("wish");
        System.out.println(wish);
    }
}

而后就在spring容器中以下配置：

<bean id="jobDetailFactoryBeanExample" class="org.springframework.scheduling.quartz.JobDetailFactoryBean">
    <!-- 参考源码，咱们能够看到属性jobClass为Class类型，因此不能使用ref来引用一个bean，不然就会由于不能将bean转换为Class类型而出现异常。
        <property name="jobClass" ref="simpleJob"/>
        必须使用value对jobClass赋值。 
        <property name="jobClass" value="com.earl.quartz.spring.job.SimpleJob"/>    
    -->
    <property name="jobClass" value="com.earl.quartz.spring.job.SimpleJob"/>
    <!-- 这里设置的jobDataAsMap能够传递一些参数给做业任务 -->
    <property name="jobDataAsMap">
        <map>
            <entry key="wish" value="hello"/>
        </map>
    </property>
</bean>

• MethodInvokingJobDetailFactoryBean

spring对这个类的解释：FactoryBean that exposes a JobDetail object which delegates job execution to a specified (static or non-static) method. 
这个FactoryBean提供JobDetail对象，这个对象能够指定做业任务的执行方法。

由于能够指定做业调度时执行的内容，因此使用起来就比JobDetailFactoryBean更加的灵活方便。首先咱们仍是建立一个做业任务的具体实现类，这个实现类就不须要继承或实现其余的父类，只须要将咱们想要执行的做业任务声明在具体的方法中便可。以下：

public class ExampleJob{
    public void execute(){
        System.out.println("如今是"+new SimpleDateFormat("yyyy年MM月dd日 HH时mm分ss秒").format(new Date()));
    }
}

而后在spring容器中以下配置便可：

<!-- 
    若是两个触发器触发同一个做业，那么第二个做业可能在第一个做业完成以前被触发。
    将做业类实现StatefulJob接口就能够避免这种状况。
    将concurrent设置为false能够避免并发的发生。
-->
<!-- 使用MethodInvokingJobDetailFactoryBean来建立做业对象 -->
<bean id="exampleJob" class="com.earl.quartz.spring.job.ExampleJob"/>
<bean id="methodInvokingJobDetailFactoryBeanExample" class="org.springframework.scheduling.quartz.MethodInvokingJobDetailFactoryBean">
<!-- 目标对象，指的是做业任务的实现类 -->
<property name="targetObject" ref="exampleJob"/>
<!-- 目标方法，指的是指定实现类中的哪一个方法做为调度时的执行方法 -->
<property name="targetMethod" value="execute"/>
<!-- 是否并发 -->
<property name="concurrent" value="false"/>
</bean>

以上就是做业任务的相关内容，下面咱们来看看触发器这个可爱的小东东。

触发器

在spring中，触发器也分为simpleTrigger和cronTrigger，并且它们的使用也是很是简单，只须要配置一个bean元素便可。下面咱们分别看看它们二者的配置：

• simpleTrigger

<bean id="simpleTrigger" class="org.springframework.scheduling.quartz.SimpleTriggerFactoryBean">
    <!-- 这里的JobDetail指的就是咱们配置的做业任务的bean -->
    <property name="jobDetail" ref="methodInvokingJobDetailFactoryBeanExample" />
    <!-- 延迟5秒开始 -->
    <property name="startDelay" value="5000"></property>
    <!-- 每3秒重复一次 -->
       <property name="repeatInterval" value="3000"></property>     
</bean>

• cronTrigger

<bean id="cronTrigger" class="org.springframework.scheduling.quartz.CronTriggerFactoryBean">
    <!-- 这里的JobDetail指的就是咱们配置的做业任务的bean -->
    <property name="jobDetail" ref="jobDetailFactoryBeanExample"/>
    <!--cronExpression，cron表达式-->
    <property name="cronExpression" value="40 52 17 * * ?"/>
</bean>

以上就是触发器的基本配置，上述两个触发器的工厂bean还有一些其余的属性，例如jobDataMap，priority等等。若是有须要，您能够参考相关的文档。

调度程序

最后，最简单的莫过于做业调度程序了，在spring中只须要这样配置便可：

<bean id="startQuartz" class="org.springframework.scheduling.quartz.SchedulerFactoryBean" lazy-init="false">
    <!--指定使用哪些触发器，spring会去调度触发相应的触发器，进而对做业任务进行调度处理-->
    <property name="triggers">
        <list>
<!--                <ref bean="simpleTrigger"/> -->
            <ref bean="cronTrigger"/>
        </list>
    </property>
</bean>

总结

以上就是对Quartz与Spring的整合使用的基本介绍了。整体来讲，Quartz的定时任务功能已经很强大了，而spring对其的整合更是让程序员在使用定时任务是如虎添翼。对于Quartz来讲还有不少其余的功能，例如定时文件扫描，定时发送邮件等等，以后在另一篇文章中再进行详细介绍。

猛戳这里下载源代码 
说明：本文介绍的是Quartz与Spring的整合使用，因此请参考源码时关注com.earl.quartz.spring包下内容便可，其余可自行忽略。

 

如何从Job中获取ApplicationContext对象：

在xml配置文件中 加入applicationContextSchedulerContextKey配置

<bean  class="org.springframework.scheduling.quartz.SchedulerFactoryBean">

        <property name="triggers">
            <list>
             <!--   <ref bean="simpleTrigger" />-->
                <ref bean="cronTrigger" />
            </list>
        </property>
        <property name="applicationContextSchedulerContextKey" value="applicationContextKey"/>
    </bean>

value的值 用于Job中获取application上下文对象。 即设置 APPLICATION_CONTEXT_KEY 的值

public class ScheduledJob extends QuartzJobBean {
    private static final String APPLICATION_CONTEXT_KEY = "applicationContextKey";

    private AnotherBean anotherBean;
    @Override
    protected void executeInternal(JobExecutionContext context) throws JobExecutionException {
        ApplicationContext applicationContext = null;
        try{
            applicationContext = getApplicationContext(context);
        }catch (Exception e){
            e.printStackTrace();
        }
        if(applicationContext != null){
            System.out.println("applicationContext");
            ((AnotherBean)(applicationContext.getBean("anotherBean"))).printAnotherMessage();
        }
    }
    private ApplicationContext getApplicationContext(JobExecutionContext context) throws Exception {
        ApplicationContext appCtx = null;
        appCtx = (ApplicationContext) context.getScheduler().getContext().get(APPLICATION_CONTEXT_KEY);
        if (appCtx == null) {
            throw new JobExecutionException("No application context available in scheduler context for key \"" + APPLICATION_CONTEXT_KEY + "\"");
        }
        return appCtx;
    }
}