您的位置:首页 > 其它

在Web应用中使用Quatz实现任务调度步骤

2008-11-26 11:54 1246 查看
在Web工程中,使用Quartz框架来实现定时调度:

1.导入相关的Quartz包:将以下用到的包放在我们工程的WEB-INF/lib目录下。
名称 必须/备注 网址

activation.jar 主要是 JavaMail 要用到 http://java.sun.com/products/javabeans/glasgow/jaf.html

commons-beanutils.jar 是 http://jakarta.apache.org/commons/beanutils

commons-collections.jar 是 http://jakarta.apache.org/commons/collections

commons-dbcp-1.1.jar 是,假如用到数据库作为作业存储 http://jakarta.apache.org/commons/dbcp

commons-digester.jar 是 假如你使用了某些插件,就需要它

commons-logging.jar 是 http://jakarta.apache.org/commons/logging/

commons-pool-1.1.jar http://jakarta.apache.org/commons/pool/

javamail.jar 发送 e-mail 用 http://java.sun.com/products/javamail/

jdbc2_0-stdext.jar 是,假如用到数据库作为作业存储 http://java.sun.com/products/jdbc/

jta.jar 是,假如用到数据库作为作业存储 http://java.sun.com/products/jta/database

quartz.jar 是 Quart 框架核心包

servlet.jar 假如使用了Servlet 容器,
但容器中应该存在 http://java.sun.com/products/servlet/

log4j.jar 一般都加上 http://logging.apache.org/

注意:如果在Web工程中导入了这些包,但是还是无法使程序正常运行,可以将下载的Quartz.zip解压后文件中涉及到的所有包均导入看是否可以正常运行(初学者一般都想在程序中看到效果,但又不知道到底哪些包是需要的,可以采用这个傻瓜方法,我就是这样干的,呵呵)
Quartz的核心jar包和一些依赖jar包还有可选jar包均在解压后文件quartz/lib中可以找到。

2.在我们工程的web.xml文件中增加如下配置:

<servlet>
<display-name>
Quartz Initializer Servlet
</display-name>
<servlet-name>
QuartzInitializer
</servlet-name>
<servlet-class>
org.quartz.ee.servlet.QuartzInitializerServlet
</servlet-class>
<init-param>
<param-name>config-file</param-name>
<param-value>/quartz.properties</param-value>
</init-param>
<init-param>
<param-name>shutdown-on-unload</param-name>
<param-value>true</param-value>
</init-param>
<load-on-startup>1</load-on-startup>

</servlet>

3.写一个Job类,就是自己想要调度的任务,例如我想调度发送邮件这个任务:
package songjie.service;

import java.util.Date;
import java.util.List;
import java.util.logging.Level;

import org.apache.log4j.Logger;
import org.quartz.Job;
import org.quartz.JobExecutionContext;
import org.quartz.JobExecutionException;

public class MailJob implements Job {
private static Logger logger = Logger.getLogger(MailJob.class);

public void execute(JobExecutionContext arg0) throws JobExecutionException {
logger.debug("MailJob[" + mailJob.hashCode() + "] begin at " + (new Date()));
logger.debug("Run mailJob at " + new Date());

}

}

说明:我们的Job类必须去实现org.quartz.Job ,其中完成任务的方法是execute我们可以在该方法中调用自己的逻辑组件完成操作并发送mail的功能,当然在必要的地方加上日志信息以便调试。

4.有了这个任务,那我们就该有个程序去控制这个任务在什么情况下起作用了,这就是Scheduler的作用了:

package songjie.service;

import org.apache.log4j.Logger;
import org.quartz.JobDetail;
import org.quartz.Scheduler;
import org.quartz.SchedulerException;
import org.quartz.Trigger;
import org.quartz.TriggerUtils;
import org.quartz.impl.StdSchedulerFactory;

