在J2EE环境中使用Quartz企业级计划调度器

Quartz 是来自OpenSymphony的一个开发源代码的企业级工作计划调度器。要了解详情以及下载Quartz请访问http://www.quartzscheduler.org/quartz/。你可以在你的J2EE应用如EJB中使用Quartz来调度工作计划。本文将会介绍在你的J2EE应用中如何使用Quartz来安排工作计划。文章中将会使用Oracle应用服务器10g J2EE容器（OC4J 9.0.4）作为J2EE容器的例子。

Quartz 支持多种类型的工作和触发器，但其中最流行的就是克龙（时间单位：百万年）级别的触发器。要了解Quartz 工作计划调度的兼容性，请参考Quartz 的文档： http://www.quartzscheduler.org/quartz/docs.html。另外Dejan Bosanac 也写了一篇非常好的文章Job Scheduling in Java 可能会对你有所帮助。
在我们进入细节论题之前，先假设你有一个业务案例，需要让一项工作每30分钟运行一次。在本文中我们将会讨论如何使用Quartz的克龙级触发器功能来做到这一点。

1          定义你的工作为EJB方法
在J2EE应用中使用计划任务的第一步就是创建EJB并将业务逻辑封装为EJB的方法。举个例子，我创建了一个名称为TestEJB的无状态的EJB，其中有一个方法叫做yourMethod我需要定义为计划任务。为了更清楚一点，下面我列举了我的EJB的代码片段和EJB部署描述：
package howto.quartz.ejb;
import java.rmi.*;
import javax.ejb.*;
public class TestEJBBean implements SessionBean {
public TestEJBBean() {
}
// EJB life cycle methods are omitted for brevity
........
public void yourMethod() throws RemoteException {
System.out.println("TestEJB Job");
}
}

2          从一个通常的Servlet使用Quartz API来定制你的计划任务
Quartz 使用自己的线程池，这些线程并不是容器线程。Servlet API 允许用户线程，并且因为你需要创建一个Servlet并使用Quartz API 来排定计划任务。Quartz 提供了QuartzInitializerServlet 作为其工作计划服务的入口。在本例中我们需要将TestEJB的yourMethod方法提交为工作任务。因此我们将创建一个GenericServlet 名称为howto.quartz.servlet.QuartzServlet，并在init() 方法中将EJB 方法提交为一个克龙触发器。在本例中，我将克龙表达式设置为初始化参数而不是采用在Servlet中硬编码的方式。下面就是Servlet的代码:
public class QuartzServlet extends GenericServlet {
public void init(ServletConfig config) throws ServletException {
super.init(config);
System.out.println("Scheduling Job ..");
JobDetail jd = new JobDetail("Test Quartz","My Test Job",EJBInvokerJob.class);
jd.getJobDataMap().put("ejb", "java:comp/env/ejb/TestEJB");
jd.getJobDataMap().put("method", "yourMethod");
Object[] jdArgs = new Object[0];
jd.getJobDataMap().put("args", jdArgs);
CronTrigger cronTrigger = new CronTrigger("Test Quartz", "Test Quartz");
try {
String cronExpr = null;
// Get the cron Expression as an Init parameter
cronExpr = getInitParameter("cronExpr");
System.out.println(cronExpr);
cronTrigger.setCronExpression(cronExpr);
Scheduler sched = StdSchedulerFactory.getDefaultScheduler();
sched.scheduleJob(jd, cronTrigger);
System.out.println("Job scheduled now ..");
} catch (Exception e) {
e.printStackTrace();
}
}
public void service(ServletRequest arg0, ServletResponse arg1)
throws ServletException, IOException {
}
public String getServletInfo() {
return null;
}
}

3         自动启动Servlets
我们希望在应用被部署或容器启动时就提交任务。我们必须在web模块并重启动的时候初始化QuartzInitializerServlet 和 howto.quartz.servlet.QuartzServlet。为了达到这个目的，我们需要在Web应用的部署描述符（web.xml）中增加以下内容：
<servlet>
<servlet-name>QuartzInitializer</servlet-name>
<display-name>Quartz Initializer Servlet</display-name>
<servlet-class>org.quartz.ee.servlet.QuartzInitializerServlet</servlet-class>
<load-on-startup>1</load-on-startup>
</servlet>
<servlet>
<servlet-name>QuartzServlet</servlet-name>
<display-name>Quartz Servlet</display-name>
<servlet-class>howto.quartz.servlet.QuartzServlet</servlet-class>
<init-param><param-name>cronExpr</param-name> <param-value>0 0/30 * * * ?</param-value></init-param>
<load-on-startup>2</load-on-startup>
</servlet>
Servlet 需要访问能TestEJB，因此我们需要在web.xml中创建ejb-ref ，如下所示：
<ejb-ref>
<ejb-ref-name>ejb/TestEJB</ejb-ref-name>
<ejb-ref-type>Session</ejb-ref-type>
<home>howto.quartz.ejb.TestEJBHome</home>
<remote>howto.quartz.ejb.TestEJB</remote>
</ejb-ref>

4        组装/打包应用
Web模块需要访问Quartz API，因此我们必须将Quartz 类库打包到WAR模块中。我们需要将quartz.jar, commons-logging.jar, commons-pool-1.1.jar等放在WAR模块的WEB-INF/lib目录下。你的环境中需要的quartz 配置必须在quartz.properties文件中声明，该文件必须放在WAR模块的WEB-INF/classes 目录下。
包括了TestEJB的ejb-jar和包括了Quartz类库和QuartzServlet的WAR需要打包为EAR并部署到J2EE容器中，在我们的例子中使用的是OC4J。

5         配置你的服务器打开用户线程功能
配置你的J2EE容器来打开用户线程功能，你的应用作为Quartz计划调度器创建的线程被看作是用户线程。以OC4J为例，你需要像下面这样启动OC4J来允许用户线程：
java -jar oc4j.jar -userThreads

6         发布你的J2EE应用
然后在你的J2EE容器中发布你的应用。确信你的应用已经设置为随着应用服务器一起自动启动。以OC4J为例，你必须确信设置了应用的web模块的auto-start属性和load-on-startup属性为true。确信你在服务器配置文件中有以下内容：
server.xml:
<application name="quartz" path="../applications/quartz-app.ear" auto-start="true" />
http-web-site.xml:
<web-app application="quartz" name="quartz-web" load-on-startup="true" root="/quartz" />

7          现在你可以开始了
你的 EJB 方法现在已经被配置为每30分钟执行一次的计划任务了。

8        参考材料
Quartz 文档: http://www.quartzscheduler.org/quartz
Dejan Bosanac 撰写的Job Scheduling in Java
--------------------------------------------------------------------------------
关于作者
Debu Panda (debabrata.panda@oracle.com)
Blog: http://radio.weblogs.com/0135826
Debu Panda 是Oracle OC4J应用服务器的一名架构师。