1 概述
Quartz是OpenSymphony开源组织在Job
scheduling领域又一个开源项目,它可以与J2EE与J2SE应用程序相结合也可以单独使用。Quartz可以用来创建简单或为运行十个,百个,甚至是好几万个Jobs这样复杂的日程序表。Jobs可以做成标准的Java组件或
EJBs。Quartz的最新版本为Quartz 1.6.2。
2 How to use
Job接口:自己写的“定时程序”实现此接口的void
execute(JobExecutionContext
arg0)方法,Job还有一类为有状态的StatefulJob接口,如果我们需要在上一个作业执行完后
,根据其执行结果再进行下次作业的执行,则需要实现此接口。
Trigger抽象类:调度类(Scheduler)在时间到时调用此类,再由trigger类调用指定的定时程序。
Quertz中提供了两类触发器为:SimpleTrigger和CronTrigger。前者用于实现比较简单的定时功能,例如几点开始,几点结束,隔多长时间执行,共执行多少次等,后者提供了使用表达式来描述定时功能,因此适用于比较复杂的定时描述,例如每个月的最后一个周五,每周的周四等。
JobDetail类:具体某个定时程序的详细描述,包括Name、Group、JobDataMap等。
JobExecutionContext类:定时程序执行的run-time的上下文环境,用于得到当前执行的Job
的名字,配置的参数等。
JobDataMap类:用于描述一个作业的参数,参数可以为任何基本类型例如String、float等,也可为某个对象的引用。
JobListener、TriggerListener接口:用于监听触发器状态和作业扫行状态,在特写状态执行相应操作。
JobStore类:在哪里执行定进程序,可选的有在内存中,在数据库中。
1. 实例一:简单的定时程序:
package quartz;
import java.util.Date;
import org.quartz.JobDetail;
import org.quartz.Scheduler;
import org.quartz.SimpleTrigger;
import org.quartz.impl.StdSchedulerFactory;
public class QuartzTest {
public static void
main(String[] args) {
QuartzTest test = new QuartzTest();
try {
test.startSchedule();
} catch (Exception e) {
e.printStackTrace();
}
}
public void startSchedule()
throws Exception {
Scheduler scheduler = StdSchedulerFactory.getDefaultScheduler();
JobDetail jobDetail = new JobDetail("testJob",
Scheduler.DEFAULT_GROUP,TestJob.class);
jobDetail.getJobDataMap().put("name", "testJob");
// 结束时间
long end = System.currentTimeMillis() + 9000L;
// 执行10次,每3秒执行一次,到9秒后结束
SimpleTrigger trigger = new SimpleTrigger("test", null, new Date(),new
Date(end), 10, 3000L);
scheduler.scheduleJob(jobDetail, trigger);
scheduler.start();
}
}
package quartz;
import org.quartz.Job;
import org.quartz.JobExecutionContext;
import org.quartz.JobExecutionException;
public class TestJob implements Job {
public void
execute(JobExecutionContext context)
throws JobExecutionException {
// 这里实现业务逻辑
String name = context.getJobDetail().getJobDataMap().getString("name");
System.out.println("job executing..." + name);
}
}
执行上面这个程序基本实现了一个简单的定时调用。但问题是现在这个类只能应用在application中,在web环境里执行还需要添加一些配置,例如添加servlet,添加配置文件quartz.properties和quartz-job.xml(在XML文件里以配置方式定义triiger,定时描述等)。
2. 实例二:Web应用中的使用之通过Servlet初始化Quartz:
在web.xml中添加QuartzInitializerServlet,Quartz为能够在web应用中使用,提供了一个QuartzInitializerServlet和一个QuartzInitializerListener,用于在加载web应用时,对quartz进行初始化。
运行这个程序需要几个第三方库的支持,分别为commons-digester-1.7.jar和commons-beanutils-core.jar,需要将这两个包导入Web应用。
1)
修改Web.xml文件,添加Quartz初始化Servlet,在<web-app>节点下添加如下:
<servlet>
<servlet-name>QuartzInitializer</servlet-name>
<servlet-class>org.quartz.ee.servlet.QuartzInitializerServlet</servlet-class>
<init-param>
<param-name>shutdown-on-unload</param-name>
<param-value>true</param-value>
</init-param>
<init-param>
<param-name>config-file</param-name>
<param-value>quartz.properties</param-value>
</init-param>
<load-on-startup>2</load-on-startup>
</servlet>
<servlet-mapping>
<servlet-name>QuartzInitializer</servlet-name>
<url-pattern>/QuartzInitializer</url-pattern>
</servlet-mapping>
2) 在Web应用的JavaSource下新建一个quartz.properties文件内容如下:
#============================================================================
# Configure Main Scheduler Properties
#============================================================================
org.quartz.scheduler.instanceName =
org.quartz.scheduler.instanceId = AUTO
#============================================================================
# Configure ThreadPool
#============================================================================
org.quartz.threadPool.class =
org.quartz.simpl.SimpleThreadPool
org.quartz.threadPool.threadCount = 3
org.quartz.threadPool.threadPriority = 5
#============================================================================
# Configure Plugins
#============================================================================
org.quartz.plugin.triggHistory.class =
org.quartz.plugins.history.LoggingJobHistoryPlugin
org.quartz.plugin.jobInitializer.class =
org.quartz.plugins.xml.JobInitializationPlugin
org.quartz.plugin.jobInitializer.fileName = quartz-config.xml
org.quartz.plugin.jobInitializer.overWriteExistingJobs = true
org.quartz.plugin.jobInitializer.failOnFileNotFound = true
org.quartz.plugin.jobInitializer.scanInterval = 10
3) 在Web应用的JavaSource下新建一个quartz-config.xml文件内容如下:
<?xml version='1.0' encoding='utf-8'?>
<quartz>
<job>
<job-detail>
<name>test</name>
<group>DEFAULT</group>
<description>testJobhere</description>
<job-class>quartz.TestJob</job-class>
<job-data-map allows-transient-data="true">
<entry>
<key>name</key>
<value>test</value>
</entry>
</job-data-map>
</job-detail>
<trigger>
<cron>
<name>testCron</name>
<group>DEFAULT</group>
<job-name>test</job-name>
<job-group>DEFALUT</job-group>
<cron-expression>0/3 * * * * ?</cron-expression>
</cron>
</trigger>
</job>
</quartz>
4)
在Web应用的JavaSource的包quartz.TestJob里面新建一个TestJob.java,内容如下:
package quartz;
import org.quartz.Job;
import org.quartz.JobExecutionContext;
import org.quartz.JobExecutionException;
public class TestJob implements Job {
public void
execute(JobExecutionContext context)
throws JobExecutionException {
String name = context.getJobDetail().getJobDataMap().getString("name");
System.out.println("job executing..." + name);
}
}
5) 运行服务器,控制台会打出如下内容:
job executing...test
测试成功!
3.
实例三:Web应用中的使用之通过Servlet初始化Quartz
1) 配置tomcat数据库连接池:jdbc/myds
2)
修改Web.xml文件,添加Quartz初始化Servlet,在<web-app>节点下添加如下:
<servlet>
<servlet-name>context</servlet-name>
<display-name>context</display-name>
<description>Spring
Application Context</description>
<servlet-class>org.springframework.web.context.ContextLoaderServlet</servlet-class>
<init-param>
<param-name>contextConfigLocation</param-name>
<param-value>/WEB-INF/applicationContext.xml</param-value>
<description></description>
</init-param>
<load-on-startup>2</load-on-startup>
</servlet>
<servlet-mapping>
<servlet-name>context</servlet-name>
<url-pattern>/context</url-pattern>
</servlet-mapping>
3) 在Web应用的JavaSource下新建一个在applicationContext.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="exampleJob"
class="org.springframework.scheduling.quartz.JobDetailBean">
<property name="jobClass">
<value>quartz.SysScheduleManagerImpl</value>
</property>
<property
name="jobDataAsMap">
<map>
<entry
key="targetObject" value="exampleBusinessObject"/>
<entry
key="targetMethod" value="task"/>
</map>
</property>
</bean>
<bean
id="exampleBusinessObject" class="quartz.ExampleBusinessObject"/>
<bean id="cronTrigger"
class="org.springframework.scheduling.quartz.CronTriggerBean">
<property name="jobDetail" ref="exampleJob" />
<property name="cronExpression" value="0/10 * * * * ? *" />
</bean>
<bean
class="org.springframework.scheduling.quartz.SchedulerFactoryBean">
<property name="triggers">
<list>
<ref bean="cronTrigger"
/>
</list>
</property>
<!-- <property
name="applicationContextSchedulerContextKey"><value>applicationContext</value>
</property>-->
<property name="schedulerContextAsMap">
<map>
<entry key="exampleBusinessObject">
<ref bean="exampleBusinessObject" />
</entry>
</map>
</property>
</bean>
</beans>
4) 在Web应用的JavaSource下新建一个quartz.properties文件内容如下:
#============================================================================
# Configure Main Scheduler Properties
#============================================================================
org.quartz.scheduler.instanceName = MyClusteredScheduler
org.quartz.scheduler.instanceId = AUTO
#============================================================================
# Configure ThreadPool
#============================================================================
org.quartz.threadPool.class =
org.quartz.simpl.SimpleThreadPool
#默认配置25个调度线程。
org.quartz.threadPool.threadCount = 25
org.quartz.threadPool.threadPriority = 5
#============================================================================
# Configure JobStore
#============================================================================
org.quartz.jobStore.misfireThreshold = 60000
org.quartz.jobStore.class =
org.quartz.impl.jdbcjobstore.JobStoreTX
org.quartz.jobStore.driverDelegateClass =
org.quartz.impl.jdbcjobstore.oracle.OracleDelegate
org.quartz.jobStore.useProperties = false
org.quartz.jobStore.dataSource = myDS
org.quartz.jobStore.tablePrefix = QRTZ_
org.quartz.jobStore.isClustered = true
org.quartz.jobStore.clusterCheckinInterval = 20000
org.quartz.dataSource.myDS.jndiURL=java:comp/env/jdbc/myds
5) 在Web应用的JavaSource
包quartz里面新建SysScheduleManagerImpl.java文件,内容如下:
package quartz;
import java.lang.reflect.Method;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.quartz.JobExecutionContext;
import org.quartz.JobExecutionException;
import org.springframework.context.ApplicationContext;
import org.springframework.scheduling.quartz.QuartzJobBean;
public class SysScheduleManagerImpl extends QuartzJobBean {
protected final Log logger =
LogFactory.getLog(getClass());
private String
targetObject;
private String
targetMethod;
protected void
executeInternal(JobExecutionContext context)
throws JobExecutionException {
try {
ApplicationContext ctx
=(ApplicationContext)context.getScheduler().getContext().get("applicationContext");
Object otargetObject =
context.getScheduler().getContext().get(targetObject);
Method m = null;
try {
m = otargetObject.getClass().getMethod(targetMethod,new Class[] {});
m.invoke(otargetObject, new Object[] {});
} catch (SecurityException e) {
// TODO Auto-generated catch block
e.printStackTrace();
} catch (NoSuchMethodException e) {
// TODO Auto-generated catch block
e.printStackTrace();
}
} catch (Exception e) {
throw new JobExecutionException(e);
} finally {
logger.debug("end");
}
}
public void
setTargetObject(String targetObject) {
this.targetObject = targetObject;
}
public void
setTargetMethod(String targetMethod) {
this.targetMethod = targetMethod;
}
}
6) 在Web应用的JavaSource
包quartz里面新建SysScheduleManagerImpl.java文件,内容如下:
Package quartz;
import java.util.Date;
public class ExampleBusinessObject{
public boolean task() {
System.out.println(new
Date()+"已经执行了!!");
boolean result = false;
// 这里实现业务逻辑
return result;
}
}
7) 启动服务器,控制台打出如下内容:
Fri Nov 07 17:52:10 CST 2008已经执行了!!
测试成功!!
http://blog.sina.com.cn/s/blog_5d7d88fd0100bdaj.html