Spring整合Quartz实现定时任务调度

最新推荐文章于 2020-02-16 19:07:00 发布

weixin_34409741

最新推荐文章于 2020-02-16 19:07:00 发布

阅读量105

点赞数

文章标签：数据库 python java

原文链接：https://my.oschina.net/u/2369810/blog/676718

版权

2019独角兽企业重金招聘Python工程师标准>>>

Spring 提供了几个帮助类用于在应用中做调度，包括JDK Timer类和OpenSymphony Quartz Scheduler两种.

Quartz基础
Quartz包括五种主要结构用于实现调度：

Job接口 JobDetail类 Trigger 抽象类 Scheduler接口 SchedulerFactory 接口 Job接口表示一个作业(job)。一个作业专注做一件事。它的API非常简洁。只有一个execute方法，该方法在作业被执行时有Quartz调度。该方法有一个JobExecuteContext参数，可以通过该参数给execute()方法传递有用信息。

public interface Job{
void execute(JobExecuteContext ctx);
}
一些数据可以通过JobDataMap传递给作业。如果一个JobDataMap被注册到JobDetail中，就能够在作业中通过 JobExecuteContext来访问。JobDetail用来描述一个特定Job的信息。Job通过触发器（Trigger）触发。Quartz提供了集中Trigger的实现，如SimpleTrigger和CronTrigger。SimpleTrigger类似一个简单时钟，你可以定义开始是建，结束时间，重复次数，重复周期。CronTrigger类似Linux系统中的cron。CronTrigger的设置可以非常详细，如在每个月最后一个周五的上午10:15执行作业。需要注意的是Trigger和Job是具名的，可以被赋值给一个组，在同一组内不能出现同名。你可以对一个组创建一个触发器，在该组内的所有Job都将会执行。 SchedulerFactory 用于获得Scheduler实例，可以用于注册作业和触发器。

实现一个简单的实例：每十秒钟打印一次欢迎。
首先实现一个作业：

public class SimpleJob implements Job {
    @Override
    public void execute(JobExecutionContext arg0)
    throws JobExecutionException {
        System.out.println("[JOB] Welcome to Quartz!");
    }
}

定义一个Scheduler，注册触发器和作业:

public class SimpleSchedule {
    public static void main(String[] args) {
        SchedulerFactory factory=new StdSchedulerFactory();
        try {
            Scheduler scheduler = factory.getScheduler();
            scheduler.start();

            JobDetail jobDetail = new JobDetail("SimpleJob",null, SimpleJob.class);
            Trigger simplerTrigger = TriggerUtils.makeSecondlyTrigger(10);
            simplerTrigger.setName("SimpleTrigger");

            scheduler.scheduleJob(jobDetail, simplerTrigger);
        }catch (SchedulerException e) {
            // TODO Auto-generated catch block
            e.printStackTrace();
        }
    }
}

执行过后，每十秒输出[JOB] Welcome to Quartz!

Spring中的Quartz
Spring中的Quartz API位于org.springframework.scheduling.quartz包中。主要类结构包括：

QuartzJobBean 抽象类
JobDetailBean
SimpleTriggerBean
CronTriggerBean
SchedulerFactoryBean
MethodInvokingDetailFactoryBean
很明显对应实现Quartz中相应的接口。QuartzJob实现Job，JobDetailBean继承JobDetail。 SimpleTriggerBean和CronTriggerBean继承自相应的Trigger。 MethodInvokingJobDetailFactoryBean用于在类中调用任何对象的方法。声明Job

JobDetailBean用于声明作业。可以为其设置作业名，以及需要的数据。

<bean name="simpleJob" class="org.springframework.scheduling.quartz.JobDetailBean">
    <property name="jobClass" value="com.alibaba.jiang.learn.quartz.SimpleJob" />
    <property name="jobDataAsMap">
        <map>
            <entry key="message" value="Welcome to Quartz" />
        </map>
    </property>
</bean>

实现Job类：

public class SimpleJob extends QuartzJobBean {
    @Override
    protected void executeInternal(JobExecutionContext ctx) throws JobExecutionException {
        String message = ctx.getJobDetail().getJobDataMap().getString("message");
        System.out.println(message);
    }
}

还可以通过setter注入的方式注入message。声明触发器：

<bean name="simpleTrigger" class="org.springframework.scheduling.quartz.SimpleTriggerBean">
    <property name="jobDetail" ref="simpleJob"/>
    <property name="startDelay" value="0"/>
    <property name="repeatInterval" value="10000"/>
</bean>

声明调度器,设置Job和Trigger：

<bean name="schedulerFactory" class="org.springframework.scheduling.quartz.SchedulerFactoryBean">
    <property name="triggers">
        <list>
            <ref bean="simpleTrigger"/>
        </list>
    </property>
</bean>

所有都设置好后，可以通过加载Context，调度器将自动执行：

public class SimpleSpringQuartz {
    public static void main(String[] args) {
        ApplicationContext ctx = new ClassPathXmlApplicationContext("beans.xml");
    }
}

使用MethodInvokingJobFactoryBean

上面的范例使用的是Quartz Job，事实上在Spring中可以使用自定义Pojo Bean，无须继承自QuartzJobBean。首先声明一个PojoBean

<bean name="welcomeBean" class="com.alibaba.jiang.learn.quartz.WelcomeBean">
<property name="message" value="Welcome to Quartz Method"/>
</bean>
对应的Pojo Bean：

public class WelcomeBean {
    private String message;
    public void setMessage(String message) {
        this.message = message;
    }
    public void welcome(){
        System.out.println(message);
    }
}

声明MethodInvokingJobDetailFactoryBean:

<bean name="methodInvokingJob" class="org.springframework.scheduling.quartz.MethodInvokingJobDetailFactoryBean">
    <property name="targetObject" ref="welcomeBean"/>
    <property name="targetMethod" value="welcome"/>
</bean>
<bean name="methodTrigger" class="org.springframework.scheduling.quartz.SimpleTriggerBean">
    <property name="jobDetail" ref="methodInvokingJob" />
    <property name="startDelay" value="0"/>
    <property name="repeatInterval" value="10000"/>
</bean>

注意
一个触发器只能触发一个Job，不过一个Job可以有多个Trigger触发，这回带来并发问题。在Quartz中，如果你不想并发执行一个同一个 Job，你可以实现StatefulJob，而不是Job。在Spring中如果使用 MethodInvokingJobDetailFactoryBean，可以通过设置concurrent="false"属性来实现。

尾注
在Spring中使用Quartz而不是单独的一个应用的好处包括：

将所有的任务调度设置放在同一个地方，是任务易于维护。
只对Job编码，Trigger和Scheduler可以通过配置设置
可以使用Pojo Java Bean执行job，而无需实现Job接口

Cron表达式的详细用法
字段允许值允许的特殊字符
秒 0-59 , - * /
分 0-59 , - * /
小时 0-23 , - * /
日期 1-31 , - * ? / L W C
月份 1-12 或者 JAN-DEC , - * /
星期 1-7 或者 SUN-SAT , - * ? / L C #
年（可选）留空, 1970-2099 , - * /

例子：
0/5 * * * * ? ：每5秒执行一次
“”字符被用来指定所有的值。如：""在分钟的字段域里表示“每分钟”。
“?”字符只在日期域和星期域中使用。它被用来指定“非明确的值”。当你需要通过在这两个域中的一个来指定一些东西的时候，它是有用的。看下面的例子你就会明白。
月份中的日期和星期中的日期这两个元素时互斥的一起应该通过设置一个问号来表明不想设置那个字段。

“-”字符被用来指定一个范围。如：“10-12”在小时域意味着“10点、11点、12点”。

“,”字符被用来指定另外的值。如：“MON,WED,FRI”在星期域里表示”星期一、星期三、星期五”。

“/”字符用于指定增量。如：“0/15”在秒域意思是每分钟的0，15，30和45秒。“5/15”在分钟域表示每小时的5，20，35和50。符号“”在“/”前面（如：/10）等价于0在“/”前面（如：0/10）。记住一条本质：表达式的每个数值域都是一个有最大值和最小值的集合，如：秒域和分钟域的集合是0-59，日期域是 1-31，月份域是1-12。字符“/”可以帮助你在每个字符域中取相应的数值。如：“7/6”在月份域的时候只有当7月的时候才会触发，并不是表示每个 6月。