public class SimpleScheduler {
private static Logger logger = Logger.getLogger(SimpleScheduler.class);
private Scheduler scheduler = null;
public static void main(String[] args) {
SimpleScheduler simple = new SimpleScheduler();
simple.startScheduler();
}
public void shutdownScheduler() throws SchedulerException{
scheduler.shutdown(true);//让任务执行完再关闭,默认的是false
}
public void startScheduler() {

try {
// Get a Scheduler instance from the Factory
scheduler = StdSchedulerFactory.getDefaultScheduler();

/**
//这是以硬编码的方法来部署一个job(即设置JobDetail和Trigger并调用scheduler.scheduleJob(jobDetail,trigger))
JobDetail jobDetail = new JobDetail("SendMail",Scheduler.DEFAULT_GROUP,MailJob.class);

// Create a trigger that fires every 10 seconds, forever
Trigger trigger = TriggerUtils.makeSecondlyTrigger(600);
trigger.setName("mailTrigger");
// Start the trigger firing from now
trigger.setStartTime(new Date());

// Associate the trigger with the job in the scheduler
scheduler.scheduleJob(jobDetail, trigger); */

// Start the scheduler
scheduler.start();
logger.info("Scheduler started at " + new Date());

} catch (SchedulerException ex) {
// deal with any exceptions
logger.error(ex);
}
}

}

5.有了上面这个Scheduler是不是我们的任务调度就可以实现了呢,回答是否定的,我们如果要让这个Scheduler起作用还需要让我们Web工程去start这个Scheduler

应该有许多办法可以让我们Web工程去start这个Scheduler,我只是用了一个Listener来实现的,如下:
import javax.servlet.ServletContextEvent;
import javax.servlet.ServletContextListener;

import org.quartz.SchedulerException;

/**
*
* @author user
*/
public class JobListener implements ServletContextListener {
//private static Log logger = LogFactory.getLog(JobListener.class);
private SimpleScheduler simple= new SimpleScheduler();
public void contextDestroyed(ServletContextEvent event) {
// TODO Auto-generated method stub
try {
simple.shutdownScheduler();
} catch (SchedulerException e) {
// TODO Auto-generated catch block
e.printStackTrace();
}
}
public void contextInitialized(ServletContextEvent event) {
// MailDeamon.begin();

simple.startScheduler();
}
}

到这里我们就可以使用这个任务调度完成我们想要实现的发送邮件的功能了。

=============================================================================================================
在没有用Quartz之前我们是采用线程操作来实现的

/*
* To change this template, choose Tools | Templates
* and open the template in the editor.
*/
package songjie.service;

import songjie.entity.Message;
import songjie.process.Preference;
import songjie.mail.Mail;
import songjie.mail.MailSendException;
import songjie.mail.MailSender;
import java.util.Date;
import java.util.List;
import java.util.logging.Level;
import org.apache.log4j.Logger;

/**
*
* @author Administrator
*/
public class MailDeamon extends Thread {

public MailDeamon(Runnable target) {
super(target);
}
private static Long fequence = 60000*10l;
private static MailDeamon deamon = new MailDeamon(new MailRun());
private static Logger logger = Logger.getLogger(MailDeamon.class);

public static Long getFequence() {
return fequence;
}

public static void begin() {
deamon.start();
}

public static void setFequence(Long fequence) {
MailDeamon.fequence = fequence;
}

static class MailRun implements Runnable {

public void run() {
logger.debug("Deamon[" + deamon.hashCode() + "] begin at " + (new Date()));
while (true) {
try {
doit();
Thread.sleep(fequence);
} catch (InterruptedException ex) {
logger.error(ex);
}
}
}

private void doit() {
logger.debug("Run deamon at " + new Date());
List<Message> messages = Message.findNew();
for (Message message : messages) {
try {
System.out.println(message.getMessage() + "=" + message.getUserAccount());
logger.debug("MailJob starting...");
Mail mail = new Mail();
mail.setFromAddr(Preference.getString("fromAddress"));
mail.setMailserver(Preference.getString("mailServer"));
mail.setMessage(message.getMessage());
mail.setPassword(Preference.getString("mailPassword"));
mail.setSubject(message.getTitle());
mail.setToAddr(message.getUserAccount()); //Use "," when have many emails;
mail.setUser(Preference.getString("mailUser"));
logger.debug("mail sender starting...");
MailSender sender = new MailSender();
logger.debug("preparing send mail");
sender.sendMail(mail);
logger.debug("mail sent");
message.complete();
Thread.sleep(50l);
} catch (InterruptedException ex) {
java.util.logging.Logger.getLogger(MailDeamon.class.getName()).log(Level.SEVERE, null, ex);
} catch (MailSendException ex) {
java.util.logging.Logger.getLogger(MailDeamon.class.getName()).log(Level.SEVERE, null, ex);
}
message.complete();
}
}
}
}

