Quartz(一)在Spring中设置动态定时任务
什么是动态定时任务:
是由客户制定生成的,服务端只知道该去执行什么任务,但任务的定时是不确定的(是由客户制定)。这样总不能修改配置文件每定制个定时任务就增加一个trigger吧,即便允许客户修改配置文件,但总需要重新启动web服务啊,研究了下Quartz在Spring中的动态定时,发现:cronExpression是关键,如果可以动态设置cronExpression的值,也就说如果我们可以直接调用CronTriggerBean中设置cronExpression的方法,就可以顺利解决问题了。
Spring中使用Quartz的3种方法(MethodInvokingJobDetailFactoryBean,implementsJob,extendsQuartzJobBean)
以下介绍一下MethodInvokingJobDetailFactoryBean方法
①targetMethod:指定需要定时执行scheduleInfoManager中的simpleJobTest()方法
②concurrent:对于相同的JobDetail,当指定多个Trigger时,很可能第一个job完成之前,第二个job就开始了。指定concurrent设为false,多个job不会并发运行,第二个job将不会在第一个job完成之前开始。
③cronExpression:0/10****?表示每10秒执行一次,具体可参考附表。
④triggers:通过再添加其他的ref元素可在list中放置多个触发器。scheduleInfoManager中的simpleJobTest()方法注意:此方法没有参数,如果scheduleInfoManager有两个方法simpleJobTest()和simpleJobTest(Stringargument),则spring只会去执行无参的simpleJobTest().
publicvoidsimpleJobTest()
{
log.warn("uhoh,Jobisscheduled!'"+"'Success...");
}
Quartz在Spring中动态设置cronTrigger方法一Spring配置文件:
将定时器注入到业务逻辑层Manager
<bean id="scheduleInfoManager" class="com.lively.happyoa.jobs.webapp.manager.scheduleInfoManager"> <property name="scheduler" ref="schedulerFactory"/> </bean> <bean id="schedulerJobDetail" class="org.springframework.scheduling.quartz.MethodInvokingJobDetailFactoryBean"> <property name="targetObject" ref="scheduleInfoManager"/> <property name="targetMethod" value="reScheduleJob"/> <property name="concurrent" value="false"/> </bean> <bean id="cronTrigger" class="org.springframework.scheduling.quartz.CronTriggerBean" > <property name="jobDetail" ref="schedulerJobDetail"/> <property name="cronExpression"> <value>0/10 * * * * ?</value> </property> </bean> <bean id="schedulerFactory" class="org.springframework.scheduling.quartz.SchedulerFactoryBean"> <property name="triggers"> <list> <ref local="cronTrigger"/> </list> </property> </bean>
scheduleInfoManager中的reScheduleJob()方法及相关方法①reScheduleJob读取数据库,获得自定义定时器调度时间():
private Scheduler scheduler; // 设值注入,通过setter方法传入被调用者的实例scheduler public void setScheduler(Scheduler scheduler) { this.scheduler = scheduler; } private void reScheduleJob() throws SchedulerException,ParseException { // 运行时可通过动态注入的scheduler得到trigger,注意采用这种注入方式在有的项目中会有问题,如果遇到注入问题,可以采取在运行方法时候,获得bean来避免错误发生。 CronTriggerBean trigger = (CronTriggerBean) scheduler.getTrigger( "cronTrigger", Scheduler.DEFAULT_GROUP); String dbCronExpression = getCronExpressionFromDB(); String originConExpression = trigger.getCronExpression(); // 判断从DB中取得的任务时间(dbCronExpression)和现在的quartz线程中的任务时间(originConExpression)是否相等 // 如果相等,则表示用户并没有重新设定数据库中的任务时间,这种情况不需要重新rescheduleJob if(!originConExpression.equalsIgnoreCase(dbCronExpression)){ trigger.setCronExpression(dbCronExpression); scheduler.rescheduleJob("cronTrigger", Scheduler.DEFAULT_GROUP, trigger); } // 下面是具体的job内容,可自行设置 // executeJobDetail();}
②getCronExpressionFromDB():从数据库中获得dbCronExpression的具体代码,由于使用了scheduleInfoManager,所以要在定义相应的setter方法:
private String getCronExpressionFromDB(){ String sql="from ScheduleInfo scheduleInfo where 1=1 "; sql=sql+" and scheduleInfo.infoId = '"+"1" + "'"; List scheduleList = scheduleInfoManager.queryScheduleInListBySql(sql); ScheduleInfo scheduleInfo = (ScheduleInfo)scheduleList.get(0); String dbCronExpression = scheduleInfo.getCronExpression(); return dbCronExpression; }③ 在spring配置文件的scheduleInfoManager配置了相应的property(scheduler/
scheduleInfoManager),要为其设置setter方法: private Scheduler scheduler; // 设值注入,通过setter方法传入被调用者的实例scheduler public void setScheduler(Scheduler scheduler) { this.scheduler = scheduler; } private ScheduleInfoManager scheduleInfoManager; // 设值注入,通过setter方法传入被调用者的实例scheduleInfoManager public void setScheduleInfoManager(ScheduleInfoManager scheduleInfoManager){ this.scheduleInfoManager = scheduleInfoManager; }
Quartz在Spring中动态设置cronTrigger方法二在上面的2中我们可以看到,尽管已经可以动态进行rescheduleJob了,不过依然需要我们设置一个cronExpression,如果尝试一下拿掉spring配置中的
<propertyname="cronExpression">
<value>0/10****?</value>
</property>
则容器(如tomcat)启动时会报错。实际中我们希望tomcat启动时就可以直接去读数据库,拿到相应的dbCronExpression,然后定时执行一个job,而不希望配置初始的cronExpression,观察下面的CronTriggerBean,考虑到cronExpression需要初始化,如果设定一个类InitializingCronTrigger继承CronTriggerBean,然后在这个类中做一些读取DB的初始化工作(设置cronExpression),问题就可以解决了。Spring配置文件:
<bean id="scheduleInfoManager" class="com.lively.happyoa.jobs.webapp.manager.ScheduleInfoManager"> <property name="scheduler" ref="schedulerFactory"/> </bean> <bean id="schedulerJobDetail" class="org.springframework.scheduling.quartz.MethodInvokingJobDetailFactoryBean"> <property name="targetObject" ref="scheduleInfoManager"/> <property name="targetMethod" value="reScheduleJob"/> <property name="concurrent" value="false"/> </bean> <bean id="cronTrigger" class="com.lively.happyoa.jobs.webapp.manager.ScheduleInfoManager.InitializingCronTrigger"> <property name="jobDetail" ref="schedulerJobDetail"/> <!--<property name="cronExpression"> <value>0/10 * * * * ?</value> </property>--> <property name="scheduleInfoManager" ref="scheduleInfoManager"/> </bean> <bean id="schedulerFactory" class="org.springframework.scheduling.quartz.SchedulerFactoryBean"> <property name="triggers"> <list> <ref local="cronTrigger"/> </list> </property> </bean>
InitializingCronTrigger中的相关方法注意:在注入scheduleInfoManager属性的时候,我们可以去读取DB任务时间(之所以放在setter方法中,是因为需要在设置scheduleInfoManager后进行getCronExpressionFromDB(),否则,也可以①②逻辑把放在类的构造函数中).注意InitializingCronTrigger必须extendsCronTriggerBean.
public class InitializingCronTrigger extends CronTriggerBean implements Serializable { private ScheduleInfoManager scheduleInfoManager; // 设值注入,通过setter方法传入被调用者的实例scheduleInfoManager public void setScheduleInfoManager(ScheduleInfoManager scheduleInfoManager){ this.scheduleInfoManager = scheduleInfoManager; // 因为在getCronExpressionFromDB使用到了scheduleInfoManager,所以 // 必须上一行代码设置scheduleInfoManager后进行 getCronExpressionFromDB String cronExpression = getCronExpressionFromDB (); // ① // 因为extends CronTriggerBean ,此处调用父类方法初始化cronExpression setCronExpression(cronExpression); // ②} private String getCronExpressionFromDB(){ String sql="from ScheduleInfo scheduleInfo where 1=1 "; sql=sql+" and scheduleInfo.infoId = '"+"1" + "'"; List scheduleList = scheduleInfoManager.queryScheduleInListBySql(sql); ScheduleInfo scheduleInfo = (ScheduleInfo)scheduleList.get(0); String dbCronExpression = scheduleInfo.getCronExpression(); return dbCronExpression;}……}
Quartz中时间参数说明即Cron表达式
Cron表达式
Quartz使用类似于Linux下的Cron表达式定义时间规则,Cron表达式由6或7个由空格分隔的时间字段组成,如表1所示:
表1Cron表达式时间字段
位置时间域名允许值允许的特殊字符1秒0-59,-*/2分钟0-59,-*/3小时0-23,-*/4日期1-31,-*?/LWC5月份1-12,-*/6星期1-7,-*?/LC#7年(可选)空值1970-2099,-*/
Cron表达式的时间字段除允许设置数值外,还可使用一些特殊的字符,提供列表、范围、通配符等功能,细说如下:
●星号(*):可用在所有字段中,表示对应时间域的每一个时刻,例如,*在分钟字段时,表示“每分钟”;
●问号(?):该字符只在日期和星期字段中使用,它通常指定为“无意义的值”,相当于点位符;
●减号(-):表达一个范围,如在小时字段中使用“10-12”,则表示从10到12点,即10,11,12;
●逗号(,):表达一个列表值,如在星期字段中使用“MON,WED,FRI”,则表示星期一,星期三和星期五;
●斜杠(/):x/y表达一个等步长序列,x为起始值,y为增量步长值。如在分钟字段中使用0/15,则表示为0,15,30和45秒,而5/15在分钟字段中表示5,20,35,50,你也可以使用*/y,它等同于0/y;
●L:该字符只在日期和星期字段中使用,代表“Last”的意思,但它在两个字段中意思不同。L在日期字段中,表示这个月份的最后一天,如一月的31号,非闰年二月的28号;如果L用在星期中,则表示星期六,等同于7。但是,如果L出现在星期字段里,而且在前面有一个数值X,则表示“这个月的最后X天”,例如,6L表示该月的最后星期五;
●W:该字符只能出现在日期字段里,是对前导日期的修饰,表示离该日期最近的工作日。例如15W表示离该月15号最近的工作日,如果该月15号是星期六,则匹配14号星期五;如果15日是星期日,则匹配16号星期一;如果15号是星期二,那结果就是15号星期二。但必须注意关联的匹配日期不能够跨月,如你指定1W,如果1号是星期六,结果匹配的是3号星期一,而非上个月最后的那天。W字符串只能指定单一日期,而不能指定日期范围;
●LW组合:在日期字段可以组合使用LW,它的意思是当月的最后一个工作日;
●井号(#):该字符只能在星期字段中使用,表示当月某个工作日。如6#3表示当月的第三个星期五(6表示星期五,#3表示当前的第三个),而4#5表示当月的第五个星期三,假设当月没有第五个星期三,忽略不触发;
●C:该字符只在日期和星期字段中使用,代表“Calendar”的意思。它的意思是计划所关联的日期,如果日期没有被关联,则相当于日历中所有日期。例如5C在日期字段中就相当于日历5日以后的第一天。1C在星期字段中相当于星期日后的第一天。
Cron表达式对特殊字符的大小写不敏感,对代表星期的缩写英文大小写也不敏感。
表2下面给出一些完整的Cron表示式的实例:
表2Cron表示式示例
表示式
说明
"0012**?"每天12点运行"01510?**"每天10:15运行"01510**?"每天10:15运行"01510**?*"每天10:15运行"01510**?2008"在2008年的每天10:15运行"0*14**?"每天14点到15点之间每分钟运行一次,开始于14:00,结束于14:59。"00/514**?"每天14点到15点每5分钟运行一次,开始于14:00,结束于14:55。"00/514,18**?"每天14点到15点每5分钟运行一次,此外每天18点到19点每5钟也运行一次。"00-514**?"每天14:00点到14:05,每分钟运行一次。"010,4414?3WED"3月每周三的14:10分到14:44,每分钟运行一次。"01510?*MON-FRI"每周一,二,三,四,五的10:15分运行。"0151015*?"每月15日10:15分运行。"01510L*?"每月最后一天10:15分运行。"01510?*6L"每月最后一个星期五10:15分运行。"01510?*6L2007-2009"在2007,2008,2009年每个月的最后一个星期五的10:15分运行。"01510?*6#3"每月第三个星期五的10:15分运行。
注意:CronTriggerBean的cronExpression属性指定格式:至少6个时间元素,上面表示每天的15:37-38分执行1次任务。
时间元素(按照顺序):
秒(0-59):
分(0-59):
小时(0-23):
每月第几天(1-31):
月(1-12或JAN-DEC):
每星期第几天(1-7或SUN-SAT):
年(1970-2099):
其中:不用设置的用”?”.
(1)每月第几天和每星期第几天是互斥的,两个只能设置1个。如果有好几个时间点,可以使用”,”符号,例如:”0010,12,14**?”表示每天的10时,12时,14时执行Job.
(2)对于连续时间可以使用”-”符号。例如:”010,12,141-15*?”表示每月的1到15日10时,12时,14时执行Job.
(3)时间格式的年可以不用制定。例如”0010,12,14?MON2006”表示2006年每星期一的10时,12时,14时执行Job.