Struts2+Quartz2排程整合範例


Struts2並沒有附帶任何現成「Struts2-Quartz.jar」之類的外掛,駭客可能會使用標準的 Servlet 監聽將兩個框架連結在一起。請參閱它們的關係
Struts 2 <-- (Listener)--> Quartz <---> Scheduler task
在本教學中,我們將學習如何將Struts2和Quartz排程框架整合在一起。
使用的工具:
  1. Struts 2.1.4
  2. Quartz 2.1.5
  3. Tomcat 6/7
  4. MyEclipse 10

1. 排程作業

建立Quartz排程作業任務,並列印出一行。

File : SchedulerJob.java

package com.yiibai.quartz;

import org.quartz.Job;
import org.quartz.JobExecutionContext;
import org.quartz.JobExecutionException;

public class SchedulerJob implements Job {
	public void execute(JobExecutionContext context)
		throws JobExecutionException { System.out.println("Struts 2.1.4 + Quartz 2.2.2 - by www.tw511.com"); 
	
         SimpleDateFormat sdf = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
         System.out.println( " 已被安排執行於: " + sdf.format(new Date()));
} }

3. Servlet 監聽器

建立標準的servlet監聽器類用來做整合工作。它呼叫Quartz排程框架中的contextInitialized()方法。在Servlet容器初始化,contextInitialized()方法將自動執行。

File : QuartzSchedulerListener.java

package com.yiibai.listener;

import javax.servlet.ServletContextEvent;
import javax.servlet.ServletContextListener;
import org.quartz.CronScheduleBuilder;
import org.quartz.JobBuilder;
import org.quartz.JobDetail;
import org.quartz.Scheduler;
import org.quartz.SchedulerException;
import org.quartz.Trigger;
import org.quartz.TriggerBuilder;
import org.quartz.impl.StdSchedulerFactory;
import com.yiibai.quartz.SchedulerJob;

public class QuartzSchedulerListener implements ServletContextListener {

	public void contextDestroyed(ServletContextEvent arg0) {
		//
	}

	public void contextInitialized(ServletContextEvent arg0) {

		JobDetail job = JobBuilder.newJob(SchedulerJob.class)
			.withIdentity("anyJobName", "group1").build();

		try {

			Trigger trigger = TriggerBuilder
			  .newTrigger()
			  .withIdentity("anyTriggerName", "group1")
			  .withSchedule(
			     CronScheduleBuilder.cronSchedule("0/10 * * * * ?"))
			  .build();

			Scheduler scheduler = new StdSchedulerFactory().getScheduler();
			scheduler.start();
			scheduler.scheduleJob(job, trigger);

		} catch (SchedulerException e) {
			e.printStackTrace();
		}

	}
}

4. web.xml

把監聽器類 QuartzSchedulerListener.java 新增到 web.xml 檔案。

File : web.xml

<!DOCTYPE web-app PUBLIC
 "-//Sun Microsystems, Inc.//DTD Web Application 2.3//EN"
 "http://java.sun.com/dtd/web-app_2_3.dtd" >

