SpringBoot定時任務

時間  2019-11-17
標籤 springboot 定時 任務 欄目 Spring 简体版
原文   原文鏈接

1、定時任務概述

    後臺項目開發中常常會用到定時任務，如今實現定時任務都方式也是多種多樣。下面列舉幾種常見的定時任務實現方式：html

    1. Quartz：Quartz的使用至關普遍，它是一個功能強大的調度器，固然使用起來也相對麻煩；java

    2. java.util包裏的Timer，它也能夠實現定時任務可是功能過於單一全部使用不多。spring

    3. 就是咱們今天要介紹的Spring自帶的定時任務Schedule，其實能夠把它看做是一個簡化版的，輕量級的Quartz，使用起來也相對方便不少。express

2、實現定時任務

1. 建立定時任務

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.scheduling.annotation.Scheduled;
import org.springframework.stereotype.Component;

/**
 * Description: 構建執行定時任務
 * Designer: jack
 * Date: 2017/8/10
 * Version: 1.0.0
 */
@Component
public class ScheduledTasks {

    private Logger logger = LoggerFactory.getLogger(ScheduledTasks.class);

    private int fixedDelayCount = 1;
    private int fixedRateCount = 1;
    private int initialDelayCount = 1;
    private int cronCount = 1;

    @Scheduled(fixedDelay = 5000)        //fixedDelay = 5000表示當前方法執行完畢5000ms後，Spring scheduling會再次調用該方法
    public void testFixDelay() {
        logger.info("===fixedDelay: 第{}次執行方法", fixedDelayCount++);
    }

    @Scheduled(fixedRate = 5000)        //fixedRate = 5000表示當前方法開始執行5000ms後，Spring scheduling會再次調用該方法
    public void testFixedRate() {
        logger.info("===fixedRate: 第{}次執行方法", fixedRateCount++);
    }

    @Scheduled(initialDelay = 1000, fixedRate = 5000)   //initialDelay = 1000表示延遲1000ms執行第一次任務
    public void testInitialDelay() {
        logger.info("===initialDelay: 第{}次執行方法", initialDelayCount++);
    }

    @Scheduled(cron = "0 0/1 * * * ?")  //cron接受cron表達式，根據cron表達式肯定定時規則
    public void testCron() {
        logger.info("===initialDelay: 第{}次執行方法", cronCount++);
    }

}

    咱們使用@Scheduled來建立定時任務 這個註解用來標註一個定時任務方法。經過看@Scheduled源碼能夠看出它支持多種參數：多線程

    （1）cron：cron表達式，指定任務在特定時間執行；併發

    （2）fixedDelay：表示上一次任務執行完成後多久再次執行，參數類型爲long，單位ms；ide

    （3）fixedDelayString：與fixedDelay含義同樣，只是參數類型變爲String；this

    （4）fixedRate：表示按必定的頻率執行任務，參數類型爲long，單位ms；spa

    （5）fixedRateString: 與fixedRate的含義同樣，只是將參數類型變爲String；線程

    （6）initialDelay：表示延遲多久再第一次執行任務，參數類型爲long，單位ms；

    （7）initialDelayString：與initialDelay的含義同樣，只是將參數類型變爲String；

    （8）zone：時區，默認爲當前時區，通常沒有用到。

2.開啓定時任務

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

/**
 * Description: 啓動類
 * Designer: jack
 * Date: 2017/8/10
 * Version: 1.0.0
 */
@SpringBootApplication
@EnableScheduling
public class Application {
    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }
}

    注意這裏的 @EnableScheduling 註解，它的做用是發現註解@Scheduled的任務並由後臺執行。沒有它的話將沒法執行定時任務。

引用官方文檔原文：

@EnableScheduling ensures that a background task executor is created. Without it, nothing gets scheduled.

3. 執行結果 （單線程）

    到此咱們就完成了一個簡單的定時任務模型，下面執行springBoot觀察執行結果。

2017-08-11 12:06:19.738  INFO 52252 --- [pool-1-thread-1] com.test.ScheduledTasks                  : ===initialDelay: 第1次執行方法
2017-08-11 12:06:23.739  INFO 52252 --- [pool-1-thread-1] com.test.ScheduledTasks                  : ===fixedRate: 第2次執行方法
2017-08-11 12:06:23.739  INFO 52252 --- [pool-1-thread-1] com.test.ScheduledTasks                  : ===fixedDelay: 第2次執行方法
2017-08-11 12:06:24.738  INFO 52252 --- [pool-1-thread-1] com.test.ScheduledTasks                  : ===initialDelay: 第2次執行方法
2017-08-11 12:06:28.739  INFO 52252 --- [pool-1-thread-1] com.test.ScheduledTasks                  : ===fixedRate: 第3次執行方法
2017-08-11 12:06:28.740  INFO 52252 --- [pool-1-thread-1] com.test.ScheduledTasks                  : ===fixedDelay: 第3次執行方法
2017-08-11 12:06:29.739  INFO 52252 --- [pool-1-thread-1] com.test.ScheduledTasks                  : ===initialDelay: 第3次執行方法
2017-08-11 12:06:33.735  INFO 52252 --- [pool-1-thread-1] com.test.ScheduledTasks                  : ===fixedRate: 第4次執行方法
2017-08-11 12:06:33.741  INFO 52252 --- [pool-1-thread-1] com.test.ScheduledTasks                  : ===fixedDelay: 第4次執行方法
2017-08-11 12:06:34.738  INFO 52252 --- [pool-1-thread-1] com.test.ScheduledTasks                  : ===initialDelay: 第4次執行方法

    從控制檯輸入的結果中咱們能夠看出全部的定時任務都是在同一個線程池用同一個線程來處理的，那麼咱們如何來併發的處理各定時任務呢，請繼續向下看。

