Spring Task定時任務的配置和使用

Joepis發表於2018-05-16
Spring

Spring Task

記錄下Spring自帶的定時任務用法。

spring中使用定時任務

基於xml配置檔案使用定時任務

首先配置spring開啟定時任務

<beans xmlns="http://www.springframework.org/schema/beans"  
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"   
    xmlns:p="http://www.springframework.org/schema/p"  
    xmlns:task="http://www.springframework.org/schema/task"  
    xmlns:context="http://www.springframework.org/schema/context"  
    xmlns:aop="http://www.springframework.org/schema/aop"   
    xsi:schemaLocation="http://www.springframework.org/schema/beans   
    http://www.springframework.org/schema/beans/spring-beans-4.0.xsd  
    http://www.springframework.org/schema/tx http://www.springframework.org/schema/tx/spring-tx-4.0.xsd    
    http://www.springframework.org/schema/jee http://www.springframework.org/schema/jee/spring-jee-4.0.xsd    
    http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-4.0.xsd    
    http://www.springframework.org/schema/aop http://www.springframework.org/schema/aop/spring-aop-4.0.xsd    
    http://www.springframework.org/schema/task http://www.springframework.org/schema/task/spring-task-4.0.xsd">  
  
    <task:annotation-driven /> <!-- 定時器開關-->  
  
    <bean id="myTask" class="com.spring.task.MyTask"></bean>  
  
    <task:scheduled-tasks>  
        <!-- 這裡表示的是每隔五秒執行一次 -->  
        <task:scheduled ref="myTask" method="show" cron="*/5 * * * * ?" />  
        <task:scheduled ref="myTask" method="print" cron="*/10 * * * * ?"/>  
    </task:scheduled-tasks>  
      
    <!-- 自動掃描的包名 -->
    <context:component-scan base-package="com.spring.task" />  
      
</beans>  
複製程式碼

定義自己的任務執行邏輯

package com.spring.task;  
  
/** 
 * 定義任務 
 */  
public class MyTask {  
      
    public void show() {  
        System.out.println("show method 1");  
    }  
      
    public void print() {  
        System.out.println("print method 1");  
    }  
} 
複製程式碼

基於註解使用定時任務

package com.spring.task;  
import org.springframework.scheduling.annotation.Scheduled;  
import org.springframework.stereotype.Component;  
  
/**
 * 基於註解的定時器  
 */
@Component
public class MyTask2 {  

    /**
     * 定時計算。每天凌晨 01:00 執行一次
     */
    @Scheduled(cron = "0 0 1 * * *")
    public void show() {
        System.out.println("show method 2");  
    }  
      
    /**
     * 啟動時執行一次，之後每隔2秒執行一次  
     */
    @Scheduled(fixedRate = 1000*2)   
    public void print() {  
        System.out.println("print method 2");
    }
}
複製程式碼

這樣，當專案啟動，定時任務就會按照規則按時執行了。

Spring Boot中使用定時任務

Spring Boot中使用更加方便。

  • 引入springboot starter包
<dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter</artifactId>
</dependency>
複製程式碼
  • 在程式入口啟動類新增@EnableScheduling，開啟定時任務功能
@SpringBootApplication
@EnableScheduling
public class Application {

    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }
複製程式碼
  • 定義定時任務邏輯
@Component
public class MyTask3 {

    private int count=0;

    @Scheduled(cron="*/6 * * * * ?")
    private void process() {
        System.out.println("this is scheduler task runing  "+(count++));
    }
}
複製程式碼

任務執行規則說明

先來看看@Scheduled註解的原始碼

@Target({ElementType.METHOD, ElementType.ANNOTATION_TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Repeatable(Schedules.class)
public @interface Scheduled {

	String cron() default "";

	String zone() default "";

	long fixedDelay() default -1;

	String fixedDelayString() default "";

	long fixedRate() default -1;

	String fixedRateString() default "";

	long initialDelay() default -1;

	String initialDelayString() default "";
}
複製程式碼

可以看出，註解中可以傳8種引數：

  • cron：指定cron表示式
  • zone：預設使用伺服器預設時區。可以設定為java.util.TimeZone中的zoneId
  • fixedDelay：從上一個任務完成開始到下一個任務開始的間隔，單位毫秒
  • fixedDelayString：同上，時間值是String型別
  • fixedRate：從上一個任務開始到下一個任務開始的間隔，單位毫秒
  • fixedRateString：同上，時間值是String型別
  • initialDelay：任務首次執行延遲的時間，單位毫秒
  • initialDelayString：同上，時間值是String型別

cron表示式的使用方法

Cron表示式是一個字串，字串以5或6個空格隔開，分為6或7個域，每一個域代表一個含義，Cron有如下兩種語法格式：

  • Seconds Minutes Hours DayofMonth Month DayofWeek Year
  • Seconds Minutes Hours DayofMonth Month DayofWeek

每一個域可出現的字元如下：

  • Seconds: 可出現", - * /"四個字元，有效範圍為0-59的整數
  • Minutes: 可出現", - * /"四個字元，有效範圍為0-59的整數
  • Hours: 可出現", - * /"四個字元，有效範圍為0-23的整數
  • DayofMonth: 可出現", - * / ? L W C"八個字元，有效範圍為0-31的整數
  • Month: 可出現", - * /"四個字元，有效範圍為1-12的整數或JAN-DEC
  • DayofWeek: 可出現", - * / ? L C #"四個字元，有效範圍為1-7的整數或SUN-SAT兩個範圍。1表示星期天，2表示星期一， 依次類推
  • Year: 可出現", - * /"四個字元，有效範圍為1970-2099年

每一個域都使用數字，但還可以出現如下特殊字元，它們的含義是：

  1. *：表示匹配該域的任意值，假如在Minutes域使用*, 即表示每分鐘都會觸發事件。
  2. ?：只能用在DayofMonth和DayofWeek兩個域。它也匹配域的任意值，但實際不會。因為DayofMonth和 DayofWeek會相互影響。例如想在每月的20日觸發排程，不管20日到底是星期幾，則只能使用如下寫法： 13 13 15 20 * ?, 其中最後一位只能用？，而不能使用*，如果使用*表示不管星期幾都會觸發，實際上並不是這樣。
  3. -：表示範圍，例如在Minutes域使用5-20，表示從5分到20分鐘每分鐘觸發一次。
  4. /：表示起始時間開始觸發，然後每隔固定時間觸發一次，例如在Minutes域使用5/20,則意味著5分鐘觸發一次，而25，45等分別觸發一次。
  5. ,：表示列出列舉值值。例如：在Minutes域使用5,20，則意味著在5和20分每分鐘觸發一次。
  6. L：表示最後，只能出現在DayofWeek和DayofMonth域，如果在DayofWeek域使用5L,意味著在最後的一個星期四觸發。
  7. W：表示有效工作日(週一到週五),只能出現在DayofMonth域，系統將在離指定日期的最近的有效工作日觸發事件。例如：在 DayofMonth使用5W，如果5日是星期六，則將在最近的工作日：星期五，即4日觸發。如果5日是星期天，則在6日(週一)觸發；如果5日在星期一 到星期五中的一天，則就在5日觸發。另外一點，W的最近尋找不會跨過月份。
  8. LW：這兩個字元可以連用，表示在某個月最後一個工作日，即最後一個星期五。
  9. #：用於確定每個月第幾個星期幾，只能出現在DayofMonth域。例如在4#2，表示某月的第二個星期三。

參考 cron表示式例子

相關文章