=-====================================================================================================-=======

接下来我们还是来讨论一下Quartz,上面讲的使用Quartz是采用硬编码的方式来完成我们的任务调度的,其实Quartz还提供了一种配置文件形式(这样说可能不够专业,但有助于大家理解)来完成。

这时候我们将Scheduler中的硬编码去掉(就是上面的注释部分),然后往我们的工程中加入两个文件:

quartz.properties和quartz_jobs.xml
注意:这两个文件放在工程的位置是工程目录下(也就是跟log4j.properties文件放在一起),而不是WebRoot/WEB-INF下,记住一定要放在工程的src下,不然工程可能找不到这两个文件而报错。对于quartz_jobs.xml文件的名字我们一般不要去该,当然如果想改动的话可以在quartz.properties中改动如下:
org.quartz.plugin.jobInitializer.fileName = my_quartz_jobs.xml

将这两个文件的代码示例贴在这里供参考:
quartz.properties
-----------------
#===============================================================
#Configure Main Scheduler Properties
#===============================================================
org.quartz.scheduler.instanceName = QuartzScheduler
org.quartz.scheduler.instanceId = AUTO

#===============================================================
#Configure ThreadPool
#===============================================================
org.quartz.threadPool.threadCount = 2
org.quartz.threadPool.threadPriority = 5
org.quartz.threadPool.class = org.quartz.simpl.SimpleThreadPool

#===============================================================
#Configure JobStore
#===============================================================
org.quartz.jobStore.class = org.quartz.simpl.RAMJobStore

#===============================================================
#Configure Plugins
#===============================================================
org.quartz.plugin.jobInitializer.class = org.quartz.plugins.xml.JobInitializationPlugin

org.quartz.plugin.jobInitializer.overWriteExistingJobs = true
org.quartz.plugin.jobInitializer.failOnFileNotFound = true
org.quartz.plugin.jobInitializer.validating=false

quartz_jobs.xml
---------------
<?xml version="1.0" encoding="UTF-8"?>

<quartz>

<job>
<job-detail>
<name>sendMail</name>
<group>DEFAULT</group>
<description>
send mail...
</description>
<job-class>
songjie.service.MailJob
</job-class>
<volatility>false</volatility>
<durability>false</durability>
<recover>false</recover>
</job-detail>
<!-- 这是个简单的trigger
<trigger>
<simple>
<name>sendTrigger</name>
<group>DEFAULT</group>
<job-name>sendMail</job-name>
<job-group>DEFAULT</job-group>
<start-time>2008-08-29T16:10:00</start-time>
repeat indefinitely every 10 Minutes
<repeat-count>-1</repeat-count>
<repeat-interval>600000</repeat-interval>
</simple>
</trigger>
-->
<trigger> //这是个cron的trigger,更方便我们的使用
<cron>
<name>sendTrigger</name>
<group>DEFAULT</group>
<job-name>sendMail</job-name>
<job-group>DEFAULT</job-group>
<!-- every 10 Minutes -->
<cron-expression>0 0/10 * * * ?</cron-expression>
<!-- Fire 7:30am Monday through Friday
<cron-expression>0 30 7 ? * MON-FRI</cron-expression>
-->
</cron>
</trigger>
</job>
</quartz>

==================================================================================
对于cron trigger的使用我们有必要知道下面的一些知识来完成对<cron-expression>的配置:

表 5.1. Quartz Cron 表达式支持到七个域
名称 是否必须 允许值 特殊字符
秒 是 0-59 , - * /
分 是 0-59 , - * /
时 是 0-23 , - * /
日 是 1-31 , - * ? / L W C
月 是 1-12 或 JAN-DEC , - * /
周 是 1-7 或 SUN-SAT , - * ? / L C #
年 否 空 或 1970-2099 , - * /

月份和星期的名称是不区分大小写的。FRI 和 fri 是一样的。

域之间有空格分隔,这和 UNIX cron 一样。无可争辩的,我们能写的最简单的表达式看起来就是这个了:

* * * ? * *

这个表达会每秒钟(每分种的、每小时的、每天的)激发一个部署的 job。

·理解特殊字符

