Spring任务调度之Quartz

Posted 2020-11-02 緈諨の約錠

tags:

篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了Spring任务调度之Quartz相关的知识，希望对你有一定的参考价值。

一、Quartz作业类的继承方式来讲，可以分为两类：

作业类需要继承自特定的作业类基类，如Quartz中需要继承自org.springframework.scheduling.quartz.QuartzJobBean；java.util.Timer中需要继承自java.util.TimerTask。
作业类即普通的java类，不需要继承自任何基类。

注:推荐使用第二种方式，因为这样所以的类都是普通类，不需要事先区别对待。

从任务调度的触发时机来分，这里主要是针对作业使用的触发器，主要有以下两种：

每隔指定时间则触发一次，在Quartz中对应的触发器为：org.springframework.scheduling.quartz.SimpleTriggerBean
每到指定时间则触发一次，在Quartz中对应的调度器为：org.springframework.scheduling.quartz.CronTriggerBean

注：并非每种任务都可以使用这两种触发器，如java.util.TimerTask任务就只能使用第一种。Quartz和spring task都可以支持这两种触发条件。

二、第一种，作业类继承自特定的基类：org.springframework.scheduling.quartz.QuartzJobBean

第一步：定义作业类

import org.quartz.JobExecutionContext; 
import org.quartz.JobExecutionException; 
import org.springframework.scheduling.quartz.QuartzJobBean; 
public class Job1 extends QuartzJobBean { 
   
private int timeout; 
private static int i = 0; 
//调度工厂实例化后，经过timeout时间开始执行调度 
public void setTimeout(int timeout) { 
this.timeout = timeout; 
} 
   
/**
* 要调度的具体任务
*/ 
@Override 
protected void executeInternal(JobExecutionContext context) 
throws JobExecutionException { 
  System.out.println("定时任务执行中…"); 
} 
} 

　 第二步：spring配置文件中配置作业类JobDetailBean　

<bean name="job1" class="org.springframework.scheduling.quartz.JobDetailBean"> 
<property name="jobClass" value="com.gy.Job1" /> 
<property name="jobDataAsMap"> 
   <map> 
       <entry key="timeout" value="0" /> 
   </map> 
</property> 
</bean> 

　说明：org.springframework.scheduling.quartz.JobDetailBean有两个属性，jobClass属性即我们在java代码中定义的任务类，jobDataAsMap属性即该任务类中需要注入的属性值。　

第三步：配置作业调度的触发方式（触发器）

Quartz的作业触发器有两种，分别是

org.springframework.scheduling.quartz.SimpleTriggerBean

org.springframework.scheduling.quartz.CronTriggerBean

第一种 SimpleTriggerBean，只支持按照一定频度调用任务，如每隔30分钟运行一次。配置方式如下：

<bean id="simpleTrigger" class="org.springframework.scheduling.quartz.SimpleTriggerBean"> 
<property name="jobDetail" ref="job1" /> 
<property name="startDelay" value="0" /><!– 调度工厂实例化后，经过0秒开始执行调度 –> 
<property name="repeatInterval" value="2000" /><!– 每2秒调度一次 –> 
</bean> 

第二种 CronTriggerBean，支持到指定时间运行一次，如每天12:00运行一次等。配置方式如下：

<bean id="cronTrigger" class="org.springframework.scheduling.quartz.CronTriggerBean"> 
<property name="jobDetail" ref="job1" /> 
<!—每天12:00运行一次 —> 
<property name="cronExpression" value="0 0 12 * * ?" /> 
</bean> 

第四步：配置调度工厂

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

说明：该参数指定的就是之前配置的触发器的名字。

第五步：启动你的应用即可，即将工程部署至tomcat或其他容器。

三、第二种，作业类不继承特定基类。

Spring能够支持这种方式，归功于两个类：

org.springframework.scheduling.timer.MethodInvokingTimerTaskFactoryBean

org.springframework.scheduling.quartz.MethodInvokingJobDetailFactoryBean

这两个类分别对应spring支持的两种实现任务调度的方式，即前文提到到java自带的timer task方式和Quartz方式。这里我只写MethodInvokingJobDetailFactoryBean的用法，使用该类的好处是,我们的任务类不再需要继承自任何类，而是普通的pojo。

第一步：编写任务类

public class Job2 { 
public void doJob2() { 
System.out.println("不继承QuartzJobBean方式-调度进行中…"); 
} 
}

说明：可以看出，这就是一个普通的类，并且有一个方法。

第二步：配置作业类

