Quartz核心原理之架構及基本元素介紹

2023-12-05 18:00:53

1 什麼是Quartz

Quartz是一個作業排程框架,它可以與J2EE和J2SE應用相結合,也可以單獨使用。它能夠建立多個甚至數萬個jobs這樣複雜的程式,jobs可以做成標準的java元件或EJBS。Quartz很容易上手,建立一個任務僅需實現Job介面,該介面只有一個方法void execute(JobExecutionContext context) throws JobExecutionException;在java實現類新增作業邏輯,當設定好Job實現類並設定排程時間表後,Quartz將會監控任務的剩餘時間,當排程程式確定需要通知需要執行該任務的時候,Quartz將會呼叫Job實現類的execute方法執行任務。

2 系統設計

Quartz框架的原理主要是通過將Job註冊到排程器,再通過觸發器策略執行Job,系統設計如下:

3 核心元素介紹

Quartz框架的核心是排程器scheduler,核心的元件包括Job(任務)、JobDetail(任務描述)、Trigger(觸發器)。排程器負責管理Quartz應用執行時環境。排程器不是靠自己做所有的工作,而是依賴框架內一些非常重要的部件。Quartz不僅僅是執行緒和執行緒管理。為確保可伸縮性,Quartz採用了基於多執行緒的架構。啟動時,框架初始化一套worker執行緒,這套執行緒被排程器用來執行預定的作業。這就是Quartz怎樣能並行執行多個作業的原理。Quartz依賴一套鬆耦合的執行緒池管理部件來管理執行緒環境。

3.1 Job

Job是一個介面,只有一個方法void execute(JobExecutionContext context) throws JobExecutionException。作業類需要實現介面中的execute方法,JobExecutionContext提供了排程的上下文資訊,每一次執行Job都會重新建立一個Job物件範例。如下:

public interface Job {

    /*
     * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
     * 
     * Interface.
     * 
     * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
     */

    /**
     * <p>
     * Called by the <code>{@link Scheduler}</code> when a <code>{@link Trigger}</code>
     * fires that is associated with the <code>Job</code>.
     * </p>
     * 
     * <p>
     * The implementation may wish to set a 
     * {@link JobExecutionContext#setResult(Object) result} object on the 
     * {@link JobExecutionContext} before this method exits.  The result itself
     * is meaningless to Quartz, but may be informative to 
     * <code>{@link JobListener}s</code> or 
     * <code>{@link TriggerListener}s</code> that are watching the job's 
     * execution.
     * </p>
     * 
     * @throws JobExecutionException
     *           if there is an exception while executing the job.
     */
    void execute(JobExecutionContext context)
        throws JobExecutionException;

}
public class ClosePayJob implements Job{
public void execute(JobExecutionContext context)  throws JobExecutionException{
//業務邏輯
}
}

3.2 JobDetail

Quartz框架在每次執行Job時,都會重新建立一個Job物件範例,所以它需要Job類的資訊以及其他相關資訊,以便能夠在執行時通過newInstance()的反射機制範例化Job。因此需要通過一個類來描述Job的實現類及其它相關的靜態資訊,比如Job名字、描述、關聯監聽器等資訊。JobDetail介面包含了能夠建立Job類的資訊載體,用來儲存任務的詳細資訊。如下程式碼定義

public interface JobDetail extends Serializable, Cloneable {

    public JobKey getKey();

    /**
     * <p>
     * Return the description given to the <code>Job</code> instance by its
     * creator (if any).
     * </p>
     * 
     * @return null if no description was set.
     */
    public String getDescription();

    /**
     * <p>
     * Get the instance of <code>Job</code> that will be executed.
     * </p>
     */
    public Class<? extends Job> getJobClass();

    /**
     * <p>
     * Get the <code>JobDataMap</code> that is associated with the <code>Job</code>.
     * </p>
     */
    public JobDataMap getJobDataMap();

    /**
     * <p>
     * Whether or not the <code>Job</code> should remain stored after it is
     * orphaned (no <code>{@link Trigger}s</code> point to it).
     * </p>
     * 
     * <p>
     * If not explicitly set, the default value is <code>false</code>.
     * </p>
     * 
     * @return <code>true</code> if the Job should remain persisted after
     *         being orphaned.
     */
    public boolean isDurable();

    /**
     * @see PersistJobDataAfterExecution
     * @return whether the associated Job class carries the {@link PersistJobDataAfterExecution} annotation.
     */
    public boolean isPersistJobDataAfterExecution();

    /**
     * @see DisallowConcurrentExecution
     * @return whether the associated Job class carries the {@link DisallowConcurrentExecution} annotation.
     */
    public boolean isConcurrentExectionDisallowed();

    /**
     * <p>
     * Instructs the <code>Scheduler</code> whether or not the <code>Job</code>
     * should be re-executed if a 'recovery' or 'fail-over' situation is
     * encountered.
     * </p>
     * 
     * <p>
     * If not explicitly set, the default value is <code>false</code>.
     * </p>
     * 
     * @see JobExecutionContext#isRecovering()
     */
    public boolean requestsRecovery();

    public Object clone();

    /**
     * Get a {@link JobBuilder} that is configured to produce a 
     * <code>JobDetail</code> identical to this one.
     */
    public JobBuilder getJobBuilder();

}

3.3 Trigger

觸發器(org.quartz.Trigger)抽象類的幾個主要屬性和JobDetail差不多,這裡就不說明了,主要注意的是misfireInstruction這個屬性,misfireInstruction這個屬性的是觸發器錯失執行(misfire)後的一個錯失觸發機制標識。當執行緒池中沒有可用的執行緒執行任務時,就會錯過觸發時間,Trigger抽象類中預設錯失觸發機制是常數0(聰明的策略)。派生類有它們自己的錯失觸發機制。最常用的兩種是SimpleTrigger和CronTrigger。

3.3.1 SimpleTrigger

指定從某一個時間開始,以一定的時間間隔(單位是毫秒)執行的任務。

它適合的任務類似於:9:00 開始,每隔1小時,執行一次。

它的屬性有:

  • repeatInterval 重複間隔
  • repeatCount 重複次數。實際執行次數是 repeatCount+1。因為在startTime的時候一定會執行一次。** 下面有關repeatCount 屬性的都是同理

3.3.2 CronTrigger

適合於更復雜的任務,它支援型別於Linux Cron的語法(並且更強大)。基本上它覆蓋了其他Trigger的絕大部分能力—— 當然,也更難理解。

它適合的任務類似於:每天0:00,9:00,18:00各執行一次。

它的屬性只有:Cron表示式。

4 總結

本次文章只是對Quartz的架構和基本元素做了簡單的介紹,後面我們會深入分析Quartz的核心類。

作者:京東物流 賈永強

來源:京東雲開發者社群 自猿其說Tech 轉載請註明來源