同 UNIX cron 一样,Quartz cron 表达式支持用特殊字符来创建更为复杂的执行计划。然而,Quartz 在特殊字符的支持上比标准 UNIX cron 表达式更丰富了。

* 星号

使用星号(*) 指示着你想在这个域上包含所有合法的值。例如,在月份域上使用星号意味着每个月都会触发这个 trigger。

表达式样例:

0 * 17 * * ?

意义:每天从下午5点到下午5:59中的每分钟激发一次 trigger。它停在下午 5:59 是因为值 17 在小时域上,在下午 6 点时,小时变为 18 了,也就不再理会这个 trigger,直到下一天的下午5点。

在你希望 trigger 在该域的所有有效值上被激发时使用 * 字符。

? 问号

? 号只能用在日和周域上,但是不能在这两个域上同时使用。你可以认为 ? 字符是 "我并不关心在该域上是什么值。" 这不同于星号,星号是指示着该域上的每一个值。? 是说不为该域指定值。

不能同时这两个域上指定值的理由是难以解释甚至是难以理解的。基本上,假定同时指定值的话,意义就会变得含混不清了:考虑一下,如果一个表达式在日域上有值11,同时在周域上指定了 WED。那么是要 trigger 仅在每个月的11号,且正好又是星期三那天被激发?还是在每个星期三的11号被激发呢?要去除这种不明确性的办法就是不能同时在这两个域上指定值。

只要记住,假如你为这两域的其中一个指定了值,那就必须在另一个字值上放一个 ?。

表达式样例:

0 10,44 14 ? 3 WEB

意义:在三月中的每个星期三的下午 2:10 和 下午 2:44 被触发。

, 逗号

逗号 (,) 是用来在给某个域上指定一个值列表的。例如,使用值 0,15,30,45 在秒域上意味着每15秒触发一个 trigger。

表达式样例:

0 0,15,30,45 * * * ?

意义:每刻钟触发一次 trigger。

/ 斜杠

斜杠 (/) 是用于时间表的递增的。我们刚刚用了逗号来表示每15分钟的递增,但是我们也能写成这样 0/15。

表达式样例:

0/15 0/30 * * * ?

意义:在整点和半点时每15秒触发 trigger。

- 中划线

中划线 (-) 用于指定一个范围。例如,在小时域上的 3-8 意味着 "3,4,5,6,7 和 8 点。" 域的值不允许回卷,所以像 50-10 这样的值是不允许的。

表达式样例:

0 45 3-8 ? * *

意义:在上午的3点至上午的8点的45分时触发 trigger。

L 字母

L 说明了某域上允许的最后一个值。它仅被日和周域支持。当用在日域上,表示的是在月域上指定的月份的最后一天。例如,当月域上指定了 JAN 时,在日域上的 L 会促使 trigger 在1月31号被触发。假如月域上是 SEP,那么 L 会预示着在9月30号触发。换句话说,就是不管指定了哪个月,都是在相应月份的时最后一天触发 trigger。

表达式 0 0 8 L * ? 意义是在每个月最后一天的上午 8:00 触发 trigger。在月域上的 * 说明是 "每个月"。

当 L 字母用于周域上,指示着周的最后一天,就是星期六 (或者数字7)。所以如果你需要在每个月的最后一个星期六下午的 11:59 触发 trigger,你可以用这样的表达式 0 59 23 ? * L。

当使用于周域上,你可以用一个数字与 L 连起来表示月份的最后一个星期 X。例如,表达式 0 0 12 ? * 2L 说的是在每个月的最后一个星期一触发 trigger。

不要让范围和列表值与 L 连用

虽然你能用星期数(1-7)与 L 连用,但是不允许你用一个范围值和列表值与 L 连用。这会产生不可预知的结果。

W 字母

W 字符代表着平日 (Mon-Fri),并且仅能用于日域中。它用来指定离指定日的最近的一个平日。大部分的商业处理都是基于工作周的,所以 W 字符可能是非常重要的。例如,日域中的 15W 意味着 "离该月15号的最近一个平日。" 假如15号是星期六,那么 trigger 会在14号(星期四)触发,因为距15号最近的是星期一,这个例子中也会是17号(译者Unmi注:不会在17号触发的,如果是15W,可能会是在14号(15号是星期六)或者15号(15号是星期天)触发,也就是只能出现在邻近的一天,如果15号当天为平日直接就会当日执行)。W 只能用在指定的日域为单天,不能是范围或列表值。