L是‘last’的省略写法可以表示day-of-month和day-of-week域，但在两个字段中的意思不同，例如day-of- month域中表示一个月的最后一天。如果在day-of-week域表示‘7’或者‘SAT’，如果在day-of-week域中前面加上数字，它表示一个月的最后几天，例如‘6L’就表示一个月的最后一个星期五。

字符“W”只允许日期域出现。这个字符用于指定日期的最近工作日。例如：如果你在日期域中写 “15W”，表示：这个月15号最近的工作日。所以，如果15号是周六，则任务会在14号触发。如果15好是周日，则任务会在周一也就是16号触发。如果是在日期域填写“1W”即使1号是周六，那么任务也只会在下周一，也就是3号触发，“W”字符指定的最近工作日是不能够跨月份的。字符“W”只能配合一个单独的数值使用，不能够是一个数字段，如：1-15W是错误的。

“L”和“W”可以在日期域中联合使用，LW表示这个月最后一周的工作日。

字符“#”只允许在星期域中出现。这个字符用于指定本月的某某天。例如：“6#3”表示本月第三周的星期五（6表示星期五，3表示第三周）。“2#1”表示本月第一周的星期一。“4#5”表示第五周的星期三。

字符“C”允许在日期域和星期域出现。这个字符依靠一个指定的“日历”。也就是说这个表达式的值依赖于相关的“日历”的计算结果，如果没有“日历” 关联，则等价于所有包含的“日历”。如：日期域是“5C”表示关联“日历”中第一天，或者这个月开始的第一天的后5天。星期域是“1C”表示关联“日历” 中第一天，或者星期的第一天的后1天，也就是周日的后一天（周一）。

表达式举例


"0 0 12 * * ?" 每天中午12点触发
"0 15 10 ? * *" 每天上午10:15触发
"0 15 10 * * ?" 每天上午10:15触发
"0 15 10 * * ? *" 每天上午10:15触发
"0 15 10 * * ? 2005" 2005年的每天上午10:15触发
"0 * 14 * * ?" 在每天下午2点到下午2:59期间的每1分钟触发
"0 0/5 14 * * ?" 在每天下午2点到下午2:55期间的每5分钟触发
"0 0/5 14,18 * * ?" 在每天下午2点到2:55期间和下午6点到6:55期间的每5分钟触发
"0 0-5 14 * * ?" 在每天下午2点到下午2:05期间的每1分钟触发
"0 10,44 14 ? 3 WED" 每年三月的星期三的下午2:10和2:44触发
"0 15 10 ? * MON-FRI" 周一至周五的上午10:15触发
"0 15 10 15 * ?" 每月15日上午10:15触发
"0 15 10 L * ?" 每月最后一日的上午10:15触发
"0 15 10 ? * 6L" 每月的最后一个星期五上午10:15触发 
"0 15 10 ? * 6L 2002-2005" 2002年至2005年的每月的最后一个星期五上午10:15触发
"0 15 10 ? * 6#3" 每月的第三个星期五上午10:15触发

在数据库中建表。建表模版在Quartz包下docs/dbTables下，选择相应的数据库和版本即可。ORACLE的11个Table列表如下：

QRTZ_JOB_LISTENERS：存储有关已配置的 JobListener 的信息

 JOB_NAME
 JOB_GROUP
 JOB_LISTENER
QRTZ_TRIGGER_LISTENERS：存储已配置的 TriggerListener 的信息

QRTZ_FIRED_TRIGGERS：存储与已触发的 Trigger 相关的状态信息，以及相联 Job的执行信息

QRTZ_PAUSED_TRIGGER_GRPS：存储已暂停的 Trigger 组的信息

