目前springboot應(yīng)用廣泛，因此對(duì)于spring-task直接基于springboot框架介紹，不涉及xml配置。

本文直接介紹spring-task的使用方法，涉及的相關(guān)基礎(chǔ)知識(shí)不再贅述，請(qǐng)先閱讀Timer和ScheduledExecutorService的相關(guān)文章。

Timer參考:Java Timer使用講解

ScheduledExecutorService參考:一文搞懂Java ScheduledExecutorService的使用

一、基本使用

這里以ladderx-scaffold的源碼作為案例，使用spring-task，需要先使用@EnableScheduling開啟定時(shí)任務(wù)。

@EnableScheduling
public class ApiAutoConfiguration {
}

當(dāng)要?jiǎng)?chuàng)建一個(gè)定時(shí)任務(wù)時(shí)，@Scheduled可以直接注解在無返回值無參數(shù)方法上，表示該方法根據(jù)注解的規(guī)則定時(shí)執(zhí)行。

@Scheduled(cron = "0 0 2 * * ? ")
public void timerClean() {
}

@Scheduled注解主要支持三種方式：

• cron方式：@Scheduled(cron = "0 0 2 * * ? ")
• 固定速率：@Scheduled(initialDelay = 5000， fixedDelay = 2000)，單位毫秒
• 固定延時(shí)：@Scheduled(initialDelay = 5000， fixedRate = 2000)，單位毫秒

二、@Scheduled屬性詳解

我們可以直接使用注解@Scheduled添加到方法上，spring會(huì)將按照注解屬性的規(guī)則定時(shí)的執(zhí)行該方法。

以下參數(shù)cron/fixedDelay/fixedRate三個(gè)屬性必須且只能出現(xiàn)一個(gè)。

1. cron

該參數(shù)接收一個(gè)cron表達(dá)式，cron表達(dá)式是一個(gè)字符串，字符串以5或6個(gè)空格隔開，分開共6或7個(gè)域，每一個(gè)域代表一個(gè)含義。

可以到http://cron.qqe2.com/使用cron生成器。

cron表達(dá)式語法

[秒] [分] [小時(shí)] [日] [月] [周] [年]

注：[年]不是必須的域，可以省略[年]，則一共6個(gè)域

通配符說明:

• * 表示所有值。 例如:在分的字段上設(shè)置 *,表示每一分鐘都會(huì)觸發(fā)。
• ? 表示不指定值。使用的場景為不需要關(guān)心當(dāng)前設(shè)置這個(gè)字段的值。例如:要在每月的10號(hào)觸發(fā)一個(gè)操作，但不關(guān)心是周幾，所以需要周位置的那個(gè)字段設(shè)置為”?” 具體設(shè)置為 0 0 0 10 * ?
• - 表示區(qū)間。例如 在小時(shí)上設(shè)置 “10-12”,表示 10,11,12點(diǎn)都會(huì)觸發(fā)。
• , 表示指定多個(gè)值，例如在周字段上設(shè)置 “MON,WED,FRI” 表示周一，周三和周五觸發(fā)
• / 用于遞增觸發(fā)。如在秒上面設(shè)置”5/15” 表示從5秒開始，每增15秒觸發(fā)(5,20,35,50)。 在月字段上設(shè)置’1/3’所示每月1號(hào)開始，每隔三天觸發(fā)一次。
• L 表示最后的意思。在日字段設(shè)置上，表示當(dāng)月的最后一天(依據(jù)當(dāng)前月份，如果是二月還會(huì)依據(jù)是否是潤年[leap]), 在周字段上表示星期六，相當(dāng)于”7”或”SAT”。如果在”L”前加上數(shù)字，則表示該數(shù)據(jù)的最后一個(gè)。例如在周字段上設(shè)置”6L”這樣的格式,則表示“本月最后一個(gè)星期五”
• W 表示離指定日期的最近那個(gè)工作日(周一至周五). 例如在日字段上置”15W”，表示離每月15號(hào)最近的那個(gè)工作日觸發(fā)。如果15號(hào)正好是周六，則找最近的周五(14號(hào))觸發(fā), 如果15號(hào)是周未，則找最近的下周一(16號(hào))觸發(fā).如果15號(hào)正好在工作日(周一至周五)，則就在該天觸發(fā)。如果指定格式為 “1W”,它則表示每月1號(hào)往后最近的工作日觸發(fā)。如果1號(hào)正是周六，則將在3號(hào)下周一觸發(fā)。(注，”W”前只能設(shè)置具體的數(shù)字,不允許區(qū)間”-“)。
• # 序號(hào)(表示每月的第幾個(gè)周幾)，例如在周字段上設(shè)置”6#3”表示在每月的第三個(gè)周六.注意如果指定”#5”,正好第五周沒有周六，則不會(huì)觸發(fā)該配置(用在母親節(jié)和父親節(jié)再合適不過了) ；小提示：’L’和 ‘W’可以一組合使用。如果在日字段上設(shè)置”LW”,則表示在本月的最后一個(gè)工作日觸發(fā)；周字段的設(shè)置，若使用英文字母是不區(qū)分大小寫的，即MON與mon相同。