# 井号

# 字符仅能用于周域中。它用于指定月份中的第几周的哪一天。例如,如果你指定周域的值为 6#3,它意思是某月的第三个周五 (6=星期五,#3意味着月份中的第三周)。另一个例子 2#1 意思是某月的第一个星期一 (2=星期一,#1意味着月份中的第一周)。注意,假如你指定 #5,然而月份中没有第 5 周,那么该月不会触发。

-------------------------对于简单trigger-----------------------

<start-time>2008-08-29T16:10:00</start-time> 这里的start-time中间的T要加上,不然会出错,至于为什么可以看我最后附带的连接去查相关资料。

quart_jobx.xml 中时间格式的问题,写成 2008-06-20 7:23:00 PM 的话 JobSchedulingDataProcessor.parseDate(value) 没办法解析

在 quarts_jobs.xml 中 <start-time> 的格式是:

<start-time>2008-06-23T21:23:00</start-time>

T隔开日期和时间,默认时区

或者:
<start-time>2008-06-23T21:23:00+08:00</start-time>
+08:00 表示东八区

我觉得这是 Quartz 的一个 Bug,其实 Quartz 在解析时间时准备了两个 Pattern 的,分别是:
yyyy-MM-dd'T'hh:mm:ss
yyyy-MM-dd hh:mm:ss a

但是在 JobSchedulingDataProcessor.parseDate(value) 方法中只会以第一个 Pattern 解析时间,并不会尝试使用第二个 Pattern 去解析时间,第二个 Pattern 是可以认识 2008-06-20 7:23:00 PM 的。

所以为了规避这个问题,还是应该写成 yyyy-MM-dd'T'hh:mm:ss 格式。

经过以上配置我们完全可以实现我们的任务调度任务,当然这是简单的任务调度,如果想要深入学习请到 http://unmi.blogjava.net/
去查看相关资料。

=====================================以下是个人以后学习中可能会涉及到的知识点,摘录下来自己看得=========================
你可以在一个quartz_jobs.xml中指定多个Job
<?xml version='1.0' encoding='utf-8'?>

<quartz>
<job>
<job-detail>
<name>ScanDirectory1</name>
<group>DEFAULT</group>
<description>
A job that scans a directory for files
</description>
<job-class>
org.cavaness.quartzbook.chapter3.ScanDirectoryJob
</job-class>
<volatility>false</volatility>
<durability>false</durability>
<recover>false</recover>

<job-data-map allows-transient-data="true">
<entry>
<key>SCAN_DIR</key>
<value>c:/quartz-book/input1</value>
</entry>
</job-data-map>
</job-detail>

<trigger>
<simple>
<name>scanTrigger1</name>
<group>DEFAULT</group>
<job-name>ScanDirectory1</job-name>
<job-group>DEFAULT</job-group>
<start-time>2005-07-19 8:31:00 PM</start-time>
<!-- repeat indefinitely every 10 seconds -->
<repeat-count>-1</repeat-count>
<repeat-interval>10000</repeat-interval>
</simple>
</trigger>
</job>

<job>
<job-detail>
<name>ScanDirectory2</name>
<group>DEFAULT</group>
<description>
A job that scans a directory for files
</description>
<job-class>
org.cavaness.quartzbook.chapter3.ScanDirectoryJob
</job-class>
<volatility>false</volatility>
<durability>false</durability>
<recover>false</recover>

<job-data-map allows-transient-data="true">
<entry>
<key>SCAN_DIR</key>
<value>c:/quartz-book/input2</value>
</entry>
</job-data-map>
</job-detail>

<trigger>
<simple>
<name>scanTrigger2</name>
<group>DEFAULT</group>
<job-name>ScanDirectory2</job-name>
<job-group>DEFAULT</job-group>
<start-time>2005-06-10 6:10:00 PM</start-time>
<!-- repeat indefinitely every 15 seconds -->
<repeat-count>-1</repeat-count>
<repeat-interval>15000</repeat-interval>
</simple>
</trigger>
</job>
</quartz>
内容来自用户分享和网络整理,不保证内容的准确性,如有侵权内容,可联系管理员处理 点击这里给我发消息
标签: