您的位置: 首页  >  文章  >  Spring 4.2集成 Quartz Scheduler 2.2.2 任务调度简单实现示例

Spring 4.2集成 Quartz Scheduler 2.2.2 任务调度简单实现示例

分类: 文章 • 2023-03-27 17:17:54

先贴出示例的完整的上下文文件(个人使用的是A方案简单实现)。

QuartzTask是业务处理类,work是QuartzTask需要定时执行的方法(QuartzTask+quartz-context.xml即可实现定时任务)

src/main/resources/quartz-context.xml
[html] view plain copy
 print?
  1. <?xml version="1.0" encoding="UTF-8"?>
    <beans xmlns="http://www.springframework.org/schema/beans" 
        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
        xmlns:context="http://www.springframework.org/schema/context"
        xmlns:mvc="http://www.springframework.org/schema/mvc"
        xmlns:task="http://www.springframework.org/schema/task"
        xsi:schemaLocation="
            http://www.springframework.org/schema/beans 
            http://www.springframework.org/schema/beans/spring-beans-4.0.xsd
            http://www.springframework.org/schema/context 
            http://www.springframework.org/schema/context/spring-context-4.0.xsd
            http://www.springframework.org/schema/mvc 
            http://www.springframework.org/schema/mvc/spring-mvc-4.0.xsd
            http://www.springframework.org/schema/task 
    http://www.springframework.org/schema/task/spring-task-4.0.xsd">


        
    <!-- ********************** Quartz调度任务   begin  配置跑批***************** -->
    <!-- 线程执行器配置，用于任务注册 
    <bean id="executor" class="org.springframework.scheduling.concurrent.ThreadPoolTaskExecutor">
    <property name="corePoolSize" value="10" />
    <property name="maxPoolSize" value="100" />
    <property name="queueCapacity" value="500" />
    </bean>-->
    <!-- =============要调度的工作类(业务对象)============= 将需要添加定时任务调度的类配置到这里 -->
    <bean id="quartzTask" class="com.didi.opms.common.util.QuartzTask"/>


    <!-- ============= 调度业务(定义调用对象和调用对象的方法)============= -->
    <bean id="jobDetail"
    class="org.springframework.scheduling.quartz.MethodInvokingJobDetailFactoryBean">
    <!-- 要调用的对象 -->
    <property name="targetObject" ref="quartzTask" />
    <!-- 要执行的方法名称 -->
    <property name="targetMethod" value="work" />
    <!-- 如果前一个任务还没有结束第二个任务不会启动 false -->
    <property name="concurrent" value="false" />
    </bean>


    <!-- ============= 调度触发器 ============= -->
    <bean id="simpleTrigger"
    class="org.springframework.scheduling.quartz.CronTriggerFactoryBean">
    <property name="jobDetail" ref="jobDetail" />
    <!-- 每隔3秒钟审批一次 (cron 表达式)
    Cron表达式范例：
                 每隔5秒执行一次：*/5 * * * * ?
                 每隔1分钟执行一次：0 */1 * * * ?
                 每天23点执行一次：0 0 23 * * ?
                 每天凌晨1点执行一次：0 0 1 * * ?
                 每月1号凌晨1点执行一次：0 0 1 1 * ?
                 每月最后一天23点执行一次：0 0 23 L * ?
                 每周星期天凌晨1点实行一次：0 0 1 ? * L
                 在26分、29分、33分执行一次：0 26,29,33 * * * ?
                 每天的0点、13点、18点、21点都执行一次：0 0 0,13,18,21 * * ?-->
    <property name="cronExpression" value="0 0 23 * * ?" />
    </bean>


    <!-- ============= 调度工厂 ============= -->
    <bean  class="org.springframework.scheduling.quartz.SchedulerFactoryBean"
    lazy-init="false">
    <property name="triggers">
    <list>
    <ref bean="simpleTrigger" />
    </list>
    </property>
    </bean>
    <!-- **************** Quartz调度任务  end ***************** -->
    </beans>  
下面我们做个简单介绍(简单定时任务上面配置即可实现,下面内容可不用查看):

本文将演示如何通过 Spring 使用 Quartz Scheduler 进行任务调度。Spring 为简化 Quartz 的操作提供了相关支持类。
本文示例使用的相关工具如下：
  • Spring 4.2.2 (发布于 2015 年 10 月)
  • Quartz Scheduler 2.2.2 (发布于 2015 年 10 月)
  • Maven 3
  • JDK 1.7
  • Eclipse Luna Service Release 1 (4.4.1)