示例

每隔5秒執(zhí)行一次：/5 * ?

每隔1分鐘執(zhí)行一次：0 /1 ?

每天23點(diǎn)執(zhí)行一次：0 0 23 ?

每天凌晨1點(diǎn)執(zhí)行一次：0 0 1 ?

每月1號(hào)凌晨1點(diǎn)執(zhí)行一次：0 0 1 1 * ?

每月最后一天23點(diǎn)執(zhí)行一次：0 0 23 L * ?

每周星期天凌晨1點(diǎn)實(shí)行一次：0 0 1 ? * L

在26分、29分、33分執(zhí)行一次：0 26,29,33 * ?

每天的0點(diǎn)、13點(diǎn)、18點(diǎn)、21點(diǎn)都執(zhí)行一次：0 0 0,13,18,21 ?

cron表達(dá)式使用占位符

另外，cron屬性接收的cron表達(dá)式支持占位符。eg：

配置文件：

time:
  cron: */5 * * * * *
  interval: 5

每5秒執(zhí)行一次：

@Scheduled(cron="${time.cron}")
void testPlaceholder1() {
  System.out.println("Execute at " + System.currentTimeMillis());
}

@Scheduled(cron="*/${time.interval} * * * * *")
void testPlaceholder2() {
  System.out.println("Execute at " + System.currentTimeMillis());
}

2. zone

時(shí)區(qū)，接收一個(gè)java.util.TimeZone#ID。cron表達(dá)式會(huì)基于該時(shí)區(qū)解析。默認(rèn)是一個(gè)空字符串，即取服務(wù)器所在地的時(shí)區(qū)。比如我們一般使用的時(shí)區(qū)Asia/Shanghai。該字段我們一般留空。

3. fixedDelay

上一次執(zhí)行完畢時(shí)間點(diǎn)之后多長時(shí)間再執(zhí)行。如：

@Scheduled(fixedDelay = 5000) //上一次執(zhí)行完畢時(shí)間點(diǎn)之后5秒再執(zhí)行

4. fixedDelayString

與 fixedDelay 意思相同，只是使用字符串的形式，唯一不同的是支持占位符。如：

@Scheduled(fixedDelayString = "5000") //上一次執(zhí)行完畢時(shí)間點(diǎn)之后5秒再執(zhí)行

占位符的使用(配置文件中有配置：time.fixedDelay=5000)：

@Scheduled(fixedDelayString = "${time.fixedDelay}")
void testFixedDelayString() {
  System.out.println("Execute at " + System.currentTimeMillis());
}

5. fixedRate

上一次開始執(zhí)行時(shí)間點(diǎn)之后多長時(shí)間再執(zhí)行。如：

@Scheduled(fixedRate = 5000) //上一次開始執(zhí)行時(shí)間點(diǎn)之后5秒再執(zhí)行

6. fixedRateString

與 fixedRate 意思相同，只是使用字符串的形式，唯一不同的是支持占位符。

7. initialDelay

第一次延遲多長時(shí)間后再執(zhí)行。如：

@Scheduled(initialDelay=1000, fixedRate=5000) //第一次延遲1秒后執(zhí)行，之后按fixedRate的規(guī)則每5秒執(zhí)行一次

8. initialDelayString

與 initialDelay 意思相同，只是使用字符串的形式，唯一不同的是支持占位符。

三、API調(diào)用

通過注解的方式配置定時(shí)任務(wù)，該任務(wù)調(diào)度規(guī)則即在開發(fā)時(shí)就被確定下來了。

但很多時(shí)候，我們需要能夠在運(yùn)行時(shí)動(dòng)態(tài)創(chuàng)建任務(wù)。

Spring內(nèi)部實(shí)際是創(chuàng)建了一個(gè)ThreadPoolTaskScheduler對(duì)象，并注冊(cè)為spring bean。

注解配置的任務(wù)最終都會(huì)被提交到ThreadPoolTaskScheduler進(jìn)行調(diào)度執(zhí)行。

ThreadPoolTaskScheduler實(shí)現(xiàn)了TaskScheduler接口，我們可以注入TaskScheduler，使用API調(diào)用的方式動(dòng)態(tài)的創(chuàng)建任務(wù)。

@Autowired
private TaskScheduler taskScheduler;

TaskScheduler接口中聲明了如下方法：

1.調(diào)度任務(wù)

ScheduledFuture<?> schedule(Runnable task, Trigger trigger)：按觸發(fā)器規(guī)則調(diào)度任務(wù)

