Quartz 概述

Quartz 是 OpenSymphony 開源組織在 Job Scheduling 領域又一個開源專案，它可以與 J2EE、 J2SE 應用程式相結合也可以單獨使用。Quartz 可以用來建立簡單或為執行十個，百個，甚至是好幾萬個 Jobs 這樣複雜的程式。Jobs 可以做成標準的 Java 元件或 EJBs。

Quartz 使用場景

Quartz 是一個任務排程框架。比如你遇到這樣的問題：

• 每天 01:00 傳送一份工作郵件給工作組成員並抄送給老闆（假裝自己很努力的工作到深夜）
• 每月 2 號提醒自己還信用卡或自動還款
• 每秒鐘發 N 筆髒資料給競爭對手公司的伺服器
• ......

這些問題總結起來就是：在某一個有規律的時間點幹某件事。並且時間的觸發的條件可以非常複雜，複雜到需要一個專門的框架來幹這個事。Quartz 就是來幹這樣的事，你給它一個觸發條件的定義，它負責到了時間點，觸發相應的 Job 起來幹活。

cron 表示式

cron 是 Linux 系統用來設定計劃任務的，比如：每天晚上 12 點重啟伺服器。

一個 cron 表示式具體表現就是一個字串，這個字串中包含 6~7 個欄位，欄位之間是由空格分割的，每個欄位可以由任何允許的值以及允許的特殊字元所構成，下面表格列出了每個欄位所允許的值和特殊字元。

• * 字元被用來指定所有的值。如：* 在分鐘的欄位域裡表示 “每分鐘”。
• - 字元被用來指定一個範圍。如：10-12 在小時域意味著 “10點、11點、12點”
• , 字元被用來指定另外的值。如：MON,WED,FRI 在星期域裡表示 “星期一、星期三、星期五”.
• ? 字元只在日期域和星期域中使用。它被用來指定 “非明確的值”。當你需要通過在這兩個域中的一個來指定一些東西的時候，它是有用的。
• L 字元指定在月或者星期中的某天（最後一天）。即 “Last” 的縮寫。但是在星期和月中 “Ｌ” 表示不同的意思，如：在月欄位中 “L” 指月份的最後一天 “1月31日，2月28日”，如果在星期欄位中則簡單的表示為“7”或者“SAT”。如果在星期欄位中在某個 value 值得後面，則表示 “某月的最後一個星期 value” ,如 “6L” 表示某月的最後一個星期五。
• W 字元只能用在月份欄位中，該欄位指定了離指定日期最近的那個星期日。
• # 字元只能用在星期欄位，該欄位指定了第幾個星期 value 在某月中

每一個元素都可以顯式地規定一個值（如 6），一個區間（如 9-12 ），一個列表（如 9，11，13 ）或一個萬用字元（如 *）。“月份中的日期”和“星期中的日期”這兩個元素是互斥的，因此應該通過設定一個問號（?）來表明你不想設定的那個欄位。

Spring Boot 整合 Quartz

引入依賴

在 pom.xml 中引入 spring-boot-starter-quartz 依賴：

<!-- Quartz Begin -->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-quartz</artifactId>
</dependency>
<!-- Quartz End -->

添加註解

在入口類中新增 @EnableScheduling 註解來開啟計劃任務功能。

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.scheduling.annotation.EnableScheduling;

@EnableScheduling
@SpringBootApplication
public class HelloQuatrzApplication {
    public static void main(String[] args) {
        SpringApplication.run(HelloQuatrzApplication.class, args);
    }
}

建立任務

建立一個每 5 秒鐘列印當前時間的任務來測試 Quartz

import org.springframework.scheduling.annotation.Scheduled;
import org.springframework.stereotype.Component;

import java.text.SimpleDateFormat;
import java.util.Date;

@Component
public class PrintCurrentTimeTask {
    @Scheduled(cron = "0/5 * * * * ? ")
    public void printCurrentTime() {
        System.out.println("Current Time is:" + new SimpleDateFormat("yyyy-MM-dd HH:mm:ss").format(new Date()));
    }
}

最後啟動專案測試列印效果。

• 文章作者：彭超
• 本文首發於個人部落格：https://antoniopeng.com
• 版權宣告：本部落格所有文章除特別宣告外，均採用 CC BY-NC-SA 4.0 許可協議。轉載請註明來自 彭超的部落格！