1. 程式人生 > >springboot整合 Quartz

springboot整合 Quartz

為什麼使用 Quartz?

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

  • 每天 02:00 傳送一份工作郵件給工作組成員並抄送給老闆(假裝自己很努力的工作到深夜)
  • 每月 2 號提醒自己還信用卡或自動還款

什麼是 cron 表示式?

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

格式

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

欄位 允許值 允許的特殊字元
0-59 , - * /
0-59 , - * /
小時 0-23 , - * /
日期 1-31 , - * / L W C
月份 1-12 或者 JAN-DEC , - * /
星期 1-7 或者 SUN-SAT , - * / L C #
年(可選) 留空, 1970-2099 , - * /
  • * 字元被用來指定所有的值。如:* 在分鐘的欄位域裡表示“每分鐘”。
  • - 字元被用來指定一個範圍。如:10-12 在小時域意味著“10點、11點、12點”
  • , 字元被用來指定另外的值。如:MON,WED,FRI 在星期域裡表示“星期一、星期三、星期五”.
  • ? 字元只在日期域和星期域中使用。它被用來指定“非明確的值”。當你需要通過在這兩個域中的一個來指定一些東西的時候,它是有用的。

  • L 字元指定在月或者星期中的某天(最後一天)。即 “Last” 的縮寫。但是在星期和月中 “L” 表示不同的意思,如:在月欄位中 “L” 指月份的最後一天 “1月31日,2月28日”,如果在星期欄位中則簡單的表示為“7”或者“SAT”。如果在星期欄位中在某個 value 值得後面,則表示 “某月的最後一個星期 value” ,如 “6L” 表示某月的最後一個星期五。

  • W 字元只能用在月份欄位中,該欄位指定了離指定日期最近的那個星期日。
  • # 字元只能用在星期欄位,該欄位指定了第幾個星期 value 在某月中

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

表示式 意義
0 0 12 * * ? 每天中午 12 點觸發
0 15 10 ? * * 每天上午 10:15 觸發
0 15 10 * * ? 每天上午 10:15 觸發
0 15 10 * * ? * 每天上午 10:15 觸發
0 15 10 * * ? 2005 2005 年的每天上午 10:15 觸發
0 * 14 * * ? 在每天下午 2 點到下午 2:59 期間的每 1 分鐘觸發
0 0/5 14 * * ? 在每天下午 2 點到下午 2:55 期間的每 5 分鐘觸發
0 0/5 14,18 * * ? 在每天下午 2 點到 2:55 期間和下午 6 點到 6:55 期間的每 5 分鐘觸發
0 0-5 14 * * ? 在每天下午 2 點到下午 2:05 期間的每 1 分鐘觸發
0 10,44 14 ? 3 WED 每年三月的星期三的下午 2:10 和 2:44 觸發
0 15 10 ? * MON-FRI 週一至週五的上午 10:15 觸發
0 15 10 15 * ? 每月 15 日上午 10:15 觸發
0 15 10 L * ? 每月最後一日的上午 10:15 觸發
0 15 10 ? * 6L 每月的最後一個星期五上午 10:15 觸發
0 15 10 ? * 6L 2002-2005 2002 年至 2005 年的每月的最後一個星期五上午 10:15 觸發
0 15 10 ? * 6#3 每月的第三個星期五上午 10:15 觸發

 增加 org.springframework.boot:spring-boot-starter-quartz 依賴

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>com.me</groupId>
    <artifactId>hello-quartz</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <packaging>jar</packaging>

    <name>hello-quartz</name>

    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.0.4.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>

    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
        <java.version>1.8</java.version>
    </properties>

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-quartz</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>

</project>

 新增  @EnableScheduling 註解來開啟計劃任務功能

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

使用示例 

@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()));
    }
}