步骤 1：新建 Maven 项目

Spring 4.2集成 Quartz Scheduler 2.2.2 任务调度简单实现示例

步骤 2：第三方依赖包的引入

Maven pom.xml 编辑如下：
[html] view plain copy
 print?   
  1.         <!-- Quartz framework -->  
  2.         <dependency>  
  3.             <groupId>org.quartz-scheduler</groupId>  
  4.             <artifactId>quartz</artifactId>  
  5.             <version>${quartz.version}</version>  
  6.         </dependency>  

步骤 3：Quartz Scheduler 配置作业

有两种方式在 Spring 中使用 Quartz 来配置一个作业。
A：使用 MethodInvokingJobDetailFactoryBean
这种方式在你想要调用特定 bean 的一个方法的时候很是方便，比另一种方法要简单的多。
[html] view plain copy
 print?
  1. <!-- For times when you just need to invoke a method on a specific object -->  
  2. <bean id="simpleJobDetail" class="org.springframework.scheduling.quartz.MethodInvokingJobDetailFactoryBean">  
  3.     <property name="targetObject" ref="myBean" />  
  4.     <property name="targetMethod" value="printMessage" />  
  5. </bean>  

以上作业配置简单调用了 myBean 的 printMessage 方法，myBean 是一个简单的 POJO。
B：使用 JobDetailFactoryBean
如果你需要更高级的设置，需要给作业传递数据，想更加灵活的话就使用这种方式。
[html] view plain copy
 print?
  1. <!-- For times when you need more complex processing, passing data to the scheduled job -->  
  2. <bean name="firstComplexJobDetail"    class="org.springframework.scheduling.quartz.JobDetailFactoryBean">  
  3.     <property name="jobClass" value="com.defonds.scheduler.jobs.FirstScheduledJob" />  
  4.     <property name="jobDataMap">  
  5.         <map>  
  6.             <entry key="anotherBean" value-ref="anotherBean" />  
  7.         </map>  
  8.     </property>  
  9.     <property name="durability" value="true" />  
  10. </bean>  

jobClass 关联到一个继承自 QuartzJobBean 的类，它实现了 Quartz 作业接口。调用到这个作业的时候，它的 executeInternal 将被执行。
jobDataMap 允许我们给相关作业 bean 传递一些数据。在这个例子里，我们将 ScheduledJob 将要使用到的 'anotherBean' 传递给它。
以下是引用 jobclass(FirstScheduledJob)的具体实现。
com.defonds.scheduler.jobs.FirstScheduledJob
[html] view plain copy
 print?
package com.defonds.scheduler.jobs;  
  1.   
  2. import org.quartz.JobExecutionContext;  
  3. import org.quartz.JobExecutionException;  
  4. import org.springframework.scheduling.quartz.QuartzJobBean;  
  5.   
  6. import com.defonds.scheduler.util.AnotherBean;  

  8. public class FirstScheduledJob extends QuartzJobBean {  
  9.       
  10.     private AnotherBean anotherBean;  
  11.   
  12.     @Override  
  13.     protected void executeInternal(JobExecutionContext arg0)  
  14.             throws JobExecutionException {  
  15.         System.out.println("I am FirstScheduledJob");  
  16.         this.anotherBean.printAnotherMessage();  
  17.   
  18.     }  
  19.   
  20.     public void setAnotherBean(AnotherBean anotherBean) {  
  21.         this.anotherBean = anotherBean;  
  22.     }  
  23. }  

步骤 4：配置 Quartz 调度时要使用到的触发器

触发器用来定义调度器何时将会执行你的调度任务的那个时间。有两种可能的触发器类型：
A：简单触发器，使用 SimpleTriggerFactoryBean
你可以定义作业的启动时间、触发器之间的延迟时间以及 repeatInterval(频率)。
[html] view plain copy
 print?
  1. <!-- Run the job every 2 seconds with initial delay of 1 second -->  
  2. <bean id="simpleTrigger"  class="org.springframework.scheduling.quartz.SimpleTriggerFactoryBean">  
  3.     <property name="jobDetail" ref="simpleJobDetail" />  
  4.     <property name="startDelay" value="1000" />  
  5.     <property name="repeatInterval" value="2000" />  
  6. </bean>  

