Spring+Quartz 整合一：常规整合

Posted 2020-08-11

 步骤一： 定时任务需要一个配置文件（spring-mvc-timeTask.xml 随便起名），将其在web.xml中加载

1 <context-param>
2 <param-name>contextConfigLocation</param-name>
3 <param-value>classpath*:spring-*.xml</param-value>
4 </context-param>

 

步骤二：编写调度任务配置文件spring-mvc-timeTask.xml ，一般包括四部分：目标任务实体，目标任务具体执行策略实体，任务执行触发器，调度工厂 

 

 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     xmlns:aop="http://www.springframework.org/schema/aop" xmlns:util="http://www.springframework.org/schema/util"
 5     xmlns:tx="http://www.springframework.org/schema/tx" xmlns:task="http://www.springframework.org/schema/task"
 6     xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-3.0.xsd
 7     http://www.springframework.org/schema/aop http://www.springframework.org/schema/aop/spring-aop-3.0.xsd
 8     http://www.springframework.org/schema/tx http://www.springframework.org/schema/tx/spring-tx-3.0.xsd
 9     http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-3.0.xsd
10     http://www.springframework.org/schema/task http://www.springframework.org/schema/task/spring-task-3.0.xsd
11     http://www.springframework.org/schema/util http://www.springframework.org/schema/util/spring-util-3.0.xsd"
12     default-autowire="byName" default-lazy-init="false">
13     
14     <!-- 定时任务配置 scheduler 方式 注解 暂时不支持动态更新 -->
15     <context:component-scan base-package="org.jeecgframework.core.timer" />
16     <task:executor id="executor" pool-size="5" />
17     <task:scheduler id="scheduler" pool-size="10" />
18     <task:annotation-driven executor="executor" scheduler="scheduler" />
19     <!-- 定时任务可以是bean实体  也可以是注解方式 -->    
20     
21     <!-- 定时任务配置-->
22     <bean id="taskDemoServiceTaskJob" class="org.springframework.scheduling.quartz.MethodInvokingJobDetailFactoryBean">
23         <property name="targetObject" ref="taskDemoService" />
24         <property name="targetMethod" value="work" />
25         <property name="concurrent" value="true" />
26     </bean>
27     <!-- 定时任务触发器配置-->
28     <bean id="taskDemoServiceTaskCronTrigger" class="org.jeecgframework.core.timer.DataBaseCronTriggerBean">
29         <property name="jobDetail" ref="taskDemoServiceTaskJob" />
30         <property name="cronExpression" value="0 0/1 * * * ?" />
31     </bean>
32     
33     <!-- 定时任务配置   smsSendTask 可配置到管理界面 -->
34     <bean id="smsSendTaskJob" class="org.springframework.scheduling.quartz.MethodInvokingJobDetailFactoryBean">
35         <property name="targetObject" ref="smsSendTask" />
36         <property name="targetMethod" value="run" />
37         <!-- 是否允许任务并发执行。当值为false时，表示必须等到前一个线程处理完毕后才再启一个新的线程 --> 
38         <property name="concurrent" value="true" />
39     </bean>
40     <!-- 定时任务触发器配置-->
41     <bean id="smsSendTaskCronTrigger" class="org.jeecgframework.core.timer.DataBaseCronTriggerBean">
42         <property name="jobDetail" ref="smsSendTaskJob" />
43         <property name="group" value="DEFAULT"/>
44         <property name="cronExpression" value="0 0/1 * * * ?" />
45     </bean>
46 
47     <!-- 定时任务调度器  （也称调度工厂） Scheduler包含一个Trigger列表，每个Trigger表示一个任务-->
48     <bean id="schedulerFactory" lazy-init="false" autowire="no" class="org.jeecgframework.core.timer.DataBaseSchedulerFactoryBean">
49         <property name="triggers">
50             <list>
51                 <ref bean="taskDemoServiceTaskCronTrigger" />
52                 <ref bean="smsSendTaskCronTrigger" />
53             </list>
54         </property>
55         <property name="autoStartup" value="true"/>
56     </bean>
57 
58 </beans>

 

步骤三、编写定时任务管理工具类：定时任务配置好了之后并不是启动之后就会开始按照排程到点启动，需要先手动启动之后才开始排程进行。

 

 1 public boolean startOrStop(String triggerName,boolean start)
 2     {
 3         try 
 4         {
 5             CronTrigger trigger = (CronTrigger) getTrigger(triggerName,Scheduler.DEFAULT_GROUP);
 6             if(start)
 7             {
 8                 //重启
 9                 schedulerFactory.resumeTrigger(trigger.getName(), trigger.getGroup());
10                 logger.info("trigger the start successfully!!");
11             }
12             else
13             {
14                 //暂停
15                 schedulerFactory.pauseTrigger(trigger.getName(), trigger.getGroup());
16                 logger.info("trigger the pause successfully!!");
17             }
18             return true;
19         } 
20         catch (SchedulerException e) 
21         {
22             logger.error("Fail to reschedule. " + e);
23             return false;
24         }
25     }

 

步骤四：编写定时任务具体执行类：
两种方式：
方式一：继承org.springframework.scheduling.quartz.QuartzJobBean
方式二：是在配置文件里定义任务类和要执行的方法，类和方法可以是普通类。很显然，使用配置文件的目的就是要用这种方式。

 

注意： 在Spring配置和Quartz集成内容时，有两点需要注意

1、在<Beans>中不能够设置default-lazy-init="true",否则定时任务不触发，如果不明确指明default-lazy-init的值，默认是false。
2、在<Beans>中不能够设置default-autowire="byName"的属性，否则后台会报org.springframework.beans.factory.BeanCreationException错误，这样就不能通过Bean名称自动注入，必须通过明确引用注入
3、spring和quartz的整合对版本是有要求的。
spring3.1以下的版本必须使用quartz1.x系列，3.1以上的版本才支持quartz 2.x，不然会出错。
至于原因，则是spring对于quartz的支持实现，org.springframework.scheduling.quartz.CronTriggerBean继承了org.quartz.CronTrigger，在quartz1.x系列中org.quartz.CronTrigger是个类，而在quartz2.x系列中org.quartz.CronTrigger变成了接口，从而造成无法用spring的方式配置quartz的触发器（trigger）。