<web-app>
	<display-name>Struts 2 Web Application</display-name>

	<filter>
	  <filter-name>struts2</filter-name>
	  <filter-class>
            org.apache.struts2.dispatcher.ng.filter.StrutsPrepareAndExecuteFilter
          </filter-class>
	</filter>

	<filter-mapping>
	  <filter-name>struts2</filter-name>
	  <url-pattern>/*</url-pattern>
	</filter-mapping>

	<listener>
	  <listener-class>
            com.yiibai.listener.QuartzSchedulerListener
          </listener-class>
	</listener>

</web-app>

CronTrigger組態格式:
格式: [秒] [分] [小時] [日] [月] [周] [年]

序號 說明 是否必填 允許填寫的值 允許的萬用字元
1 0-59 , - * /
2 0-59 , - * /
3 小時 0-23 , - * /
4 1-31 , - * ? / L W
5 1-12 or JAN-DEC , - * /
6 1-7 or SUN-SAT , - * ? / L #
7 empty 或 1970-2099 , - * /

萬用字元說明: * 表示所有值. 例如:在分的欄位上設定 "*",表示每一分鐘都會觸發。 ? 表示不指定值。使用的場景為不需要關心當前設定這個欄位的值。例如:要在每月的10號觸發一個操作,但不關心是週幾,所以需要周位置的那個欄位設定為"?" 具體設定為 0 0 0 10 * ? - 表示區間。例如 在小時上設定 "10-12",表示 10,11,12點都會觸發。 , 表示指定多個值,例如在周欄位上設定 "MON,WED,FRI" 表示周一,週三和週五觸發 / 用於遞增觸發。如在秒上面設定"5/15" 表示從5秒開始,每增15秒觸發(5,20,35,50)。 在月欄位上設定'1/3'所示每月1號開始,每隔三天觸發一次。 L 表示最後的意思。在日欄位設定上,表示當月的最後一天(依據當前月份,如果是二月還會依據是否是潤年[leap]), 在周欄位上表示星期六,相當於"7"或"SAT"。如果在"L"前加上數位,則表示該資料的最後一個。例如在周欄位上設定"6L"這樣的格式,則表示「本月最後一個星期五" W 表示離指定日期的最近那個工作日(週一至週五). 例如在日欄位上設定"15W",表示離每月15號最近的那個工作日觸發。如果15號正好是週六,則找最近的週五(14號)觸發, 如果15號是周未,則找最近的下週一(16號)觸發.如果15號正好在工作日(週一至週五),則就在該天觸發。如果指定格式為 "1W",它則表示每月1號往後最近的工作日觸發。如果1號正是周六,則將在3號下週一觸發。(註,"W"前只能設定具體的數位,不允許區間"-").

小提示

'L'和 'W'可以一組合使用。如果在日欄位上設定"LW",則表示在本月的最後一個工作日觸發(一般指發工資 )

# 序號(表示每月的第幾個週幾),例如在周欄位上設定"6#3"表示在每月的第三個週六.注意如果指定"#5",正好第五週沒有週六,則不會觸發該組態(用在母親節和父親節再合適不過了)

小提示

周欄位的設定,若使用英文字母是不區分大小寫的 MON 與mon相同.

常用範例:

0 0 12 * * ? 每天12點觸發
0 15 10 ? * * 每天10點15分觸發
0 15 10 * * ? 每天10點15分觸發
0 15 10 * * ? * 每天10點15分觸發
0 15 10 * * ? 2005 2005年每天10點15分觸發
0 * 14 * * ? 每天下午的 2點到2點59分每分觸發
0 0/5 14 * * ? 每天下午的 2點到2點59分(整點開始,每隔5分觸發)
0 0/5 14,18 * * ? 每天下午的 2點到2點59分(整點開始,每隔5分觸發) 每天下午的 18點到18點59分(整點開始,每隔5分觸發)
0 0-5 14 * * ? 每天下午的 2點到2點05分每分觸發
0 10,44 14 ? 3 WED 3月分每週三下午的 2點10分和2點44分觸發
0 15 10 ? * MON-FRI 從週一到週五每天上午的10點15分觸發
0 15 10 15 * ? 每月15號上午10點15分觸發
0 15 10 L * ? 每月最後一天的10點15分觸發
0 15 10 ? * 6L 每月最後一週的星期五的10點15分觸發
0 15 10 ? * 6L 2002-2005 從2002年到2005年每月最後一週的星期五的10點15分觸發
0 15 10 ? * 6#3 每月的第三週的星期五開始觸發
0 0 12 1/5 * ? 每月的第一個中午開始每隔5天觸發一次
0 11 11 11 11 ? 每年的11月11號 11點11分觸發(光棍節)

5. 範例

在Struts2專案啟動之後,已註冊的偵聽器類QuartzSchedulerListener.java 將被激發, 並呼叫 Quartz 作業,每10秒執行SchedulerTask.printSchedulerMessage()方法。

下載原始碼