B：计划触发器，使用 CronTriggerFactoryBean
这种类型更加灵活，允许你针对特定实例选择计划方案以及将来要执行的频率。
[html] view plain copy
 print?
  1. <!-- Run the job every 5 seconds -->  
  2. <bean id="cronTrigger"  class="org.springframework.scheduling.quartz.CronTriggerFactoryBean">  
  3.     <property name="jobDetail" ref="firstComplexJobDetail" />  
  4.     <!--<property name="cronExpression" value="0/5 * * ? * SAT-SUN" />-->  
  5.     <property name="cronExpression" value="0/5 * * ? * *" />  
  6.       
  7. </bean>  

步骤 5：配置创建定配置 Quartz 调度器的 SchedulerFactoryBean

SchedulerFactoryBean 将 jobDetails 和 triggers 整合在一起以配置 Quartz 调度器。
[html] view plain copy
 print?
  1. <!-- Scheduler factory bean to glue together jobDetails and triggers to Configure Quartz Scheduler -->  
  2. <bean  class="org.springframework.scheduling.quartz.SchedulerFactoryBean">  
  3.     <property name="jobDetails">  
  4.         <list>  
  5.             <ref bean="simpleJobDetail" />  
  6.             <ref bean="firstComplexJobDetail" />  
  7.             <ref bean="secondComplexJobDetail" />  
  8.         </list>  
  9.     </property>  
  10.   
  11.     <property name="triggers">  
  12.         <list>  
  13.             <ref bean="simpleTrigger" />  
  14.             <ref bean="cronTrigger" />  
  15.             <ref bean="secondCronTrigger" />  
  16.         </list>  
  17.     </property>  
  18. </bean>  

下面贴出我们示例的完整的上下文文件。
src/main/resources/quartz-context.xml
[html] view plain copy
 print?
  1. <?xml version="1.0" encoding="UTF-8"?>  
  2. <beans xmlns="http://www.springframework.org/schema/beans"  
  3.     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:context="http://www.springframework.org/schema/context"  
  4.     xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-4.0.xsd  
  5.                             http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-4.0.xsd">  
  6.    
  7.     <context:component-scan base-package="com.defonds.scheduler" />  
  8.    
  9.    
  10.     <!-- For times when you just need to invoke a method on a specific object -->  
  11.     <bean id="simpleJobDetail" class="org.springframework.scheduling.quartz.MethodInvokingJobDetailFactoryBean">  
  12.         <property name="targetObject" ref="myBean" />  
  13.         <property name="targetMethod" value="printMessage" />  
  14.     </bean>  
  15.    
  16.    
  17.     <!-- For times when you need more complex processing, passing data to the scheduled job -->  
  18.     <bean name="firstComplexJobDetail"    class="org.springframework.scheduling.quartz.JobDetailFactoryBean">  
  19.         <property name="jobClass" value="com.defonds.scheduler.jobs.FirstScheduledJob" />  
  20.         <property name="jobDataMap">  
  21.             <map>  
  22.                 <entry key="anotherBean" value-ref="anotherBean" />  
  23.             </map>  
  24.         </property>  
  25.         <property name="durability" value="true" />  
  26.     </bean>  
  27.       
  28.     <!-- Always run at 20:00 everyday -->  
  29.     <bean name="secondComplexJobDetail"    class="org.springframework.scheduling.quartz.JobDetailFactoryBean">  
  30.         <property name="jobClass" value="com.defonds.scheduler.jobs.SecondScheduledJob" />  
  31.         <property name="durability" value="true" />  
  32.     </bean>  
  33.    
  34.    
  35.     <!-- Run the job every 2 seconds with initial delay of 1 second -->  
  36.     <bean id="simpleTrigger"  class="org.springframework.scheduling.quartz.SimpleTriggerFactoryBean">  
  37.         <property name="jobDetail" ref="simpleJobDetail" />  
  38.         <property name="startDelay" value="1000" />  
  39.         <property name="repeatInterval" value="2000" />  
  40.     </bean>  
  41.    
  42.    
  43.     <!-- Run the job every 5 seconds -->  
  44.     <bean id="cronTrigger"  class="org.springframework.scheduling.quartz.CronTriggerFactoryBean">  
  45.         <property name="jobDetail" ref="firstComplexJobDetail" />  
  46.         <!--<property name="cronExpression" value="0/5 * * ? * SAT-SUN" />-->  
  47.         <property name="cronExpression" value="0/5 * * ? * *" />  
  48.           
  49.     </bean>  
  50.       
  51.     <!-- Always run at 20:00 everyday -->  
  52.     <bean id="secondCronTrigger"  class="org.springframework.scheduling.quartz.CronTriggerFactoryBean">  
  53.         <property name="jobDetail" ref="secondComplexJobDetail" />  
  54.         <property name="cronExpression" value="0 0 20 ? * *" />  
  55.     </bean>  
  56.    
  57.    
  58.     <!-- Scheduler factory bean to glue together jobDetails and triggers to Configure Quartz Scheduler -->  
  59.     <bean  class="org.springframework.scheduling.quartz.SchedulerFactoryBean">  
  60.         <property name="jobDetails">  
  61.             <list>  
  62.                 <ref bean="simpleJobDetail" />  
  63.                 <ref bean="firstComplexJobDetail" />  
  64.                 <ref bean="secondComplexJobDetail" />  
  65.             </list>  
  66.         </property>  
  67.    
  68.         <property name="triggers">  
  69.             <list>  
  70.                 <ref bean="simpleTrigger" />  
  71.                 <ref bean="cronTrigger" />  
  72.                 <ref bean="secondCronTrigger" />  
  73.             </list>  
  74.         </property>  
  75.     </bean>  
  76.    
  77. </beans>  

