【任务调度】：Quartz也有“春天”

　　之前，简单地浏览过Quartz的API（http://www.quartz-scheduler.org/documentation/quartz-2.2.x/quick-start.html），它告诉我们如何配置和使用Quartz。但是，在实际开发中我们的项目大多使用了Spring。那么这二者能否很好的结合呢？实际上，Spring框架已经对Quartz提供了很好的支持。这篇文章，我们将以实际的Demo来总结如何在Spring的上下文中使用Quartz。

回顾

Quartz中的几个重要概念

• Scheduler
  用于与调度程序交互的主程序接口。（也就是得通过它把调度程序启动起来）
• Job
  让scheduler执行的任务的接口。
• JobDetail
  具体任务实现。
• Trigger
  定义任务什么时候，什么条件执行。

Spring框架中的包

　　在maven的中央仓库https://mvnrepository.com/search?q=org.springframework&p=1中，搜“org.springframework”,可以搜到1538个结果，这么多，没有必要都了解，less is more。这里我们只需清楚几个重要的，以及spring结合quartz时需要的包就可以了。

• spring-core
  spring框架的核心工具类。必须引入。
• spring-bean
  与在配置文件中配置bean，创建初始化bean都有关，即与IoC相关。
• spring-context
  为spring核心提供了大量的扩展，（“是spring-core的升华”？，O(∩_∩)O哈哈！），所以项目中也要引入。
• spring-context-support（之前叫spring-support）
  这个jar文件包含支持缓存Cache，邮件，任务计划Scheduling（Timer、Quartz）等方面的类。

实战一下

demo环境

• IDE：IntelliJ IDEA 2016
• JDK：1.8.0_102
• Spring：4.1.5.RELEASE

demo步骤

New Project

Add dependencies in pom.xml

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
  <modelVersion>4.0.0</modelVersion>
  <groupId>com.xcy</groupId>
  <artifactId>quartz</artifactId>
  <packaging>war</packaging>
  <version>1.0-SNAPSHOT</version>
  <name>quartz Maven Webapp</name>
  <url>http://maven.apache.org</url>
  <dependencies>
    <!-- spring -->
    <dependency>
      <groupId>org.springframework</groupId>
      <artifactId>spring-core</artifactId>
      <version>4.1.5.RELEASE</version>
    </dependency>
    <dependency>
      <groupId>org.springframework</groupId>
      <artifactId>spring-beans</artifactId>
      <version>4.1.5.RELEASE</version>
    </dependency>
    <dependency>
      <groupId>org.springframework</groupId>
      <artifactId>spring-context</artifactId>
      <version>4.1.5.RELEASE</version>
    </dependency>
    <dependency>
      <groupId>org.springframework</groupId>
      <artifactId>spring-context-support</artifactId>
      <version>4.1.5.RELEASE</version>
    </dependency>
    <dependency>
      <groupId>org.springframework</groupId>
      <artifactId>spring-tx</artifactId>
      <version>4.1.5.RELEASE</version>
    </dependency>

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


    <!--slf4j-->
    <dependency>
      <groupId>org.slf4j</groupId>
      <artifactId>slf4j-api</artifactId>
      <version>1.7.13</version>
    </dependency>

    <dependency>
      <groupId>junit</groupId>
      <artifactId>junit</artifactId>
      <version>3.8.1</version>
      <scope>test</scope>
    </dependency>
  </dependencies>
  <build>
    <finalName>quartz</finalName>
  </build>
</project>

备注：spring-tx也得引入，否则会报错，后面会提到。

JobDetail & Trigger

使用MethodInvokingJobDetailFactoryBean配置JobDetail

 <bean id="jobDetail" class="org.springframework.scheduling.quartz.MethodInvokingJobDetailFactoryBean">
        <property name="targetObject" ref="exampleBusinessObject" />
        <property name="targetMethod" value="doIt" />
        <!--<property name="concurrent" value="false" />-->
    </bean>
    <bean id="exampleBusinessObject" class="com.xcy.service.ExampleBusinessObject"/>

public class ExampleBusinessObject {
    // properties and collaborators
    public void doIt() {
        // do the actual work
        System.out.print("do actual work");
    }
}

使用SimpleTriggerFactoryBean配置Trigger，对于复杂的如某年某月某日执行，可使用CronTriggerFactoryBean。

<bean id="simpleTrigger" class="org.springframework.scheduling.quartz.SimpleTriggerFactoryBean">
        <!-- see the example of method invoking job above -->
        <property name="jobDetail" ref="jobDetail" />
        <!-- 10 seconds -->
        <property name="startDelay" value="10000" />
        <!-- repeat every 50 seconds -->
        <property name="repeatInterval" value="50000" />
    </bean>

使用SchedulerFactoryBean充当Scheduler

    <bean class="org.springframework.scheduling.quartz.SchedulerFactoryBean" lazy-init="false" autowire="no">
        <property name="triggers">
            <list>
                <ref bean="simpleTrigger" />
            </list>
        </property>
    </bean>

测试

public class ExampleBusinessTestCase {

    protected static ApplicationContext applicationContext;


    public static void main(String[] args){
        applicationContext = new ClassPathXmlApplicationContext("spring/applicationContext.xml");
    }

}

在控制台打印出do actual work

总结

Spring中的与Quartz相关的几个类。

• MethodInvokingJobDetailFactoryBean
  这个类的targetObject，targetMethod两个属性描述了JobDetail，即任务执行时，是调用哪个目标对象的哪个方法。

• SimpleTriggerFactoryBean Or CronTriggerFactoryBean
  这个类定义了任务执行的条件，前一种适用于多少时间之后（delay），每隔多长时间执行一次（rate）的任务，后一种适用于在每周的某个时间，或者未来的某个日期会执行的任务

• SchedulerFactoryBean
  通过triggers属性关联Trigger，用来启动它们。

参考文档：http://docs.spring.io/spring/docs/3.2.x/spring-framework-reference/html/scheduling.html#scheduling-quartz

遇到的问题

没有配置spring-tx包，产生异常

Caused by: org.springframework.beans.factory.BeanCreationException: Error creating bean with name 'org.springframework.scheduling.quartz.SchedulerFactoryBean#0' defined in class path resource [spring/applicationContext.xml]: Instantiation of bean failed; nested exception is java.lang.NoClassDefFoundError: org/springframework/transaction/TransactionException

可能的问题：

当项目中存在datasource的配置时，需要屏蔽掉SchedulerFactoryBean的自动装配。具体原因大概是因为SchedulerFactoryBean有个datasource属性，如果按默认自动装配的话，装配项目中的datasource，此时quartz就会去数据库中找任务，但是没有数据库中无对应的表，导致SchedulerFactoryBean初始化失败。所以在实际项目中一定要给SchedulerFactoryBean配置上autowire=”false”属性。