隨筆分類(103)

Quartz 是一個強大的企業級 Schedule 工具，也是目前最好的開源 Schedule 工具，最近因為項目的需要，簡單的用到了 Quartz 的一些功能，對項目中使用 Quartz 的一些問題做簡單的記錄。

在 Quartz 的應用中，我們用到了以下的一些東西，ScheduleFactory, Scheduler, Job, JobDetail, Trigger，簡單說明一下他們的用途。

SchedulerFactory 是 Scheduler 的工廠，我們可以從中獲得受工廠管理的 Scheduler 對象。

SchedulerFactory scheduleFactory = new StdSchedulerFactory();
Scheduler scheduler = scheduleFactory.getScheduler();

Scheduler 是一個計劃集，其中可以包含多個 JobDetail 和 Trigger 組成的計劃任務。
我們可以從 SchedulerFactory 中取得 Scheduler。

接口Job是每個業務上需要執行的任務需要實現的接口，該接口只有一個方法：

public interface Job {
    public void execute(JobExecutionContext context)
        throws JobExecutionException;
}

我們可以在里面定義我們的 Job 執行邏輯，比如清除過期數據，更新緩存等。

JobDetail描述了一個任務具體的信息，比如名稱，組名等等。
JobDetail jobDetail = new JobDetail("SayHelloWorldJob", Scheduler.DEFAULT_GROUP, SayHelloWorldJob.class);
在上面的構造方法中，第一個是任務的名稱，第二個是組名，第三個就是實際當任務需要執行的回調類。

Trigger顧名思義就是觸發器，Quartz有個很好的想法就是分離了任務和任務執行的條件。Trigger就是控制任務執行條件的類，當Trigger認為執行條件滿足的時刻，Trigger會通知相關的Job去執行。分離的好處是：
1.你可以為某個Job關聯多個Trigger，其中任何一個條件滿足都可以觸發job執行，這樣可以完成一些組合的高級觸發條件
2.當Trigger失效后（比如：一個永遠都不能滿足的條件），你不必去聲明一個新的job，代替的是你可以為job關聯一個新的Trigger讓job可以繼續執行。

目前的Quartz實現中，存在兩種Trigger,SimpleTrigger和CronTrigger,SimpleTrigger用來完成一些比如固定時間執行的任務，比如：從現在開始1分鐘后等等；而CronTrigger(沒錯，和unix的cron進程的含意一樣)用來執行calendar-like的任務，比如：每周五下午3：00，每月最后一天等等。

在我們項目中，都是一些固定時間的 Job，所以只用到了 SimpleTrigger。
Trigger trigger = new SimpleTrigger("SayHelloWorldJobTrigger",Scheduler.DEFAULT_GROUP,new Date(),null,0,0L);
這個構造方法中，第一個是Trigger的名稱，第二個是Trigger的組名，第三個是任務開始時間，第四個是結束時間，第五個是重復次數（使用SimpleTrigger.REPEAT_INDEFINITELY常量表示無限次），最后一個是重復周期（單位是毫秒），那么這樣就創建了一個立刻并只執行一次的任務。

但我們定義好了 JobDetail，Job，和 Trigger 后，就可以開始 Schedule 一個 Job 了。

scheduler.scheduleJob(jobDetail, trigger);

這條語句就是把job和Trigger關聯，這樣當Trigger認為應該觸發的時候就會調用（實際上是Scheduler調用）job.execute方法了。

scheduler.start();
千萬別忘了加上上面的語句，這條語句通知Quartz使安排的計劃生效。

關于execute方法的參數JobExecutionContext
JobExecutionContext就和很多Context結尾的類功能一樣，提供的運行時刻的上下文環境，JobExecutionContext中有Scheduler,JobDetail,Trigger等很多對象的引用，從而當你在execute方法內部須需要這些對象的時刻提供的便利。

在項目中，我們把需要執行的 Job 相對應的一些信息放在 JobExecutionContext 中，在 Job 執行的時候可以調用。

jobDetail.getJobDataMap().put(userid, id);

在 Job 中，我們可以拿到相關的 Context 信息：

jobExecutionContext.getJobDetail().getJobDataMap().getInt(userid);

JobDetail和Trigger的name和group
Scheduler實例對應了很多job和trigger的實例，為了方便的區分，Quartz使用name和group這兩個特性，正如你想向的一樣，同一個group下不能有兩個相同name的JobDetail，Trigger同理，同一個Scheduler下不能有兩個相同group的JobDetail,Trigger同理，JobDetail和Trigger的完全限定名為：group + name

為了讓服務器重啟以后，我們的 Scheduler 信息仍然不丟失，我們通常采用數據庫持久化 Scheduler 的信息。
DBScript 在 Quartz 的下載包中的：quartz-1.6.0\docs\dbTables 下，選擇自己使用的 DB 相應的 Script 導入數據庫就可以了。
在應用中，我們需要配置一個 quartz.properties 才能正常使用 DB。我們可以在 quartz-1.6.0\examples\example10 中找到該文件的樣例，稍作一些修改，就可以放到自己項目源碼的根目錄下使用了。

設置 org.quartz.jobStore.class = org.quartz.impl.jdbcjobstore.JobStoreTX 即可啟用基于 JDBC 的 Quartz 信息持久化。

根據項目情況設置以下配置信息：
org.quartz.jobStore.class = org.quartz.impl.jdbcjobstore.JobStoreTX
org.quartz.jobStore.driverDelegateClass = org.quartz.impl.jdbcjobstore.StdJDBCDelegate
org.quartz.jobStore.useProperties = false
org.quartz.jobStore.dataSource = myDS
org.quartz.jobStore.tablePrefix = QRTZ_
org.quartz.jobStore.isClustered = false

org.quartz.dataSource.myDS.driver = com.mysql.jdbc.Driver
org.quartz.dataSource.myDS.URL = jdbc:mysql://localhost:3306/myapplication
org.quartz.dataSource.myDS.user = root
org.quartz.dataSource.myDS.password =
org.quartz.dataSource.myDS.maxConnections = 5

但是光設置了 Database 不夠，我們還需要在 Application 啟動的時候自動啟動 Scheduler 才行，我們只需要簡單的寫一個 Servlet 的 Listener 并在 web.xml 中聲明該 Listener ，在 Servlet 容易啟動的時候，Scheduler 就開始自動執行。

public class ScheduleStartListener implements ServletContextListener {
    public void contextInitialized(ServletContextEvent servletContextEvent) {
        try {
           scheduleFactory.getScheduler().start();
        } catch (SchedulerException e) {
           // write log
        }
    }

    public void contextDestroyed(ServletContextEvent servletContextEvent) {
        try {
           scheduleFactory.getScheduler().shutdown();
        } catch (SchedulerException e) {
           // write log
        }
    }
}

在 web.xml 里面加入以下配置：
<listener>
    <listener-class>org.agilejava.scheduler.ScheduleStartListener</listener-class>
</listener>

以上簡單的記錄了在項目中關于 Quartz 的一些應用，如果有什么新的使用心得，會在后面繼續加入的。