<bean id="job2" 
class="org.springframework.scheduling.quartz.MethodInvokingJobDetailFactoryBean"> 
<property name="targetObject"> 
<bean class="com.gy.Job2" /> 
</property> 
<property name="targetMethod" value="doJob2" /> 
<property name="concurrent" value="false" /><!– 作业不并发调度 –> 
</bean> 

说明：这一步是关键步骤，声明一个MethodInvokingJobDetailFactoryBean，有两个关键属性：targetObject指定任务类，targetMethod指定运行的方法。往下的步骤就与方法一相同了，为了完整，同样贴出。

第三步：配置作业调度的触发方式（触发器）

Quartz的作业触发器有两种，分别是

org.springframework.scheduling.quartz.SimpleTriggerBean

org.springframework.scheduling.quartz.CronTriggerBean

第一种SimpleTriggerBean，只支持按照一定频度调用任务，如每隔30分钟运行一次。配置方式如下：

<bean id="simpleTrigger" class="org.springframework.scheduling.quartz.SimpleTriggerBean"> 
<property name="jobDetail" ref="job2" /> 
<property name="startDelay" value="0" /><!– 调度工厂实例化后，经过0秒开始执行调度 –> 
<property name="repeatInterval" value="2000" /><!– 每2秒调度一次 –> 
</bean> 

第二种CronTriggerBean，支持到指定时间运行一次，如每天12:00运行一次等。配置方式如下：

ronTriggerBean"> 
<property name="jobDetail" ref="job2" /> 
<!—每天12:00运行一次 —> 
<property name="cronExpression" value="0 0 12 * * ?" /> 
</bean> 

以上两种调度方式根据实际情况，任选一种即可。

第四步：配置调度工厂

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

说明：该参数指定的就是之前配置的触发器的名字。

第五步：启动你的应用即可，即将工程部署至tomcat或其他容器。　　

到此，spring中Quartz的基本配置就介绍完了，当然了，使用之前，要导入相应的spring的包与Quartz的包，这些就不消多说了。

其实可以看出Quartz的配置看上去还是挺复杂的，没有办法，因为Quartz其实是个重量级的工具，如果我们只是想简单的执行几个简单的定时任务，有没有更简单的工具，有！

Demo

====================================quartz.xml配置文件===================================

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE beans PUBLIC "-//SPRING//DTD BEAN//EN" "http://www.springframework.org/dtd/spring-beans.dtd">

<beans>

<bean id="testQuartz"
class="org.springframework.scheduling.quartz.JobDetailFactoryBean">
<property name="jobClass">
<value>
cn.yunhwa.test.TestQuartz
</value>
</property>
<property name="jobDataAsMap">
<map>
<entry key="timeout" value="666" />
</map>
</property>
</bean>

<bean id="simpleTrigger" class="org.springframework.scheduling.quartz.SimpleTriggerFactoryBean" lazy-init="true">
<property name="jobDetail" ref="testQuartz"/>

<property name="repeatCount" value="2"/>

<property name="repeatInterval" value="10000"/>

<property name="startDelay" value="1000"/>
</bean>


<bean id="jobScheduler" lazy-init="false" autowire ="no" class="org.springframework.scheduling.quartz.SchedulerFactoryBean">
<property name="triggers">
<list>

<ref bean="simpleTrigger" />

</list>
</property>
</bean>
</beans>

========================测试类TestQuartz=======================

package cn.yunhwa.test;

import org.quartz.JobExecutionContext;
import org.quartz.JobExecutionException;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.scheduling.quartz.QuartzJobBean;

public class TestQuartz extends QuartzJobBean {

private Logger logger = LoggerFactory.getLogger(TestTask.class);

private int timeout;

// 调度工厂实例化后，经过timeout时间开始执行调度
public void setTimeout(int timeout) {
this.timeout = timeout;
}

@Override
protected void executeInternal(JobExecutionContext arg0) throws JobExecutionException {
// TODO Auto-generated method stub
logger.debug("quartz定时任务经过{}时间开始执行调度！", timeout);
}

}

引用原文：http://www.cnblogs.com/hongwz/p/5642429.html

写博客是为了记住自己容易忘记的东西，另外也是对自己工作的总结，文章可以转载，无需版权。希望尽自己的努力，做到更好，大家一起努力进步！

如果有什么问题，欢迎大家一起探讨，代码如有问题，欢迎各位大神指正！

以上是关于Spring任务调度之Quartz的主要内容，如果未能解决你的问题，请参考以下文章

Spring任务调度之Quartz

从任务调度的触发时机来分，这里主要是针对作业使用的触发器，主要有以下两种：