2.調(diào)度一次性任務(wù)

• ScheduledFuture<?> schedule(Runnable task, Instant startTime)：在指定時(shí)間點(diǎn)startTime執(zhí)行一次性任務(wù)
• ScheduledFuture<?> schedule(Runnable task, Date startTime)：在指定時(shí)間點(diǎn)startTime執(zhí)行一次性任務(wù)

3.調(diào)度固定速率的可重復(fù)執(zhí)行任務(wù)

• ScheduledFuture<?> scheduleAtFixedRate(Runnable task, Instant startTime, Duration period)：在指定時(shí)間點(diǎn)開始執(zhí)行任務(wù)，每隔period執(zhí)行一次
• ScheduledFuture<?> scheduleAtFixedRate(Runnable task, Date startTime, long period)：在指定時(shí)間點(diǎn)開始執(zhí)行任務(wù)，每隔period毫秒執(zhí)行一次
• ScheduledFuture<?> scheduleAtFixedRate(Runnable task, Duration period)：每隔period執(zhí)行一次
• ScheduledFuture<?> scheduleAtFixedRate(Runnable task, long period)：每隔period毫秒執(zhí)行一次

4.調(diào)度固定延時(shí)的可重復(fù)執(zhí)行任務(wù)

• ScheduledFuture<?> scheduleWithFixedDelay(Runnable task, Instant startTime, Duration delay)：在指定時(shí)間點(diǎn)開始執(zhí)行任務(wù)，每隔delay執(zhí)行一次
• ScheduledFuture<?> scheduleWithFixedDelay(Runnable task, Date startTime, long delay)：在指定時(shí)間點(diǎn)開始執(zhí)行任務(wù)，每隔delay毫秒執(zhí)行一次
• ScheduledFuture<?> scheduleWithFixedDelay(Runnable task, Duration delay)：每隔delay執(zhí)行一次
• ScheduledFuture<?> scheduleWithFixedDelay(Runnable task, long delay)：每隔delay毫秒執(zhí)行一次

觸發(fā)器Trigger接口具有兩種實(shí)現(xiàn)：CronTrigger和PeriodicTrigger。

PeriodicTrigger：

//  設(shè)定每2秒執(zhí)行一次
PeriodicTrigger periodicTrigger = new PeriodicTrigger(2, TimeUnit.SECONDS);
//  初始延遲時(shí)間
periodicTrigger.setInitialDelay(5000);
//  設(shè)置true為固定速率，false為固定延時(shí)
periodicTrigger.setFixedRate(true);
taskScheduler.schedule(() -> System.out.println("hello"), periodicTrigger);

CronTrigger：

CronTrigger cronTrigger = new CronTrigger("1/5 * * * * ?");
taskScheduler.schedule(() -> System.out.println("hello"), cronTrigger);

四、線程池參數(shù)

springboot對(duì)于spring-task默認(rèn)是創(chuàng)建了一個(gè)線程數(shù)為1的線程池。

可以通過配置文件對(duì)線程參數(shù)進(jìn)行調(diào)整。

spring:
	task:
  	scheduling:
    	thread-name-prefix: scheduling-
    	pool:
      	size: 1

如果想更深度定制線程池，也可以自己實(shí)現(xiàn)TaskScheduler接口，并注冊(cè)為Bean：

@Bean
public TaskScheduler taskScheduler() {
    return new TaskSchedulerImpl();
}

五、調(diào)度效果

springboot內(nèi)部是自動(dòng)創(chuàng)建了一個(gè)ThreadPoolTaskScheduler對(duì)象，它實(shí)現(xiàn)了TaskScheduler接口，該類內(nèi)部是使用了ScheduledExecutorService，因此任務(wù)調(diào)度的效果可參考ScheduledExecutorService文章。

不過經(jīng)過了spring的封裝，還是有部分與ScheduledExecutorService有區(qū)別。

區(qū)別1：@Scheduled注解方法執(zhí)行時(shí)拋出異常，不會(huì)導(dǎo)致線程終止，不影響任務(wù)的下一次執(zhí)行

spring-task對(duì)于任務(wù)執(zhí)行，進(jìn)行了統(tǒng)一的try catch，并設(shè)置了ErrorHandler進(jìn)行錯(cuò)誤日志打印。

區(qū)別2：Spring-Task擴(kuò)展了對(duì)CRON的支持，其對(duì)任務(wù)耗時(shí)超過間隔時(shí)間的處理方式與固定延時(shí)相同

以上就是Spring-Task定時(shí)任務(wù)的使用介紹的詳細(xì)內(nèi)容，更多關(guān)于Spring-Task定時(shí)任務(wù)的資料請(qǐng)關(guān)注腳本之家其它相關(guān)文章！

最新評(píng)論