[JBoss]Java的工作排程套件-Quartz

序言

作為一個Application Server，JBoss裡的應用程式開發起來主要都是被動的等待Client呼叫啟動。但實際應用上還是有可能需要有個程序能夠在特定時間執行某些命令，例如於午夜12點整進行資料的Reset這種工作。
在不依賴作業系統或是另外執行一支程式處裡工作的狀況，其實JBoss預設就有推薦使用的工作排程套件-Quartz。
就Quartz的功能而言，有的功能是與Java內建的Timer重複的，但它功能更多更強大，所以相對的要做一些設定才能使用。
以下我就舉幾個我用的方法來一探Quartz的設定(當然，這不見得是最好的作法)。

開發環境

• Java Runtime: JDK 6 update 17
  
• Java IDE: Eclipse Java EE IDE for Web Developers
• Application Server: JBoss 5.1.0 GA
• Quartz：1.7.3
  

JBoss設定

JBoss內建就有Quartz的套件，但版本很老舊，從網路上得到的資訊來看，可能會有一些問題存在。
因此建議的作法是把內建的套件刪除掉，換上新的版本。

1. 刪除Jboss下common\lib\目錄的quartz.jar檔
2. 刪除Jboss下server發佈目錄下的quartz-ra.rar，如jboss\server\default\deploy目錄的quartz-ra.rar
3. quartz套件的壓縮檔打開，將裡面的quartz-all-1.7.3.jar檔案複製到jboss\common\lib(或jboss\server\default\lib)

Quartz設定檔

Quartz 提供了兩種不同的方式用來把排程工作存在記憶體(RAMJobStore)或資料庫(JDBCJobStore。)中。

• RAMJobStore:是預設的方法，因為所有資料都存在記憶體中，所以速度最快，但是如果伺服器停止後，所有排程的工作都會消失
• JDBCJobStore:透過 JDBC 把所有工作排成資訊存在資料庫中，但代價就是效能降低和設定複雜度的提高(尤其是有參數要透過JobDataMap在工作執行時使用時)。

在這邊我使用最簡單的RAMJobStore來進行工作排程。
這時會需要建立一個設定檔【quartz-service.xml】來設定工作排程套件的參數。這個檔案會放在JBoss的發佈目錄下，如jboss\server\default\deploy

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

<server>

        <mbean code="org.quartz.ee.jmx.jboss.QuartzService" name="user:service=QuartzService,name=QuartzService">
            <attribute name="JndiName">Quartz</attribute>
            <attribute name="StartScheduler">true</attribute>
            <attribute name="Properties">
                org.quartz.scheduler.instanceName = DefaultQuartzScheduler
                org.quartz.scheduler.rmi.export = false
                org.quartz.scheduler.rmi.proxy = false
                org.quartz.scheduler.xaTransacted = false
                
                org.quartz.threadPool.class = org.quartz.simpl.SimpleThreadPool
                org.quartz.threadPool.threadCount = 5
                org.quartz.threadPool.threadPriority = 4

                org.quartz.jobStore.class = org.quartz.simpl.RAMJobStore     
            </attribute>
        </mbean>

</server>

工作類別

工作要執行的內容必須實作【org.quartz.Job】介面，如

package control;

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

public class MyJob implements Job {
 static int jobs=0;
 @Override
 public void execute(JobExecutionContext arg0) throws JobExecutionException {
  JobDataMap dataMap = arg0.getJobDetail().getJobDataMap();
  Object data1 =dataMap.get("data1");
  Object data2 =dataMap.get("data2");
  System.out.println("Start MyJob");
  System.out.println("data1="+data1);
  System.out.println("data2="+data2);
 }

}

排程工作

排程的方式有兩種，一種是設定多久執行工作一次(SimpleTrigger)，一種是設定什麼時間要執行工作一次(CronTrigger)。

兩者最主要差別在於描述方式。相同的是兩者都可以設定排程啟動時間，結束時間，重複次數等設定。

• 使用SimpleTrigger

 String groupName = "Default";  //工作群組
 String jobName = "MySimpleJob"; //工作名稱
 InitialContext ctx;
 ctx = new InitialContext();
 Scheduler scheduler = (Scheduler) ctx.lookup("Quartz");
 //如果工作已排程，則刪除同樣工作群組-工作名稱的工作
 if (scheduler.getJobDetail(jobName, groupName) != null) {
  scheduler.deleteJob(jobName, groupName);
 }
 JobDetail jobDetail = new JobDetail(jobName, groupName,MyJob.class); //設定工作執行的類別為MyJob
 //設定要傳給工作的參數
 jobDetail.getJobDataMap().put("data1", "Job1");
 jobDetail.getJobDataMap().put("data2", jobName);
 SimpleTrigger simpleTrigger = new SimpleTrigger(jobName, groupName); //Trigger也會設定群組與名稱，但我不確定是有什麼功用
 simpleTrigger.setRepeatCount(-1);          //設定-1無限次重複，如果設為0則就只會執行一次
 simpleTrigger.setRepeatInterval(15*60*1000);       //每15分鐘做一次
 
 Calendar curCal = Calendar.getInstance();
 curCal.add(Calendar.MINUTE, 10);
 simpleTrigger.setStartTime(curCal.getTime()); //現在時間的10分鐘後啟動工作，如果不設定的話排程開始就會執行第一次
 
 scheduler.scheduleJob(jobDetail, simpleTrigger);
 if (!scheduler.isShutdown()) {
  scheduler.start();
 }