步骤 6：创建本文用到的几个简单 POJO 任务 Bean

com.defonds.scheduler.jobs.MyBean
[java] view plain copy
 print?  
  1. package com.defonds.scheduler.jobs;  
  2.   
  3. import org.springframework.stereotype.Component;  
  4.   
  5. @Component("myBean")  
  6. public class MyBean {  
  7.    
  8.     public void printMessage() {  
  9.         System.out.println("I am MyBean. I am called by MethodInvokingJobDetailFactoryBean using SimpleTriggerFactoryBean");  
  10.     }  
  11.        
  12. }  

com.defonds.scheduler.util.AnotherBean
[html] view plain copy
 print?
  1. package com.defonds.scheduler.util;  
  2.   
  3. import org.springframework.stereotype.Component;  

  5. @Component("anotherBean")  
  6. public class AnotherBean {  
  7.        
  8.     public void printAnotherMessage(){  
  9.         System.out.println("I am AnotherBean. I am called by Quartz jobBean using CronTriggerFactoryBean");  
  10.     }  
  11.        
  12. }  

com.defonds.scheduler.jobs.SecondScheduledJob
[java] view plain copy
 print?
  1. /** 
  2.  * File Name：SecondScheduledJob.java 
  3.  * 
  4.  * Copyright Defonds Corporation 2015  
  5.  * All Rights Reserved 
  6.  * 
  7.  */  
  8. package com.defonds.scheduler.jobs;  
  9.   
  10. import org.quartz.JobExecutionContext;  
  11. import org.quartz.JobExecutionException;  
  12. import org.springframework.scheduling.quartz.QuartzJobBean;  
  13.  
  14. public class SecondScheduledJob extends QuartzJobBean {  
  15.   
  16.     @Override  
  17.     protected void executeInternal(JobExecutionContext arg0)  
  18.             throws JobExecutionException {  
  19.         System.out.println("I am SecondScheduledJob");  
  20.   
  21.     }  
  22.   
  23. }  

为了演示多个执行计划的一起调度，我们写了两个 JobDetailFactoryBean，于是就有了 SecondScheduledJob。

步骤 7：创建执行程序的 Main 类

[java] view plain copy
 print? 
  1. package com.defonds.scheduler;  
  2.   
  3. import org.springframework.context.support.AbstractApplicationContext;  
  4. import org.springframework.context.support.ClassPathXmlApplicationContext;  
  5.    
  6. public class AppMain {  
  7.   
  8.     public static void main(String args[]){  
  9.         AbstractApplicationContext context = new ClassPathXmlApplicationContext("quartz-context.xml");  
  10.     }  
  11.   
  12. }  

这时整个项目目录结构如下图所示：
Spring 4.2集成 Quartz Scheduler 2.2.2 任务调度简单实现示例
简单触发器调用的作业每隔两秒执行一次，而计划触发器一的则是每隔五秒钟执行一次，计划触发器二则是固定只执行了一次(晚上八点整，红色字体部分)。

后记

  • 大多数情况下都会使用 JobDetailFactoryBean 进行任务调度配置；
  • 每个 JobDetailFactoryBean 都有一个触发器与之匹配。配置多个调度计划，需要配置多个这种匹配对；
  • 由触发器指向 JobDetailFactoryBean；

相关推荐