一剖踊、定時任務概述
后臺項目開發(fā)中經(jīng)常會用到定時任務,現(xiàn)在實現(xiàn)定時任務都方式也是多種多樣蛉加。下面列舉幾種常見的定時任務實現(xiàn)方式:
1. Quartz:Quartz的使用相當廣泛惜颇,它是一個功能強大的調(diào)度器,當然使用起來也相對麻煩妇蛀;
2. java.util包里的Timer耕突,它也可以實現(xiàn)定時任務但是功能過于單一所有使用很少。
3. 就是我們今天要介紹的Spring自帶的定時任務Schedule评架,其實可以把它看作是一個簡化版的眷茁,輕量級的Quartz,使用起來也相對方便很多纵诞。
二上祈、實現(xiàn)定時任務
1. 創(chuàng)建定時任務
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.scheduling.annotation.Scheduled;
import org.springframework.stereotype.Component;
/**
* Description: 構(gòu)建執(zhí)行定時任務
* 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表示當前方法執(zhí)行完畢5000ms后,Spring scheduling會再次調(diào)用該方法
public void testFixDelay() {
logger.info("===fixedDelay: 第{}次執(zhí)行方法", fixedDelayCount++);
}
@Scheduled(fixedRate = 5000) //fixedRate = 5000表示當前方法開始執(zhí)行5000ms后浙芙,Spring scheduling會再次調(diào)用該方法
public void testFixedRate() {
logger.info("===fixedRate: 第{}次執(zhí)行方法", fixedRateCount++);
}
@Scheduled(initialDelay = 1000, fixedRate = 5000) //initialDelay = 1000表示延遲1000ms執(zhí)行第一次任務
public void testInitialDelay() {
logger.info("===initialDelay: 第{}次執(zhí)行方法", initialDelayCount++);
}
@Scheduled(cron = "0 0/1 * * * ?") //cron接受cron表達式登刺,根據(jù)cron表達式確定定時規(guī)則
public void testCron() {
logger.info("===initialDelay: 第{}次執(zhí)行方法", cronCount++);
}
}
我們使用@Scheduled來創(chuàng)建定時任務 這個注解用來標注一個定時任務方法。通過看@Scheduled源碼可以看出它支持多種參數(shù):
(1)cron:cron表達式嗡呼,指定任務在特定時間執(zhí)行纸俭;
(2)fixedDelay:表示上一次任務執(zhí)行完成后多久再次執(zhí)行,參數(shù)類型為long晤锥,單位ms掉蔬;
(3)fixedDelayString:與fixedDelay含義一樣,只是參數(shù)類型變?yōu)镾tring矾瘾;
(4)fixedRate:表示按一定的頻率執(zhí)行任務女轿,參數(shù)類型為long,單位ms壕翩;
(5)fixedRateString: 與fixedRate的含義一樣蛉迹,只是將參數(shù)類型變?yōu)镾tring;
(6)initialDelay:表示延遲多久再第一次執(zhí)行任務放妈,參數(shù)類型為long北救,單位ms;
(7)initialDelayString:與initialDelay的含義一樣芜抒,只是將參數(shù)類型變?yōu)镾tring珍策;
(8)zone:時區(qū),默認為當前時區(qū)宅倒,一般沒有用到
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 注解攘宙,它的作用是發(fā)現(xiàn)注解@Scheduled的任務并由后臺執(zhí)行。沒有它的話將無法執(zhí)行定時任務。
引用官方文檔原文:
[`@EnableScheduling`](http://docs.spring.io/spring/docs/current/spring-framework-reference/htmlsingle/#scheduling-enable-annotation-support) ensures that a background task executor is created. Without it, nothing gets scheduled.
3. 執(zhí)行結(jié)果 (單線程)
到此我們就完成了一個簡單的定時任務模型蹭劈,下面執(zhí)行springBoot觀察執(zhí)行結(jié)果疗绣。
2017-08-11 12:06:19.738 INFO 52252 --- [pool-1-thread-1] com.test.ScheduledTasks : ===initialDelay: 第1次執(zhí)行方法
2017-08-11 12:06:23.739 INFO 52252 --- [pool-1-thread-1] com.test.ScheduledTasks : ===fixedRate: 第2次執(zhí)行方法
2017-08-11 12:06:23.739 INFO 52252 --- [pool-1-thread-1] com.test.ScheduledTasks : ===fixedDelay: 第2次執(zhí)行方法
2017-08-11 12:06:24.738 INFO 52252 --- [pool-1-thread-1] com.test.ScheduledTasks : ===initialDelay: 第2次執(zhí)行方法
2017-08-11 12:06:28.739 INFO 52252 --- [pool-1-thread-1] com.test.ScheduledTasks : ===fixedRate: 第3次執(zhí)行方法
2017-08-11 12:06:28.740 INFO 52252 --- [pool-1-thread-1] com.test.ScheduledTasks : ===fixedDelay: 第3次執(zhí)行方法
2017-08-11 12:06:29.739 INFO 52252 --- [pool-1-thread-1] com.test.ScheduledTasks : ===initialDelay: 第3次執(zhí)行方法
2017-08-11 12:06:33.735 INFO 52252 --- [pool-1-thread-1] com.test.ScheduledTasks : ===fixedRate: 第4次執(zhí)行方法
2017-08-11 12:06:33.741 INFO 52252 --- [pool-1-thread-1] com.test.ScheduledTasks : ===fixedDelay: 第4次執(zhí)行方法
2017-08-11 12:06:34.738 INFO 52252 --- [pool-1-thread-1] com.test.ScheduledTasks : ===initialDelay: 第4次執(zhí)行方法
從控制臺輸入的結(jié)果中我們可以看出所有的定時任務都是在同一個線程池用同一個線程來處理的,那么我們?nèi)绾蝸聿l(fā)的處理各定時任務呢铺韧,請繼續(xù)向下看多矮。
4. 多線程處理定時任務
看到控制臺輸出的結(jié)果,所有的定時任務都是通過一個線程來處理的哈打,我估計是在定時任務的配置中設定了一個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());
}
}
這樣問題就很簡單了,我們只需用調(diào)用這個方法顯式的設置一個ScheduledExecutorService就可以達到并發(fā)的效果了丙挽。我們要做的僅僅是實現(xiàn)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: 多線程執(zhí)行定時任務
* 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()凳怨,但是最后失敗了瑰艘,不知道是否可以通過這個類實現(xiàn)定時任務的并發(fā),如果有實現(xiàn)了的也請告訴大家一下方法肤舞。
5. 執(zhí)行結(jié)果(并發(fā))
2017-08-11 12:21:16.000 INFO 52284 --- [pool-1-thread-3] com.test.ScheduledTasks : ===initialDelay: 第1次執(zhí)行方法
2017-08-11 12:21:19.998 INFO 52284 --- [pool-1-thread-4] com.test.ScheduledTasks : ===fixedRate: 第2次執(zhí)行方法
2017-08-11 12:21:19.998 INFO 52284 --- [pool-1-thread-1] com.test.ScheduledTasks : ===fixedDelay: 第2次執(zhí)行方法
2017-08-11 12:21:20.999 INFO 52284 --- [pool-1-thread-4] com.test.ScheduledTasks : ===initialDelay: 第2次執(zhí)行方法
2017-08-11 12:21:25.000 INFO 52284 --- [pool-1-thread-2] com.test.ScheduledTasks : ===fixedRate: 第3次執(zhí)行方法
2017-08-11 12:21:25.000 INFO 52284 --- [pool-1-thread-6] com.test.ScheduledTasks : ===fixedDelay: 第3次執(zhí)行方法
2017-08-11 12:21:25.997 INFO 52284 --- [pool-1-thread-3] com.test.ScheduledTasks : ===initialDelay: 第3次執(zhí)行方法
2017-08-11 12:21:30.000 INFO 52284 --- [pool-1-thread-7] com.test.ScheduledTasks : ===fixedRate: 第4次執(zhí)行方法
2017-08-11 12:21:30.000 INFO 52284 --- [pool-1-thread-8] com.test.ScheduledTasks : ===fixedDelay: 第4次執(zhí)行方法
2017-08-11 12:21:31.000 INFO 52284 --- [pool-1-thread-7] com.test.ScheduledTasks : ===initialDelay: 第4次執(zhí)行方法
通過控制臺輸出的結(jié)果看出每個定時任務都是在通過不同的線程來處理了紫新。
三、cron詳解
1. cron表達式定義
Cron表達式是一個字符串李剖,是由空格隔開的6或7個域組成芒率,每一個域?qū)粋€含義(秒 分 時 每月第幾天 月 星期 年)其中年是可選字段。
但是篙顺,此處敲一下黑板偶芍,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. 每個域可出現(xiàn)的字符類型和各字符的含義
(1)各域支持的字符類型
秒:可出現(xiàn)", - * /"四個字符,有效范圍為0-59的整數(shù)
分:可出現(xiàn)", - * /"四個字符宰僧,有效范圍為0-59的整數(shù)
時:可出現(xiàn)", - * /"四個字符材彪,有效范圍為0-23的整數(shù)
每月第幾天:可出現(xiàn)", - * / ? L W C"八個字符,有效范圍為0-31的整數(shù)
月:可出現(xiàn)", - * /"四個字符,有效范圍為1-12的整數(shù)或JAN-DEc
星期:可出現(xiàn)", - * / ? L C #"四個字符查刻,有效范圍為1-7的整數(shù)或SUN-SAT兩個范圍键兜。1表示星期天,2表示星期一穗泵, 依次類推
(2)特殊字符含義
* : 表示匹配該域的任意值普气,比如在秒*, 就表示每秒都會觸發(fā)事件。佃延;
? : 只能用在每月第幾天和星期兩個域现诀。表示不指定值,當2個子表達式其中之一被指定了值以后履肃,為了避免沖突仔沿,需要將另一個子表達式的值設為“?”;
- : 表示范圍尺棋,例如在分域使用5-20封锉,表示從5分到20分鐘每分鐘觸發(fā)一次
/ : 表示起始時間開始觸發(fā),然后每隔固定時間觸發(fā)一次膘螟,例如在分域使用5/20,則意味著5分成福,25分,45分荆残,分別觸發(fā)一次.
, : 表示列出枚舉值奴艾。例如:在分域使用5,20,則意味著在5和20分時觸發(fā)一次内斯。
L : 表示最后蕴潦,只能出現(xiàn)在星期和每月第幾天域,如果在星期域使用1L,意味著在最后的一個星期日觸發(fā)俘闯。
W : 表示有效工作日(周一到周五),只能出現(xiàn)在每月第幾日域潭苞,系統(tǒng)將在離指定日期的最近的有效工作日觸發(fā)事件。注意一點备徐,W的最近尋找不會跨過月份
LW : 這兩個字符可以連用萄传,表示在某個月最后一個工作日,即最后一個星期五蜜猾。
# : 用于確定每個月第幾個星期幾秀菱,只能出現(xiàn)在每月第幾天域。例如在1#3蹭睡,表示某月的第三個星期日衍菱。
(3)表達式例子
引用spring官方注釋:
* <p>Example patterns:
* <ul>
* <li>"0 0 * * * *" = the top of every hour of every day.</li>
* <li>"*/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秒執(zhí)行一次
" */10 * * * * *" 表示每10秒執(zhí)行一次
"0 0 8-10 * * *" 表示每天8,9肩豁,10點執(zhí)行
"0 0/30 8-10 * * *" 表示每天8點到10點脊串,每半小時執(zhí)行
"0 0 9-17 * * MON-FRI" 表示每周一至周五辫呻,9點到17點的0分0秒執(zhí)行
"0 0 0 25 12 ?" 表示每年圣誕節(jié)(12月25日)0時0分0秒執(zhí)行