QRTZ_SCHEDULER_STATE：存储集群中note实例信息，quartz会定时读取该表的信息判断集群中每个实例的当前状态

 INSTANCE_NAME 之前配置文件中org.quartz.scheduler.instanceId配置的名字，就会写入该字段，如果设置为AUTO,quartz会根据物理机名和当前时间产生一个名字
 LAST_CHECKIN_TIME：上次检查时间
 CHECKIN_INTERVAL ：检查间隔时间
QRTZ_LOCKS：存储程序的悲观锁的信息(假如使用了悲观锁) 

QRTZ_SIMPLE_TRIGGERS：存储简单的Trigger，包括重复次数，间隔，以及已触的次数

 TRIGGER_NAME ：qrtz_triggers表trigger_name的外键
 TRIGGER_GROUP：qrtz_triggers表trigger_group的外键
 REPEAT_COUNT ：重复次数
 REPEAT_INTERVAL：时间间隔
 TIMES_TRIGGERED：触发次数
QRTZ_CRON_TRIGGERS：存储cron表达式表

 TRIGGER_NAME ：qrtz_triggers表trigger_name的外键
 TRIGGER_GROUP：qrtz_triggers表trigger_group的外键 
 CRON_EXPRESSION：cron表达式
 TIME_ZONE_ID ：时区
QRTZ_TRIGGERS：保存trigger信息

 TRIGGER_NAME ：trigger的名字,该名字用户自己可以随意定制,无强行要求
 TRIGGER_GROUP：所属组的名字,该名字用户自己随意定制,无强行要求
 JOB_NAME ：qrtz_job_details表job_name的外键
 JOB_GROUP ：qrtz_job_details表job_group的外键
 IS_VOLATILE 0
 DESCRIPTION
 NEXT_FIRE_TIME
 PREV_FIRE_TIME
 PRIORITY 5
 TRIGGER_STATE ：当前trigger状态，设置为ACQUIRED,如果设置为WAITING,则job不会触发
 TRIGGER_TYPE：触发器类型,使用cron表达式
 START_TIME
 END_TIME
 CALENDAR_NAME
 MISFIRE_INSTR
 JOB_DATA
QRTZ_JOB_DETAILS：保存job详细信息,该表需要用户根据实际情况初始化

 JOB_NAME ：集群中job的名字,该名字用户自己可以随意定制,无强行要求
 JOB_GROUP ：集群中job的所属组的名字,该名字用户自己随意定制,无强行要求 
 DESCRIPTION
 JOB_CLASS_NAME：集群中个note job实现类的完全包名,quartz就是根据这个路径到classpath找到该job类 
 IS_DURABLE：是否持久化,把该属性设置为1，quartz会把job持久化到数据库中
 IS_VOLATILE
 IS_STATEFUL
 REQUESTS_RECOVERY
 JOB_DATA ：一个blob字段，存放持久化job对象
QRTZ_CALENDARS：以 Blob 类型存储 Quartz 的 Calendar 信息

QRTZ_BLOB_TRIGGERS：作为 Blob 类型存储(用于 Quartz 用户用 JDBC创建他们自己定制的 Trigger 类型，JobStore 并不知道如何存储实例的时候) 

 TRIGGER_NAME ：qrtz_triggers表trigger_name的外键
 TRIGGER_GROUP：qrtz_triggers表trigger_group的外键 
 BLOB_DATA

Quartz 调度任务所需的配置文件

org.quartz.scheduler.instanceName属性可为任何值，用在 JDBC JobStore 中来唯一标识实例，但是所有集群节点中必须相同。 

org.quartz.scheduler.instanceName = HumsScheduler 

##org.quartz.scheduler.instanceId　属性为 AUTO即可，基于主机名和时间戳来产生实例 ID。 

org.quartz.scheduler.instanceId = AUTO 

orgorg.quartz.threadPool.class = org.quartz.simpl.SimpleThreadPool 

org.quartz.threadPool.threadCount = 10 

org.quartz.threadPool.threadPriority = 5 

org.quartz.threadPool.threadsInheritContextClassLoaderOfInitializingThread = true 

org.quartz.jobStore.misfireThreshold = 60000 

##org.quartz.jobStore.class属性为 JobStoreTX，将任务持久化到数据中。 

