java

关注公众号 jb51net

关闭
首页 > 软件编程 > java > Spring-Task定时任务

Spring-Task定时任务的使用介绍

作者:UnicornLien

目前springboot应用广泛,因此对于spring-task直接基于springboot框架介绍,不涉及xml配置。本文直接介绍spring-task的使用方法,需要的可以参考一下

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

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

Timer参考:Java Timer使用讲解

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

一、基本使用

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

@EnableScheduling
public class ApiAutoConfiguration {
}

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

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

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

二、@Scheduled属性详解

我们可以直接使用注解@Scheduled添加到方法上,spring会将按照注解属性的规则定时的执行该方法。

以下参数cron/fixedDelay/fixedRate三个属性必须且只能出现一个。

1. cron

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

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

cron表达式语法

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

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

序号说明必填允许填写的值允许的通配符
10-59, - * /
20-59, - * /
30-23, - * /
41-31, - * ? / L W
51-12 / JAN-DEC, - * /
61-7 or SUN-SAT, - * ? / L #
71970-2099, - * /

通配符说明:

示例

每隔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接口中声明了如下方法:

1.调度任务

ScheduledFuture<?> schedule(Runnable task, Trigger trigger):按触发器规则调度任务

2.调度一次性任务

3.调度固定速率的可重复执行任务

4.调度固定延时的可重复执行任务

触发器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的支持,其对任务耗时超过间隔时间的处理方式与固定延时相同

以上就是Spring-Task定时任务的使用介绍的详细内容,更多关于Spring-Task定时任务的资料请关注脚本之家其它相关文章!

您可能感兴趣的文章:
阅读全文