spring-task使用介绍

简介: 目前springboot应用广泛,因此对于spring-task直接基于springboot框架介绍,不涉及xml配置。本文直接介绍spring-task的使用方法,涉及的相关基础知识不再赘述,请先阅读Timer和ScheduledExecutorService的相关文章。

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

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

1. Timer使用介绍
1. ScheduledExecutorService使用介绍

一、基本使用

这里以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),单位毫秒

二、@Scheduled属性详解

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

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 _ ?
每隔1分钟执行一次:0 /1 ?
每天23点执行一次:0 0 23
?
每天凌晨1点执行一次:0 0 1 ?
每月1号凌晨1点执行一次:0 0 1 1
?
每月最后一天23点执行一次:0 0 23 L ?
每周星期天凌晨1点实行一次:0 0 1 ?
L
在26分、29分、33分执行一次:0 26,29,33 * ?
每天的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());
}

2. zone

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

3. fixedDelay

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

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

4. fixedDelayString

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

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

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

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

5. fixedRate

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

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

6. fixedRateString

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

7. initialDelay

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

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

8. initialDelayString

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

三、API调用

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

四、线程池参数

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

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

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

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

五、调度效果

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

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

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

目录
相关文章
|
12天前
|
监控 Java C#
Spring Event 的介绍
Spring Event 是 Spring 框架中的事件驱动机制,允许组件间进行同步或异步消息传递,无需直接依赖。它包括事件(Event)、事件发布者(Publisher)和事件监听器(Listener),通过 `ApplicationEventPublisher` 广播事件,实现松耦合通信,增强模块化和可维护性。Spring 还提供了多种内置事件,如 `ContextRefreshedEvent` 和 `ContextClosedEvent`,支持同步及异步处理,并具备良好的扩展性。
|
3月前
|
Java 调度 开发者
Spring Task
Spring Task
23 0
|
3月前
|
Java Spring 容器
Spring中的SmartLifecycle与Lifecycle
Spring中的SmartLifecycle与Lifecycle
|
4月前
|
Java API 调度
定时任务spring task
定时任务是自动化处理任务的关键,常见于电商平台的优惠券发放、银行的还款提醒、财务系统的每日结算和火车票定时放票等场景。实现方式包括多线程结合sleep、JDK的Timer和ScheduledExecutor,以及Quartz和Spring Task等框架。Cron表达式用于设定任务执行的时间规则,由7部分组成,表示秒、分、时、日、月、周和年,并可使用特殊符号如*、?、-、/等来设定更灵活的定时规则。
68 9
|
4月前
|
Java Spring
定时任务schedule(spring boot )
定时任务schedule(spring boot )
77 0
|
4月前
|
设计模式 前端开发 Java
[Spring ~源码] Spring的run方法以及SpringMVC执行流程
[Spring ~源码] Spring的run方法以及SpringMVC执行流程
|
4月前
|
Java 调度 Spring
Spring Task使用介绍
Spring Task使用介绍
82 0
|
11月前
|
Java 测试技术 Spring
Spring Boot + @Async =?
Spring Boot + @Async =?
42 0
|
Java 数据库 Spring
基于Spring Task的Spring定时任务
基于Spring Task的Spring定时任务
|
消息中间件 缓存 监控
spring-boot-route(二十)Spring Task实现简单定时任务
spring-boot-route(二十)Spring Task实现简单定时任务
129 0