前言

  在很多公司,特別是網際網路公司,需要在指定的時間進行一些跑批任務來完成業務實現,Java中實現定時的方式有很多,其中可自己實現,也有比較成熟的框架,如: Quartz,今天來介紹一下Quartz的使用,

簡述

  Quartz is a richly featured, open source job scheduling library that can be integrated within virtually any Java application - from the smallest stand-alone application to the largest e-commerce system. Quartz can be used to create simple or complex schedules for executing tens, hundreds, or even tens-of-thousands of jobs; jobs whose tasks are defined as standard Java components that may execute virtually anything you may program them to do. The Quartz Scheduler includes many enterprise-class features, such as support for JTA transactions and clustering.

  Quartz是一個功能豐富的開源作業框架,可以整合到幾乎任何的Java應用程式中,從最小的獨立應用程式或最大的電商系統,Quartz可用於建立數十,數百甚至數十萬個簡單的作業或複雜的計劃,任務定義為標準的Java元件業務,可以執行幾乎任何可以對其進行程式設計的任務,Quartz Scheduler包含許多企業級功能,例如: 支援JTA事務和叢集。

功能

• 支援叢集,故障轉移
• 精確可控的任務排程
• 事務支援等

環境準備

該專案使用intellij IDE+Maven作為開發開發工具。
quartz maven依賴:

1
2
3
4
5
6
7
8
9
10
11
12

<!-- quartz start-->
 

 <dependency>
   <groupId>org.quartz-scheduler</groupId>
   <artifactId>quartz</artifactId>
   <version>2.3.0</version>
 </dependency>
 <dependency>
   <groupId>org.quartz-scheduler</groupId>
   <artifactId>quartz-jobs</artifactId>
 

   <version>2.3.0</version>
 </dependency>
 <!--quartz end-->

quartz中使用slf4j作為日誌工具。
log maven依賴為:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18

<!--log start-->
    <dependency>
      <groupId>org.slf4j</groupId>
      <artifactId>slf4j-api</artifactId>
      <version>1.7.25</version>
    </dependency>
    <dependency>
      <groupId>org.apache.logging.log4j</groupId>
      <artifactId>log4j-core</artifactId>
      <version>2.8.2</version>
    </dependency>
    <dependency>
      <groupId>org.slf4j</groupId>
      <artifactId>slf4j-log4j12</artifactId>
      <version>1.7.25</version>
      <scope>test</scope>
    </dependency>
    <!--log end-->

簡單job實現

有了環境準備,接下來，我們就可以來用一用quartz了,首先,我們寫一個job類,實現job介面,實現job介面中的execute方法,在真實環境中,在該方法中一般進行一些業務邏輯的處理,(在本例中,直接列印日誌,方便檢視有執行)。
Myjob類程式碼:

1
2
3
4
5
6
7
8
9
10
11
12
13

/**
 * @createTime: 2017年06月20日
 * @author: juyuqian
 * @version: 0.0.1
 * 描述: job任務
 */
public class MyJob implements Job {


    public void execute(JobExecutionContext jobExecutionContext) throws JobExecutionException {
        System.out.println("執行execute...........");
    }
}

有了任務,就需要有呼叫job的地方,在本例中,通過main函式的方式來演示任何呼叫job任務:
程式碼如下所示:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29

/**
 * @createTime: 2017年06月20日
 * @author: juyuqian
 * @version: 0.0.1
 * 描述:
 */
public class MainQuartzSimple {

    /**
     * 執行job資料
     * @param args
     */
    public static void main(String[] args){
        try{
            //1.獲取scheduler 例項
            Scheduler scheduler = StdSchedulerFactory.getDefaultScheduler();
            //2.設定job資訊,以及觸發器資訊
            JobDetail jobDetail = JobBuilder.newJob(MyJob.class).withIdentity("andyqian001","group1").build();
            Trigger trigger = TriggerBuilder.newTrigger().withIdentity("trigger1","group1").startNow().withSchedule(simpleSchedule()
                    .withIntervalInSeconds(2).repeatForever()).build();
            scheduler.scheduleJob(jobDetail, trigger);
            //3.開始任務排程
            scheduler.start();
            //4. 關閉scheduler.shutdown();
        }catch(SchedulerException ex){
            ex.printStackTrace();
        }
    }
}

1. 首先通過StdSchedulerFactory工廠獲取一個預設的Scheduler例項
2. 設定JobDetail,注意JobDetail是介面,通過JobBuilder建造者獲取一個JobDetail物件. 這裡Trigger是一個介面,在Quartz中預設有若干實現類,
   其中Trigger的實現類有:
3. CalendarIntervalTrigger()
4. MutableTrigger
5. SimpleTrigger
6. CoreTrigger
7. CronTrigger (通過cron表示式觸發)
8. DaliyTimeIntervalTrigger
   如下圖所示:
   
   其類圖如下所示

1. 效果如下:
   
   

   CronTrigger使用

   在這裡Job沿用MyJob中的實現方法,
   CronTrigger程式碼如下:

   /**
   * @createTime: 2017年06月20日
   * @author: juyuqian
   * @version: 0.0.1
   * 描述:
   */
   public class QuartzDataSimple02 {
   
    /**
     * test job的資料資訊
     */
    public static void main(String[] args){
        try{
            //1. 獲取任務排程
            Scheduler scheduler = StdSchedulerFactory.getDefaultScheduler();
            //2. 設定jobDetail以及cronTrigger觸發器
            JobDetail jobDetail = JobBuilder.newJob(MyJob.class).withIdentity("andyqian002","group1").build();
            CronTriggerImpl cronTrigger = new CronTriggerImpl();
            cronTrigger.setName("group1");
            cronTrigger.setCronExpression("0/2 * * * * ?");
            scheduler.scheduleJob(jobDetail, cronTrigger);
            //3.開啟
            scheduler.start();
        }catch(SchedulerException ex){
            ex.printStackTrace();
        }catch(ParseException ex){
            ex.printStackTrace();
        }
    }
   }
   

   這一段程式碼中涉及到了Cron表示式,現在沒明白沒關係,跑起來,效果和 簡單job實現 的實現是一樣的,到這裡，我們已經能夠簡單的使用Quartz了,休息一下,我們一起來看看[0/2 ?]表示式是如何構成的。

   Cron表示式

   Cron表示式由6個必選欄位與1個可選欄位組成,以空格為分隔符,其分別為:

其中years欄位為可選欄位,其餘均為必選欄位。
下表中為特殊字元的含義:

注意事項:
0 0 0 15W * ? 表示15號最近的一個工作日執行,如果15號是星期日,則為下週一執行,如果15號為星期六,執行時間為週五

小結

以上是Quartz Scheduler框架的使用,其中包括Cron表達是的介紹,你懂了嗎？(PS:應該問自己懂了嗎？記錄這篇文章就是自己容易忘記Cron表示式的書寫,自己記錄一篇,快忘記了就過來瞅瞅,這就是我寫部落格的初衷!)

參考連結