4. 多線程處理定時任務

    看到控制檯輸出的結果，全部的定時任務都是經過一個線程來處理的，我估計是在定時任務的配置中設定了一個SingleThreadScheduledExecutor，因而我看了源碼，從ScheduledAnnotationBeanPostProcessor類開始一路找下去。果真，在ScheduledTaskRegistrar（定時任務註冊類）中的ScheduleTasks中又這樣一段判斷：

if (this.taskScheduler == null) {
			this.localExecutor = Executors.newSingleThreadScheduledExecutor();
			this.taskScheduler = new ConcurrentTaskScheduler(this.localExecutor);
		}

    這就說明若是taskScheduler爲空，那麼就給定時任務作了一個單線程的線程池，正好在這個類中還有一個設置taskScheduler的方法：

public void setScheduler(Object scheduler) {
		Assert.notNull(scheduler, "Scheduler object must not be null");
		if (scheduler instanceof TaskScheduler) {
			this.taskScheduler = (TaskScheduler) scheduler;
		}
		else if (scheduler instanceof ScheduledExecutorService) {
			this.taskScheduler = new ConcurrentTaskScheduler(((ScheduledExecutorService) scheduler));
		}
		else {
			throw new IllegalArgumentException("Unsupported scheduler type: " + scheduler.getClass());
		}
	}

    這樣問題就很簡單了，咱們只需用調用這個方法顯式的設置一個ScheduledExecutorService就能夠達到併發的效果了。咱們要作的僅僅是實現SchedulingConfigurer接口，重寫configureTasks方法就OK了；

import org.springframework.context.annotation.Configuration;
import org.springframework.scheduling.annotation.SchedulingConfigurer;
import org.springframework.scheduling.config.ScheduledTaskRegistrar;

import java.util.concurrent.Executors;

/**
 * Description: 多線程執行定時任務
 * Designer: jack
 * Date: 2017/8/10
 * Version: 1.0.0
 */
@Configuration
//全部的定時任務都放在一個線程池中，定時任務啓動時使用不一樣都線程。
public class ScheduleConfig implements SchedulingConfigurer {
    @Override
    public void configureTasks(ScheduledTaskRegistrar taskRegistrar) {
        //設定一個長度10的定時任務線程池
        taskRegistrar.setScheduler(Executors.newScheduledThreadPool(10));
    }
}

    注: 最開始我試圖在ScheduledAnnotationBeanPostProcessor類中作文章，由於裏面也有一個相似的方法setScheduler（），可是最後失敗了，不知道是否能夠經過這個類實現定時任務的併發，若是有實現了的也請告訴你們一下方法。

5. 執行結果（併發）

2017-08-11 12:21:16.000  INFO 52284 --- [pool-1-thread-3] com.test.ScheduledTasks                  : ===initialDelay: 第1次執行方法
2017-08-11 12:21:19.998  INFO 52284 --- [pool-1-thread-4] com.test.ScheduledTasks                  : ===fixedRate: 第2次執行方法
2017-08-11 12:21:19.998  INFO 52284 --- [pool-1-thread-1] com.test.ScheduledTasks                  : ===fixedDelay: 第2次執行方法
2017-08-11 12:21:20.999  INFO 52284 --- [pool-1-thread-4] com.test.ScheduledTasks                  : ===initialDelay: 第2次執行方法
2017-08-11 12:21:25.000  INFO 52284 --- [pool-1-thread-2] com.test.ScheduledTasks                  : ===fixedRate: 第3次執行方法
2017-08-11 12:21:25.000  INFO 52284 --- [pool-1-thread-6] com.test.ScheduledTasks                  : ===fixedDelay: 第3次執行方法
2017-08-11 12:21:25.997  INFO 52284 --- [pool-1-thread-3] com.test.ScheduledTasks                  : ===initialDelay: 第3次執行方法
2017-08-11 12:21:30.000  INFO 52284 --- [pool-1-thread-7] com.test.ScheduledTasks                  : ===fixedRate: 第4次執行方法
2017-08-11 12:21:30.000  INFO 52284 --- [pool-1-thread-8] com.test.ScheduledTasks                  : ===fixedDelay: 第4次執行方法
2017-08-11 12:21:31.000  INFO 52284 --- [pool-1-thread-7] com.test.ScheduledTasks                  : ===initialDelay: 第4次執行方法

