在web應(yīng)用中,大多數(shù)任務(wù)是以一種"防止用戶長時間等待"的方式完成的。在Google搜索這樣的例子中,減少等待時間對用戶體驗來說至關(guān)重要。異步任務(wù)的一種解決方案是在用戶提交后生成一個線程(來處理異步任務(wù)),但這也不能解決那些需要以一定時間間隔重復(fù)運行任務(wù)、或在每天的指定時間運行任務(wù)的情況。
讓我們從一個數(shù)據(jù)庫報表的例子來看看任務(wù)調(diào)度能如何幫助改善系統(tǒng)設(shè)計。報表可能是錯綜復(fù)雜的,這取決于用戶所需數(shù)據(jù)的種類,以及是否需要從一個或多個數(shù)據(jù)庫收集大量數(shù)據(jù)。用戶可能需要很長時間來運行這樣的"按需"報表。因此,我們向這個報表示例中添加任務(wù)調(diào)度機制,以便用戶可以安排在任何他們需要的時間生成報表,并以PDF或其他格式在email中發(fā)送。用戶可以讓報表在每天的凌晨2:22,系統(tǒng)正處于低負荷時運行;也可以選擇只在特定時間運行一次。通過在報表應(yīng)用中加入任務(wù)調(diào)度,我們可以為產(chǎn)品添加一項有用的功能,并改善用戶體驗。
幸運的是,有一個強大的開源解決方案可以讓我們以標(biāo)準(zhǔn)的方式在web應(yīng)用(或任何Java應(yīng)用)中實施任務(wù)調(diào)度。以下示例展示了在web應(yīng)用中,如何使用Quartz來創(chuàng)建一個任務(wù)調(diào)度框架。這個示例還使用了Struts Action framework 插件,以便在web應(yīng)用啟動時初始化任務(wù)調(diào)度機制。Struts是最常見的MVC框架,為大多數(shù)開發(fā)人員所熟悉。當(dāng)然除此之外還有許多框架可以協(xié)助在web應(yīng)用中實現(xiàn)MVC模式。
啟動時初始化任務(wù)調(diào)度器 我們首先要做的是建立一個Struts插件,讓它在容器啟動時創(chuàng)建我們的任務(wù)調(diào)度器。在以下例子中,我們選擇Tomcat作為web應(yīng)用容器,不過這些示例在其他容器中也應(yīng)當(dāng)可以運行。我們要創(chuàng)建一個Struts插件類,并在struts-config.xml中加入幾行代碼以使之可以工作。
這個插件有兩個可配置的初始化參數(shù):startOnLoad指定是否要在容器啟動時立即啟動任務(wù)調(diào)度器,而 startupDelay指定啟動任務(wù)調(diào)度器之前的等待時間。啟動延時很有用,因為我們可能需要首先執(zhí)行一些更重要的初始化步驟。此外還可以使用listener機制,以更復(fù)雜的方式來通知SchedulerPlugIn何時啟動Quartz Scheduler。
??<plug-in className="SchedulerPlugIn">
???? <set-property property="startOnLoad" value="false" />
???? <set-property property="startupDelay" value="0" />
??</plug-in>
我們要創(chuàng)建的是一個實現(xiàn)Struts插件接口org.apache.struts.action.PlugIn的單子類SchedulerPlugIn。Struts會按照配置文件中出現(xiàn)的順序初始化各個插件。要特別注意的是init()方法中的代碼,在此我們初始化了所需的Quartz對象,并得到Scheduler。我們的任務(wù)信息就要提交到此org.quartz.Scheduler對象,后者將在隨后討論。Scheduler對象由Quartz servlet根據(jù)其配置初始化,就像Struts初始化它的ActionServlet類一樣。讓我們來看init()方法:
public void init(ActionServlet actionServlet,
???????????????? ModuleConfig moduleConfig) {
??System.out.println("Initializing Scheduler PlugIn for Jobs!");
??// Retrieve the ServletContext
// 獲取ServletContext
??ServletContext ctx = actionServlet.getServletContext();
??// The Quartz Scheduler
??// Quartz Scheduler對象
??Scheduler scheduler = null;
??// Retrieve the factory from the ServletContext.
??// It will be put there by the Quartz Servlet
??// 從ServletContext取得由Quartz Servlet放置在此的factory對象。
??StdSchedulerFactory factory =??(StdSchedulerFactory)
??????ctx.getAttribute(QuartzInitializerServlet.QUARTZ_FACTORY_KEY);
????
??try{
????????// Retrieve the scheduler from the factory
????????// 從factory取得scheduler
????????scheduler = factory.getScheduler();
????????// Start the scheduler in case, it isn't started yet
????????// 如果scheduler尚未啟動,則啟動它
????????if (m_startOnLoad != null &&
????????????m_startOnLoad.equals(Boolean.TRUE.toString())){
????????????System.out.println("Scheduler Will start in " +
????????????m_startupDelayString + " milliseconds!");
????????????//wait the specified amount of time before
????????????// starting the process.
????????????// 在啟動之前等待指定長度的時間
????????????Thread delayedScheduler =
????????????????new Thread(new DelayedSchedulerStarted (
?????????????????????????????????? scheduler, m_startupDelay));
????????????//give the scheduler a name. All good code needs a name
????????????//給任務(wù)調(diào)度器命名。好的代碼總該有名字!
????????????delayedScheduler.setName("Delayed_Scheduler");
????????????//Start out scheduler
????????????//啟動任務(wù)調(diào)度器
????????????delayedScheduler.start();
????????}
??} catch (Exception e){
???? e.printStackTrace();
??}
????sm_scheduler = scheduler;
}
配置過程的第二步是在web.xml中加入用來初始化Quartz servlet(org.quartz.ee.servlet.QuartzInitializerServlet)的內(nèi)容,因為需要它將SchedulerFactory添加到ServletContext中,以便在我們的Struts插件中可以訪問。SchedulerFactory就是我們在Struts插件中獲得Scheduler對象的來源。除了struts-config.xml 和web.xml之外,還要在web應(yīng)用的classes目錄下放置一個quartz.properties文件。此文件的位置也可以在web.xml中作為QuartzInitializerServlet的啟動參數(shù)來指定。
??<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>
??<init-param>
????<param-name>shutdown-on-unload</param-name>
????<param-value>true</param-value>
??</init-param>
??<init-param>
????<param-name>start-scheduler-on-load</param-name>
????<param-value>false</param-value>
????</init-param>
</servlet>
這里其實完全可以不使用Struts和SchedulerPlugIn,但如果將來決定要以其它的任務(wù)調(diào)度框架替換Quartz的話,額外的抽象層就很有用了。長遠看來,讓一切保持松散耦合總會使工作變得容易些。如果你使用其它MVC框架,也可以用SchedulerPlugIn.init()方法中的代碼達到同樣的效果。此外,還可以用Servlet 2.3規(guī)范中的ServletContextListener來實現(xiàn)同樣的初始化過程。
此為止web應(yīng)用已配置完畢,我們可以創(chuàng)建一個.war文件并部署到服務(wù)器上,從控制臺觀察SchedulerPlugIn的輸出信息。然而在此之前,讓我們先看看如何向任務(wù)調(diào)度器提交一項任務(wù)。
我們可以從web應(yīng)用中的任何類訪問SchedulerPlugIn的唯一實例,并調(diào)度一些要執(zhí)行的工作。首先需要一個Trigger(觸發(fā)器)對象來告訴任務(wù)何時運行、每隔多久運行一次。Quartz支持多種觸發(fā)器,在這個例子中我們使用CronTrigger。
Trigger trigger = new CronTrigger("trigger1", "group1");
trigger.setCronExpression("0 0 15 ? * WED");
以上的觸發(fā)器會在每周三的下午3點執(zhí)行指定任務(wù)。現(xiàn)在我們只要創(chuàng)建一個JobDetail對象,并把它和上面的觸發(fā)器一起傳遞給SchedulerPlugIn的scheduleWork()方法。
????JobDetail jobDetail =
????????new JobDetail("Hello World Job",
??????????????????????"Hello World Group",
??????????????????????HelloWorld.class,
??????????????????????true, true, true);????
//Schedule The work
//調(diào)度這項任務(wù)
????SchedulerPlugIn.scheduleWork(scheduledJobDetail, trigger);
實際工作在何處? 至此我們已決定Trigger,可以開始調(diào)度工作了。看上去一切都已完成,但實際上我們只是調(diào)度了一項任務(wù),還有最重要的一步有待完成。注意HelloWorld.class作為參數(shù)傳遞給了JobDetail的構(gòu)造函數(shù)。這個類就是實際完成工作的地方。HelloWorld繼承了Quartz的Job類,并覆蓋了execute()方法。當(dāng)任務(wù)管理器決定運行這個任務(wù)時,execute()方法將被調(diào)用。來看代碼:
import org.quartz.JobDataMap;
import org.quartz.JobDetail;
import org.quartz.JobExecutionContext;
//extend the proper Quartz class
//繼承適當(dāng)?shù)腝uartz類
public class HelloWorld extends Job {
//override the execute method
//覆蓋execute方法
????public void execute(JobExecutionContext context) {
// Every job has it's own job detail
//每個Job都有獨立的JobDetail
????JobDetail jobDetail = context.getJobDetail();
// The name is defined in the job definition
//name在Job定義中指定
????String jobName = jobDetail.getName();
//Every job has a Job Data map for storing extra information
//每個Job都有一個Job Data map來存放額外的信息
????JobDataMap dataMap = jobDetail.getJobDataMap();
??????
?????? System.out.println("Hello World!!!");
?? }
}
出于測試的目的,你可能希望將觸發(fā)器的頻率調(diào)的高一點,以便觀察到HelloWorld的動作。畢竟,你不想一直等到凌晨2點才能確定調(diào)度的任務(wù)確實運行了。相反,你可能需要一個每隔10秒運行的觸發(fā)器:
Trigger trigger = new SimpleTrigger("trigger1", "group1");
trigger.setRepeatCount(SimpleTrigger.REPEAT_INDEFINITELY);
trigger.setRepeatInterval(10000L); // milliseconds毫秒
注意,這個觸發(fā)器沒有使用類cron的語法。Quartz有大量各類的選項和配置方法,可適用于任何任務(wù)調(diào)度的需要。
????????
其它計時方式的配置 Quartz提供了多種調(diào)度任務(wù)的方式。CronTrigger可能是最復(fù)雜的一種,不過還有其它的選擇。大多數(shù)觸發(fā)器可以由Quartz提供的TriggerUtils類創(chuàng)建。以下是一些常見的觸發(fā)器的例子。如諺語所言,條條大路通羅馬!
每天凌晨2:22觸發(fā)的觸發(fā)器
// 方法一:使用makeDailyTrigger
Trigger trigger = TriggerUtils.makeDailyTrigger(2, 22);
trigger.setName("trigger1");
trigger.setGroup("group1");
// 方法二:使用CronTrigger
Trigger trigger = new CronTrigger("trigger1", "group1");
trigger.setCronExpression("0 22 2 * * ?");
每5秒執(zhí)行一次的觸發(fā)器
/*??*
* 方法一:makeSecondlyTrigger
* 注意以下代碼將創(chuàng)建一個立即啟動的觸發(fā)器。要控制啟動時間,使用
* trigger.setStartTime(Date)方法。
*/
Trigger trigger = TriggerUtils.makeSecondlyTrigger(5);
trigger.setName("MyFiveSecondTrigger");
trigger.setGroup("MyTriggerGroup");
/*
*
* 方法二:設(shè)置SimpleTrigger的重復(fù)次數(shù)和間隔時間。
* 注意以下代碼將創(chuàng)建一個立即啟動的觸發(fā)器。要控制啟動時間,使用
* trigger.setStartTime(Date)方法。
*/
Trigger trigger = new SimpleTrigger("trigger1", "group1");
trigger.setRepeatCount(SimpleTrigger.REPEAT_INDEFINITELY);
trigger.setRepeatInterval(5000L); // milliseconds
按間隔時間運行任務(wù)Trigger trigger = new SimpleTrigger("trigger1", "group1");
// 24 hours * 60(minutes per hour) *
// 60(seconds per minute) * 1000(milliseconds per second)
// 24小時 * 60(分鐘每小時) * 60(秒每分鐘)* 1000(毫秒每秒鐘)
trigger.setRepeatInterval(24L * 60L * 60L * 1000L);
結(jié)論 在這個演示中,我們只接觸了Quartz框架的一些初級功能。記住,Java 5 和J2EE 5也有自己的任務(wù)調(diào)度機制,但是它們不像Quartz那樣靈活易用。Quartz是目前唯一的開源Java任務(wù)調(diào)度框架,它的確為開發(fā)者的錦囊中增加了很有用的內(nèi)容。你可從Open Symphony下載Quartz,并得到一份很好的教程和使用說明。??
posted on 2006-08-03 14:19
有貓相伴的日子 閱讀(1907)
評論(0) 編輯 收藏 所屬分類:
quartz