##因为集群中节点依赖于数据库来传播 Scheduler 实例的状态，你只能在使用 JDBC JobStore 时应用 Quartz 集群。 

##这意味着你必须使用 JobStoreTX 或是 JobStoreCMT 作为 Job 存储；你不能在集群中使用 RAMJobStore。 

orgorg.quartz.jobStore.class = org.quartz.impl.jdbcjobstore.JobStoreTX 

orgorg.quartz.jobStore.driverDelegateClass=org.quartz.impl.jdbcjobstore.StdJDBCDelegate 

org.quartz.jobStore.tablePrefix = QRTZ_ 

org.quartz.jobStore.maxMisfiresToHandleAtATime=10 

##org.quartz.jobStore.isClustered 属性为 true，你就告诉了 Scheduler 实例要它参与到一个集群当中。 

##这一属性会贯穿于调度框架的始终，用于修改集群环境中操作的默认行为。 

org.quartz.jobStore.isClustered = true 

##org.quartz.jobStore.clusterCheckinInterval 属性定义了Scheduler 实例检入到数据库中的频率(单位：毫秒)。 

##Scheduler 检查是否其他的实例到了它们应当检入的时候未检入；这能指出一个失败的 Scheduler 实例，且当前 Scheduler 会以此来接管任何执行失败并可恢复的 Job。 

##通过检入操作，Scheduler 也会更新自身的状态记录。clusterChedkinInterval 越小，Scheduler 节点检查失败的 Scheduler 实例就越频繁。默认值是 15000 (即15 秒)。 

org.quartz.jobStore.clusterCheckinInterval = 20000

<!-- 定时调度 -->
	<bean name="scheduler"
		class="org.springframework.scheduling.quartz.SchedulerFactoryBean">
		<property name="dataSource" ref="dataSource" />
		<property name="configLocation" value="classpath:quartz.properties" />
		<property name="autoStartup" value="true" /><!-- 开发时可以改成false -->
		<!-- 添加监听器 -->
		<property name="globalTriggerListeners">
			<list>
				<ref bean="catLogTriggerListener" />
			</list>
		</property>
	</bean>

	<bean id="catLogTriggerListener" class="com.becom.schedule.trigger.CatLogTriggerListener"></bean>

package com.becom.schedule.trigger;

import org.quartz.JobExecutionContext;
import org.quartz.Trigger;
import org.quartz.Trigger.CompletedExecutionInstruction;
import org.quartz.TriggerListener;

import com.dianping.cat.Cat;

public class CatLogTriggerListener implements TriggerListener {

    public String getName() {
	return "CatLogTriggerListener";
    }

    /**
     * 被调度时触发，和它相关的org.quartz.jobdetail即将执行。 该方法优先vetoJobExecution()执行
     */
    public void triggerFired(Trigger trigger, JobExecutionContext context) {
    }

    /**
     * 被调度时触发，和它相关的org.quartz.jobdetail即将执行。
     */
    public boolean vetoJobExecution(Trigger trigger, JobExecutionContext context) {
	return false;
    }

    /**
     * 被调度时，触发失败时触发
     */
    public void triggerMisfired(Trigger trigger) {
	Object className = trigger.getJobKey().getName();
	if (className == null)
	    return;
	String classStr = className.toString();
	Class cls = null;
	try {
	    cls = Class.forName(classStr);
	} catch (ClassNotFoundException e1) {
	    return;
	}
	// 哑火
	Cat.logEvent("SCHEDULE_TRIGGER_MISFIRED", cls.getSimpleName(),
		"FAILED", null);
    }

    /**
     * 执行完毕时触发
     */
    public void triggerComplete(Trigger trigger, JobExecutionContext context,
	    int triggerInstructionCode) {
    }

    @Override
    public void triggerComplete(Trigger trigger, JobExecutionContext context,
	    CompletedExecutionInstruction triggerInstructionCode) {
    }

}

原文：http://www.open-open.com/lib/view/open1423663054857.html

http://blog.csdn.net/zxl315/article/details/10830105

转载于:https://my.oschina.net/u/2369810/blog/676718