Spring-Task介绍

目前springboot应用广泛,因此对于spring-task直接基于springboot框架介绍,不涉及xml配置。

本文直接介绍spring-task的使用方法,涉及的相关基础知识不再赘述,请先阅读Timer和ScheduledExecutorService的相关文章。

1. Timer使用介绍<br />1. ScheduledExecutorService使用介绍

<a name="HMeo5"></a>

一、基本使用

这里以ladderx-scaffold的源码作为案例,使用spring-task,需要先使用@EnableScheduling开启定时任务。

@EnableScheduling
public class ApiAutoConfiguration {
}

当要创建一个定时任务时,@Scheduled可以直接注解在无返回值无参数方法上,表示该方法根据注解的规则定时执行。

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

@Scheduled注解主要支持三种方式:

  1. cron方式:@Scheduled(cron = "0 0 2 * * ? ")
  2. 固定速率:@Scheduled(initialDelay = 5000, fixedDelay = 2000),单位毫秒
  3. 固定延时:@Scheduled(initialDelay = 5000, fixedRate = 2000),单位毫秒
    <a name="wBOPT"></a>

二、@Scheduled属性详解

我们可以直接使用注解@Scheduled添加到方法上,spring会将按照注解属性的规则定时的执行该方法。<br />以下参数cron/fixedDelay/fixedRate三个属性必须且只能出现一个。

<a name="q4GgW"></a>

1. cron

该参数接收一个cron表达式cron表达式是一个字符串,字符串以5或6个空格隔开,分开共6或7个域,每一个域代表一个含义。

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

cron表达式语法

[秒] [分] [小时] [日] [月] [周] [年]

注:[年]不是必须的域,可以省略[年],则一共6个域

序号 说明 必填 允许填写的值 允许的通配符
1 0-59 , - * /
2 0-59 , - * /
3 0-23 , - * /
4 1-31 , - * ? / L W
5 1-12 / JAN-DEC , - * /
6 1-7 or SUN-SAT , - * ? / L #
7 1970-2099 , - * /

通配符说明:

  • * 表示所有值。 例如:在分的字段上设置 *,表示每一分钟都会触发。
  • ? 表示不指定值。使用的场景为不需要关心当前设置这个字段的值。例如:要在每月的10号触发一个操作,但不关心是周几,所以需要周位置的那个字段设置为”?” 具体设置为 0 0 0 10 * ?
  • - 表示区间。例如 在小时上设置 “10-12”,表示 10,11,12点都会触发。
  • , 表示指定多个值,例如在周字段上设置 “MON,WED,FRI” 表示周一,周三和周五触发
  • / 用于递增触发。如在秒上面设置”5/15” 表示从5秒开始,每增15秒触发(5,20,35,50)。 在月字段上设置’1/3’所示每月1号开始,每隔三天触发一次。
  • L 表示最后的意思。在日字段设置上,表示当月的最后一天(依据当前月份,如果是二月还会依据是否是润年[leap]), 在周字段上表示星期六,相当于”7”或”SAT”。如果在”L”前加上数字,则表示该数据的最后一个。例如在周字段上设置”6L”这样的格式,则表示“本月最后一个星期五”
  • W 表示离指定日期的最近那个工作日(周一至周五). 例如在日字段上置”15W”,表示离每月15号最近的那个工作日触发。如果15号正好是周六,则找最近的周五(14号)触发, 如果15号是周未,则找最近的下周一(16号)触发.如果15号正好在工作日(周一至周五),则就在该天触发。如果指定格式为 “1W”,它则表示每月1号往后最近的工作日触发。如果1号正是周六,则将在3号下周一触发。(注,”W”前只能设置具体的数字,不允许区间”-“)。
  • # 序号(表示每月的第几个周几),例如在周字段上设置”6#3”表示在每月的第三个周六.注意如果指定”#5”,正好第五周没有周六,则不会触发该配置(用在母亲节和父亲节再合适不过了) ;小提示:’L’和 ‘W’可以一组合使用。如果在日字段上设置”LW”,则表示在本月的最后一个工作日触发;周字段的设置,若使用英文字母是不区分大小写的,即MON与mon相同。

示例

每隔5秒执行一次:_/5 _ _ _ * ?<br />每隔1分钟执行一次:0 _/1 _ _ _ ?<br />每天23点执行一次:0 0 23 _ _ ?<br />每天凌晨1点执行一次:0 0 1 _ _ ?<br />每月1号凌晨1点执行一次:0 0 1 1 * ?<br />每月最后一天23点执行一次:0 0 23 L * ?<br />每周星期天凌晨1点实行一次:0 0 1 ? * L<br />在26分、29分、33分执行一次:0 26,29,33 _ _ * ?<br />每天的0点、13点、18点、21点都执行一次:0 0 0,13,18,21 _ _ ?

cron表达式使用占位符

另外,cron属性接收的cron表达式支持占位符。eg:

配置文件:

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

每5秒执行一次:

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

<a name="afzGl"></a>

2. zone

时区,接收一个java.util.TimeZone#IDcron表达式会基于该时区解析。默认是一个空字符串,即取服务器所在地的时区。比如我们一般使用的时区Asia/Shanghai。该字段我们一般留空。

<a name="Pvb62"></a>

3. fixedDelay

