Spring与Quartz使用说明

墨蓝 2022-08-25 11:49 140阅读 0赞

【出处】：[http://blog.sina.com.cn/s/blog\_675e9aeb0100qghp.html][http_blog.sina.com.cn_s_blog_675e9aeb0100qghp.html]

最近因为项目后台需要使用一个线程去定时跑一些任务，所以看了一下Spring和Quartz的使用与集成。例如发短信、邮件。根据实际使用，此集成使用比自己去写线程方便和灵活，可以不用代码实现复杂的计划任务，如“1月份的每周三、周五的早上9点至10点每5钟一次任务”。所以分享一下。

Quartz官方网址：[http://www.quartz-scheduler.org/][http_www.quartz-scheduler.org]

集成方法

集成起来比较简单,对线程无需任何理解，Spring手册上也有清楚的说明。只需写一个POJO，其余的都是配置，而且若使用CronTriggerBean，可以配置很复杂的任务调度。

1.编写一个普通的JAVA类

根据业务，写一个简单的JAVA类，和普通的类没有区别。并配置到Spring配置文件上中。例：

<table> 
 <tbody> 
  <tr> 
   <td style="background:rgb(243,243,243)"> <p style="background:rgb(243,243,243)">&nbsp;&lt;bean&nbsp;id="vcSMSProcessService"&nbsp;class="com.sinoprof.vc.sms.service.impl.MessageProcessServiceImpl"&gt;</p> <p style="background:rgb(243,243,243)">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&lt;property&nbsp;name="vcSMSLocalDAO"&nbsp;ref="vcSMSLocalDAO"/&gt;</p> <p style="background:rgb(243,243,243)">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&lt;property&nbsp;name="vcSMSOAService"&nbsp;ref="vcSMSOAService"/&gt;</p> <p style="background:rgb(243,243,243)">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&lt;property&nbsp;name="vcSMSConfig"&nbsp;ref="vcSMSConfig"/&gt;</p> <p style="background:rgb(243,243,243)">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&lt;property&nbsp;name="vcSMSGateWayService"&nbsp;ref="vcSMSGateWayService"/&gt;</p> <p style="background:rgb(243,243,243)">&nbsp;&nbsp;&nbsp;&nbsp;&lt;/bean&gt;</p> </td> 
  </tr> 
 </tbody> 
</table>

2.使用MethodInvokingJobDetailFactoryBean建立任务

只需要配置即可，配置信息示例如下：

<table> 
 <tbody> 
  <tr> 
   <td style="background:rgb(243,243,243)"> <p>&lt;bean&nbsp;id="jobTask"&nbsp;class="org.springframework.scheduling.quartz.MethodInvokingJobDetailFactoryBean"&gt;</p> <p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&lt;property&nbsp;name="targetObject"&gt;</p> <p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&lt;ref&nbsp;bean="vcSMSProcessService"/&gt;</p> <p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&lt;/property&gt;</p> <p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&lt;property&nbsp;name="targetMethod"&gt;</p> <p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&lt;value&gt;sendMessages&lt;/value&gt;</p> <p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&lt;/property&gt;</p> <p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&lt;property&nbsp;name="concurrent"&gt;</p> <p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&lt;value&gt;false&lt;/value&gt;</p> <p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&lt;/property&gt;</p> <p>&lt;/bean&gt;</p> </td> 
  </tr> 
 </tbody> 
</table>

说明：

<table> 
 <tbody> 
  <tr> 
   <td> <p>targetObject</p> </td> 
   <td> <p>目标对象，即需要定时执行的POJO</p> </td> 
  </tr> 
  <tr> 
   <td> <p>targetMethod</p> </td> 
   <td> <p>目标方法，即需要定时执行的POJO方法</p> </td> 
  </tr> 
  <tr> 
   <td> <p>concurrent</p> </td> 
   <td> <p>默认情况下，Quartz&nbsp;Jobs是无状态的，可能导致jobs之间互相的影响，如果你为相同的JobDetail指定两个Trigger,很可能当第一个job完成之前，第二个job就开始了。如果Jobdetail实现了Stateful接口，就不会发生这样的事情。第二个job将不会在第一个job完成之前开始。为了使得jobs不并发运行，设置concurrent标记为false</p> </td> 
  </tr> 
 </tbody> 
</table>

3.使用CronTriggerBean建立规则，调度任务

<table> 
 <tbody> 
  <tr> 
   <td style="background:rgb(243,243,243)"> <p>&lt;bean&nbsp;id="jobTrigger"&nbsp;class="org.springframework.scheduling.quartz.CronTriggerBean"&gt;</p> <p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&lt;property&nbsp;name="jobDetail"&gt;</p> <p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&lt;ref&nbsp;bean="jobTask"/&gt;</p> <p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&lt;/property&gt;</p> <p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&lt;property&nbsp;name="cronExpression"&gt;</p> <p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&lt;value&gt;0&nbsp;0/5&nbsp;8-18&nbsp;?&nbsp;*&nbsp;2-6&nbsp;*&lt;/value&gt;</p> <p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&lt;/property&gt;</p> <p>&nbsp;&nbsp;&nbsp;&nbsp;&lt;/bean&gt;</p> </td> 
  </tr> 
 </tbody> 
</table>

说明：

<table> 
 <tbody> 
  <tr> 
   <td> <p>jobDetail</p> </td> 
   <td> <p>任务详情，即所需要调度的任务</p> </td> 
  </tr> 
  <tr> 
   <td> <p>cronExpression</p> </td> 
   <td> <p>调用规则，即什么时候调用。详细说明见附录1</p> </td> 
  </tr> 
 </tbody> 
</table>

4.使用SchedulerFactoryBean包装任务

<table> 
 <tbody> 
  <tr> 
   <td style="background:rgb(243,243,243)"> <p>&lt;bean&nbsp;id="startQuartz"&nbsp;lazy-init="false"&nbsp;</p> <p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;class="org.springframework.scheduling.quartz.SchedulerFactoryBean"&gt;</p> <p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&lt;property&nbsp;name="triggers"&gt;</p> <p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&lt;list&gt;</p> <p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&lt;ref&nbsp;bean="jobTrigger"/&gt;</p> <p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&lt;/list&gt;</p> <p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&lt;/property&gt;</p> <p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&lt;property&nbsp;name="autoStartup"&nbsp;value="true"/&gt;</p> <p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&lt;property&nbsp;name="schedulerName"&nbsp;value="cronScheduler"/&gt;</p> <p>&nbsp;&nbsp;&nbsp;&nbsp;&lt;/bean&gt;</p> </td> 
  </tr> 
 </tbody> 
</table>

说明：

<table> 
 <tbody> 
  <tr> 
   <td> <p>triggers</p> </td> 
   <td> <p>触发器，调用哪些任务</p> </td> 
  </tr> 
  <tr> 
   <td> <p>autoStartup</p> </td> 
   <td> <p>是否自动启动，该Bean被初始化后是否自动启动定时任务。</p> <p><span style="color:#000000">Set&nbsp;whether&nbsp;to&nbsp;automatically&nbsp;start&nbsp;the&nbsp;scheduler&nbsp;after&nbsp;initialization.</span>&nbsp;</p> </td> 
  </tr> 
  <tr> 
   <td> <p>schedulerName</p> </td> 
   <td> <p><span style="color:#000000">给这个计划设定一个名称。</span></p> <p><span style="color:#000000">Set&nbsp;the&nbsp;name&nbsp;of&nbsp;the&nbsp;Scheduler&nbsp;to&nbsp;fetch&nbsp;from&nbsp;the&nbsp;SchedulerFactory.</span>&nbsp;</p> </td> 
  </tr> 
 </tbody> 
</table>

更多使用细节可以参考Spring文档和Quartz文档

附录1：CronTrigger说明

如果需要复杂的任务计划调度，像日历样式的任务，而不是简单的时间间隔调度，需要使用CronTrigger，SimpleTrigger满足不了需求。

用CronTrigger，你可以定义任务计划像“每周五的中午”，或“每个工作日的早上9：30”，甚至可以定义“1月份的每周一、周三、周五早上9：00至10：00，每5分钟一次”。

虽然如此，像SimpleTrigger一样，CronTrigger仍有startTime属性定义计划的开始时间，endTime(可选）属性定义计划的中止时间。

Cron Expressions

Cron-Expressions是用来配置CronTrigger实例。Cron-Expressions是由七段子表达式组成的字符串，描述各个细节计划。这些子字符串由空格分开，每个子字符串表示一个域，分别为：

１　秒

２　分

３　时

４　几号

５　月份

６　星期几

７　年（可选域）

例如："0 0 12 ? \* WED"-表示每周三12:00:00pm"。

其中每个独立的子表达式都可以用范围或者列表表示。例如：

前例的”WED“也可以写成：

"MON-FRI"（范围表示）

"MON,WED,FRI"（列表表示）

"MON-WED,SAT"（范围加列表）

通配符（\*）可以用来表示某个子表达式域的每一个可能的值。因此，“\*”号用在月份里，表示每月。用在星期几里，表示一周中的每天。

每个子表达式域都有一组有效的值，这些值都是显然意见的。例：用0-59表示秒和分，用0到23表示小时。几号用0-31中的任何值，但是要小心每月的天数。月份指定的值应该是0至11，也可以用字符串 JAN,FEB,MAR,APR,MAY,JUN,JUL,AUG,SEP,OCT,NOV和DEC表示。星期几用1到7表示（1=星期天），或用英文字符表示：SUN,MON，TUE，WED，THU，FRI和SAT。

字符“/”用来表示增量的值。例如：如果用“0/15”表示分，就表示从一个小时的0分开始，在这小时内每隔15分钟一次。如果用"3/20"表示分，则表示从一个小时的3分开始，在这小时内每隔20分钟一次。也可以用“3,23,43”表示。注意"\*/35"并不是表示每35分钟，而是表示从一个小时的0分开始，每隔35分钟一次，相当于"0,35"。

“?"号允许用在几号和星期几的子字符串域中，用来说明没有指定值。

“L”字符允许用在几号和星期几域中，是"last"的缩写。“L”用在几号里意思是这个月的最后一天，如果是1月就指31号，如果是闰年的2月就是28号。如果用在星期几里，他就是表示“7”或者“SAT”（星期六）。但是如果L用在一个值的后面联合表示星期几域，就表示“这个月最后一个星期几”。例如：“6L”或“FRIL”表示这个月的最后一个星期五。同样也可以用一个偏移变量表示距离某个月最后一天的天数。例如：“L-3”表示某月最后一天的倒数第三天。但用“L“字符时，不要将“L”用在列表或范围中，那样你会混淆或者获得不是预期的结果。

“W”用来指定某一号最近的工作日（星期一至五），例如：“15W”放在几号里，表示这个月15号最近的一个工作日。

“\#”号用指定某月第几个工作日，例如：“6\#3”或“FRI\#3”放在星期几域中，表示这个月第三个星期五。

下面是一些表达式的样例，你可以从JavaDoc中找到更多的例子。

Cron Expressions示例

例1-一个表达式表示每5分钟。

"0 0/5 \* \* \* ?"

例2——表示每分钟的10秒后，每5钟一次（如：10：00：10 am,10:05:10 am,等等）

"10 0/5 \* \* \* ?"

例3——表示运行在每个星期三，星期五的10：30，11：30，12：30 and 13:30

"0 30 10-13 ? \* WED,FRI"

例4——表示每月的5号和20号的早8点至早10点每30分钟一次。

"0 0/30 8-10 5,20 \* ?"

注意，有些计划调度需求如果用一个触发器会很复杂，例如：“早9：00至10：00每5分钟，下午1：00至10：00每20分钟”，这种情况下可以是单的创建两个触发器同时运行一个JOB

[http_blog.sina.com.cn_s_blog_675e9aeb0100qghp.html]: http://blog.sina.com.cn/s/blog_675e9aeb0100qghp.html
[http_www.quartz-scheduler.org]: http://www.quartz-scheduler.org/