• 使用CronTrigger

 String groupName = "Default";  //工作群組
 String jobName = "MyCronJob"; //工作名稱
 InitialContext ctx;
 ctx = new InitialContext();
 Scheduler scheduler = (Scheduler) ctx.lookup("Quartz");
 //如果工作已排程，則刪除同樣工作群組-工作名稱的工作
 if (scheduler.getJobDetail(jobName, groupName) != null) {
  scheduler.deleteJob(jobName, groupName);
 }
 JobDetail jobDetail = new JobDetail(jobName, groupName,MyJob.class); //設定工作執行的類別為MyJob
 //設定要傳給工作的參數
 jobDetail.getJobDataMap().put("data1", "Job2");
 jobDetail.getJobDataMap().put("data2", jobName);
 CronTrigger trigger = new CronTrigger(jobName, groupName,"0 0 0 * * ?"); //每天0點整執行
 scheduler.scheduleJob(jobDetail, trigger);
 if (!scheduler.isShutdown()) {
  scheduler.start();
 }

在應用程式第一次被呼叫時排程工作

在Java Web Application中目前我還沒找到方法能在Jboss啟動時呼叫某個function，只能想到兩種方式當有第一個人啟動這個網站中的網頁時進行第一次的初始設定。
第一種方法是在static instance建立時在被New的物件建構函式中寫要做的工作，像是下面的程式。
但這種做法最大壞處是你沒辦法餵給它關於Web的Session、ServletContext等資訊，因為他是在Web內容還沒建立起來時就產生的。

import java.util.Calendar;

import javax.naming.InitialContext;

import org.quartz.JobDetail;
import org.quartz.Scheduler;
import org.quartz.SimpleTrigger;

public class InitJob {
 private static InitJob instance=new InitJob();
 private InitJob(){
  try {
   String groupName = "Default";  //工作群組
   String jobName = "MySimpleJob"; //工作名稱
   InitialContext ctx;
   ctx = new InitialContext();
   Scheduler scheduler = (Scheduler) ctx.lookup("Quartz");
   //如果工作已排程，則刪除同樣工作群組-工作名稱的工作
   if (scheduler.getJobDetail(jobName, groupName) != null) {
    scheduler.deleteJob(jobName, groupName);
   }
   JobDetail jobDetail = new JobDetail(jobName, groupName,MyJob.class); //設定工作執行的類別為MyJob
   //設定要傳給工作的參數
   jobDetail.getJobDataMap().put("data1", "Job1");
   jobDetail.getJobDataMap().put("data2", jobName);
   SimpleTrigger simpleTrigger = new SimpleTrigger(jobName, groupName); //Trigger也會設定群組與名稱，但我不確定是有什麼功用
   simpleTrigger.setRepeatCount(-1);          //設定-1無限次重複，如果設為0則就只會執行一次
   simpleTrigger.setRepeatInterval(15*60*1000);       //每15分鐘做一次
   
   Calendar curCal = Calendar.getInstance();
   curCal.add(Calendar.MINUTE, 10);
   simpleTrigger.setStartTime(curCal.getTime()); //現在時間的10分鐘後啟動工作，如果不設定的話排程開始就會執行第一次
   
   scheduler.scheduleJob(jobDetail, simpleTrigger);
   if (!scheduler.isShutdown()) {
    scheduler.start();
   }
  } catch (Exception e) {
   System.err.println(e.getMessage());
  }
 }
}

第二種方法是在Session建立時，設定一個Static 布林變數來判斷是否是第一次啟動，然後在裡面執行要做的工作，像是下面的程式。但相對付出的代價就是每個人進來時都會判斷一次。
如果要用這種方法就要再專案的web.xml中增加listener標籤，如

<?xml version="1.0" encoding="UTF-8"?>
<web-app...>
...
  <listener>
    <listener-class>control.InitSession</listener-class>
  </listener>
...
</web-app>

程式如下

package control;

import javax.naming.InitialContext;
import javax.servlet.ServletContext;
import javax.servlet.http.HttpSession;
import javax.servlet.http.HttpSessionEvent;
import javax.servlet.http.HttpSessionListener;

import org.quartz.CronTrigger;
import org.quartz.JobDetail;
import org.quartz.Scheduler;

public class InitSession implements HttpSessionListener {
 static boolean isInited=false;
 @Override
 public void sessionCreated(HttpSessionEvent arg0) {
  if(!isInited){
   //可取得Web相關的資訊
   ServletContext servletContext = arg0.getSession().getServletContext();
   HttpSession session = arg0.getSession();
   //工作設定
   String groupName = "Default";  //工作群組
   String jobName = "MyCronJob"; //工作名稱
   InitialContext ctx;
   ctx = new InitialContext();
   Scheduler scheduler = (Scheduler) ctx.lookup("Quartz");
   //如果工作已排程，則刪除同樣工作群組-工作名稱的工作
   if (scheduler.getJobDetail(jobName, groupName) != null) {
    scheduler.deleteJob(jobName, groupName);
   }
   JobDetail jobDetail = new JobDetail(jobName, groupName,MyJob.class); //設定工作執行的類別為MyJob
   //設定要傳給工作的參數
   jobDetail.getJobDataMap().put("data1", "Job2");
   jobDetail.getJobDataMap().put("data2", jobName);
   CronTrigger trigger = new CronTrigger(jobName, groupName,"0 0 0 * * ?"); //每天0點整執行
   scheduler.scheduleJob(jobDetail, trigger);
   if (!scheduler.isShutdown()) {
    scheduler.start();
   }
   isInited=true;
  }
 }

 @Override
 public void sessionDestroyed(HttpSessionEvent arg0) {  
 }
}

總結

以上就是在JBoss上面我使用Quartz的使用經驗，至於是否有更好的作法或是我的作法有什麼缺陷，歡迎留言告訴我，謝謝

參考資料

• 官方文件
• 關於Trigger的簡體中文說明 by 孺子牛