上一次执行完毕时间点之后多长时间再执行。如:

@Scheduled(fixedDelay = 5000) //上一次执行完毕时间点之后5秒再执行

<a name="CuGqJ"></a>

4. fixedDelayString

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

@Scheduled(fixedDelayString = "5000") //上一次执行完毕时间点之后5秒再执行

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

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

<a name="zpyo1"></a>

5. fixedRate

上一次开始执行时间点之后多长时间再执行。如:

@Scheduled(fixedRate = 5000) //上一次开始执行时间点之后5秒再执行

<a name="FZ8Do"></a>

6. fixedRateString

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

<a name="fjjTx"></a>

7. initialDelay

第一次延迟多长时间后再执行。如:

@Scheduled(initialDelay=1000, fixedRate=5000) //第一次延迟1秒后执行,之后按fixedRate的规则每5秒执行一次

<a name="pM0vX"></a>

8. initialDelayString

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

<a name="uT1RR"></a>

三、API调用

通过注解的方式配置定时任务,该任务调度规则即在开发时就被确定下来了。<br />但很多时候,我们需要能够在运行时动态创建任务。<br />Spring内部实际是创建了一个ThreadPoolTaskScheduler对象,并注册为spring bean。<br />注解配置的任务最终都会被提交到ThreadPoolTaskScheduler进行调度执行。

ThreadPoolTaskScheduler实现了TaskScheduler接口,我们可以注入TaskScheduler,使用API调用的方式动态的创建任务。

@Autowired
private TaskScheduler taskScheduler;

TaskScheduler接口中声明了如下方法:

  • 调度任务
    • ScheduledFuture<?> schedule(Runnable task, Trigger trigger):按触发器规则调度任务
  • 调度一次性任务
    • ScheduledFuture<?> schedule(Runnable task, Instant startTime):在指定时间点startTime执行一次性任务
    • ScheduledFuture<?> schedule(Runnable task, Date startTime):在指定时间点startTime执行一次性任务
  • 调度固定速率的可重复执行任务
    • ScheduledFuture<?> scheduleAtFixedRate(Runnable task, Instant startTime, Duration period):在指定时间点开始执行任务,每隔period执行一次
    • ScheduledFuture<?> scheduleAtFixedRate(Runnable task, Date startTime, long period):在指定时间点开始执行任务,每隔period毫秒执行一次
    • ScheduledFuture<?> scheduleAtFixedRate(Runnable task, Duration period):每隔period执行一次
    • ScheduledFuture<?> scheduleAtFixedRate(Runnable task, long period):每隔period毫秒执行一次
  • 调度固定延时的可重复执行任务
    • ScheduledFuture<?> scheduleWithFixedDelay(Runnable task, Instant startTime, Duration delay):在指定时间点开始执行任务,每隔delay执行一次
    • ScheduledFuture<?> scheduleWithFixedDelay(Runnable task, Date startTime, long delay):在指定时间点开始执行任务,每隔delay毫秒执行一次
    • ScheduledFuture<?> scheduleWithFixedDelay(Runnable task, Duration delay):每隔delay执行一次
    • ScheduledFuture<?> scheduleWithFixedDelay(Runnable task, long delay):每隔delay毫秒执行一次

触发器Trigger接口具有两种实现:CronTrigger和PeriodicTrigger。

PeriodicTrigger:

//  设定每2秒执行一次
PeriodicTrigger periodicTrigger = new PeriodicTrigger(2, TimeUnit.SECONDS);
//  初始延迟时间
periodicTrigger.setInitialDelay(5000);
//  设置true为固定速率,false为固定延时
periodicTrigger.setFixedRate(true);
taskScheduler.schedule(() -> System.out.println("hello"), periodicTrigger);

CronTrigger:

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

<a name="zts1x"></a>

四、线程池参数

springboot对于spring-task默认是创建了一个线程数为1的线程池。<br />可以通过配置文件对线程参数进行调整。

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

如果想更深度定制线程池,也可以自己实现TaskScheduler接口,并注册为Bean:

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

<a name="d6Bk3"></a>

五、调度效果

springboot内部是自动创建了一个ThreadPoolTaskScheduler对象,它实现了TaskScheduler接口,该类内部是使用了ScheduledExecutorService,因此任务调度的效果可参考ScheduledExecutorService文章。<br />不过经过了spring的封装,还是有部分与ScheduledExecutorService有区别。

区别1:@Scheduled注解方法执行时抛出异常,不会导致线程终止,不影响任务的下一次执行<br />spring-task对于任务执行,进行了统一的try catch,并设置了ErrorHandler进行错误日志打印。

区别2:Spring-Task扩展了对CRON的支持,其对任务耗时超过间隔时间的处理方式与固定延时相同

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 194,242评论 5 459
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 81,769评论 2 371
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 141,484评论 0 319
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 52,133评论 1 263
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 61,007评论 4 355
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 46,080评论 1 272
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 36,496评论 3 381
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 35,190评论 0 253
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 39,464评论 1 290
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 34,549评论 2 309
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 36,330评论 1 326
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,205评论 3 312
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 37,567评论 3 298
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 28,889评论 0 17
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,160评论 1 250
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 41,475评论 2 341
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 40,650评论 2 335

推荐阅读更多精彩内容