經過控制檯輸出的結果看出每一個定時任務都是在經過不一樣的線程來處理了。

3、cron詳解

1. cron表達式定義

    Cron表達式是一個字符串，是由空格隔開的6或7個域組成，每個域對應一個含義（秒 分 時 每個月第幾天 月 星期 年）其中年是可選字段。

    可是，此處敲一下黑板，spring的schedule值支持6個域的表達式，也就是不能設定年，若是超過六個則會報錯。源碼以下：

/**
	 * Parse the given pattern expression.
	 */
	private void parse(String expression) throws IllegalArgumentException {
		String[] fields = StringUtils.tokenizeToStringArray(expression, " ");
		if (!areValidCronFields(fields)) {
			throw new IllegalArgumentException(String.format(
					"Cron expression must consist of 6 fields (found %d in \"%s\")", fields.length, expression));
		}
		setNumberHits(this.seconds, fields[0], 0, 60);
		setNumberHits(this.minutes, fields[1], 0, 60);
		setNumberHits(this.hours, fields[2], 0, 24);
		setDaysOfMonth(this.daysOfMonth, fields[3]);
		setMonths(this.months, fields[4]);
		setDays(this.daysOfWeek, replaceOrdinals(fields[5], "SUN,MON,TUE,WED,THU,FRI,SAT"), 8);
		if (this.daysOfWeek.get(7)) {
			// Sunday can be represented as 0 or 7
			this.daysOfWeek.set(0);
			this.daysOfWeek.clear(7);
		}
	}

	private static boolean areValidCronFields(String[] fields) {
		return (fields != null && fields.length == 6);
	}

2. 每一個域可出現的字符類型和各字符的含義

（1）各域支持的字符類型

    秒：可出現", - * /"四個字符，有效範圍爲0-59的整數  

    分：可出現", - * /"四個字符，有效範圍爲0-59的整數  

    時：可出現", - * /"四個字符，有效範圍爲0-23的整數  

    每個月第幾天：可出現", - * / ? L W C"八個字符，有效範圍爲0-31的整數  

    月：可出現", - * /"四個字符，有效範圍爲1-12的整數或JAN-DEc  

    星期：可出現", - * / ? L C #"四個字符，有效範圍爲1-7的整數或SUN-SAT兩個範圍。1表示星期天，2表示星期一， 依次類推

（2）特殊字符含義

    * : 表示匹配該域的任意值，好比在秒*, 就表示每秒都會觸發事件。；

    ? : 只能用在每個月第幾天和星期兩個域。表示不指定值，當2個子表達式其中之一被指定了值之後，爲了不衝突，須要將另外一個子表達式的值設爲「?」；

    - : 表示範圍，例如在分域使用5-20，表示從5分到20分鐘每分鐘觸發一次  

    / : 表示起始時間開始觸發，而後每隔固定時間觸發一次，例如在分域使用5/20,則意味着5分，25分，45分，分別觸發一次.  

    , : 表示列出枚舉值。例如：在分域使用5,20，則意味着在5和20分時觸發一次。  

    L : 表示最後，只能出如今星期和每個月第幾天域，若是在星期域使用1L,意味着在最後的一個星期日觸發。  

    W : 表示有效工做日(週一到週五),只能出如今每個月第幾日域，系統將在離指定日期的最近的有效工做日觸發事件。注意一點，W的最近尋找不會跨過月份  

    LW : 這兩個字符能夠連用，表示在某個月最後一個工做日，即最後一個星期五。  

    # : 用於肯定每月第幾個星期幾，只能出如今每個月第幾天域。例如在1#3，表示某月的第三個星期日。

（3）表達式例子

    引用spring官方註釋：


 * <p>Example patterns:
 * <ul>
 * <li>"0 0 * * * *" = the top of every hour of every day.</li>
 * <li>"*&#47;10 * * * * *" = every ten seconds.</li>
 * <li>"0 0 8-10 * * *" = 8, 9 and 10 o'clock of every day.</li>
 * <li>"0 0/30 8-10 * * *" = 8:00, 8:30, 9:00, 9:30 and 10 o'clock every day.</li>
 * <li>"0 0 9-17 * * MON-FRI" = on the hour nine-to-five weekdays</li>
 * <li>"0 0 0 25 12 ?" = every Christmas Day at midnight</li>

    "0 0 * * * *"                      表示每小時0分0秒執行一次

    " */10 * * * * *"                 表示每10秒執行一次

    "0 0 8-10 * * *"                 表示天天8，9，10點執行

    "0 0/30 8-10 * * *"            表示天天8點到10點，每半小時執行

    "0 0 9-17 * * MON-FRI"     表示每週一至週五，9點到17點的0分0秒執行

    "0 0 0 25 12 ?"                  表示每一年聖誕節（12月25日）0時0分0秒執行

相關文章
相關標籤/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公眾號
   歡迎關注本站公眾號,獲取更多信息
聯繫我們 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程