pkslow.com 南瓜慢说

  • AllArticles
  • Container
  • Spring
  • Life
  • Cloud
  • Collections
  • About
  • GitHub

  • Search
Terraform101 English Terraform Middleware config Go Private Kubernetes pkslow Test HTTPS Redis Docker Mac Plan Stream MongoDB Spring DevOps JVM String Map Set List Performance Email Springboot JavaCollections ArrayList Java

Spring的定时任务注解@Scheduled原来如此简单

Created on: 2019-11-19 | Category: Springboot | 0 | View: 501

1 简介

定时任务的实现非常多,JDK的Timer、Spring提供的轻量级的Scheduled Task、QuartZ和Linux Cron等,还有一些分布式的任务调度框架。本文主要介绍Scheduled Task的使用。

2 方便的4种方式

注解@Scheduled只能用于满足下面两个条件的方法上:

(1)没有返回类型,或者说返回类型为void;

(2)没有参数;

开启Spring的Scheduler非常简单,一个注解@EnableScheduling即可:

@Configuration
@EnableScheduling
public class SchedulingConfig {
}

如果是Springboot应用,则直接在启动类上面加上@EnableScheduling就可以使用了。

2.1 固定延迟fixedDelay

代表下一个任务的开始与上一个任务的结束间隔总是固定的时长,而且总是会等上一个任务完成了,才会开启下一个任务。如果需求是有这样依赖要求的,使用这种模式是非常合适的。代码如下:

@Scheduled(fixedDelay = 1000)
public void fixedDelay() {
  log.info("fixedDelay");
}

参数为1000,代表固定延迟为1000毫秒,即1秒钟,所以输出为:

2019-11-19 21:02:43,977 scheduling-1:fixedDelay 
2019-11-19 21:02:44,981 scheduling-1:fixedDelay 
2019-11-19 21:02:45,983 scheduling-1:fixedDelay 
2019-11-19 21:02:46,984 scheduling-1:fixedDelay 

2.2 固定频率fixedRate

2.2.1 正常情况

定频任务的特性是任务的执行的时间间隔总是一样的。比如每1小时执行一次,就是任务执行开始的时间点的时间间隔为1小时。代码如下:

@Scheduled(fixedRate = 2000)
public void fixedRate() {
  log.info("fixedRate");
}

参数为2000,则每2秒执行一次,输出为:

2019-11-19 21:38:45,073 scheduling-1:fixedRate 
2019-11-19 21:38:47,076 scheduling-1:fixedRate 
2019-11-19 21:38:49,073 scheduling-1:fixedRate 
2019-11-19 21:38:51,075 scheduling-1:fixedRate 

2.2.2 默认单线程

需要注意的是它默认是单线程的,不会并行执行。即使是固定频率,但下一次的任务也必须等到上一次任务执行完毕才会开始。下面这个例子能很好说明:

@Scheduled(fixedRate = 1000)
public void fixedRateLongTimeTask() throws InterruptedException {
  log.info("fixedRateLongTimeTask");
  Thread.sleep(3000);
}

由于任务需要执行3秒才能完成,即使fixedRate设置为1秒,并不能每一秒执行一次,输出如下:

2019-11-19 21:46:00,108 scheduling-1:fixedRateLongTimeTask 
2019-11-19 21:46:03,113 scheduling-1:fixedRateLongTimeTask 
2019-11-19 21:46:06,113 scheduling-1:fixedRateLongTimeTask 
2019-11-19 21:46:09,117 scheduling-1:fixedRateLongTimeTask 

每3次输出一次。

2.2.3 注解@Async来帮你

上述问题有办法解决吗?答案是肯定的,而且非常简单。只需要加一个注解@Async就可以使任务能异步多线程地执行了,代码如下:

@Async
@Scheduled(fixedRate = 1000)
public void fixedRateLongTimeTask() throws InterruptedException {
  log.info("fixedRateLongTimeTask");
  Thread.sleep(3000);
}

通过日志可以看出是每秒执行一次的,即使前面的任务还没有完成。而且线程名不一样,通过多线程来执行,输出结果为:

2019-11-19 21:54:22,261 task-5:fixedRateLongTimeTask 
2019-11-19 21:54:23,257 task-6:fixedRateLongTimeTask 
2019-11-19 21:54:24,257 task-4:fixedRateLongTimeTask 
2019-11-19 21:54:25,257 task-8:fixedRateLongTimeTask 
2019-11-19 21:54:26,259 task-1:fixedRateLongTimeTask 
2019-11-19 21:54:27,262 task-2:fixedRateLongTimeTask 
2019-11-19 21:54:28,260 task-3:fixedRateLongTimeTask 

注意:需要指出的是,需要像@EnableScheduling一样,需要添加配置注解@EnableAsync来打开这个功能开关。另外,如果任务执行时间很长,例如1分钟,情况又不一样。以后再详细介绍@Async的使用吧。

2.3 初始延迟initialDelay

初始延迟是用initialDelay来指定的,它可以延迟第一次任务执行的时间。如下例子的参数为30秒,则在启动30秒后,才开始执行第一次。可以减轻项目启动的负担,也可以为任务执行前准备数据。

@Scheduled(fixedDelay = 1000, initialDelay = 30*1000)
public void fixedDelayWithIntialDelay() {
  log.info("fixedDelayWithIntialDelay");
}

输出如下:

2019-11-19 22:10:02,092 main:Tomcat started on port(s): 443 (http) with context path '' 
2019-11-19 22:10:02,095 main:Started DemoApplication in 1.272 seconds (JVM running for 1.767) 
2019-11-19 22:10:32,063 scheduling-1:fixedDelayWithIntialDelay 
2019-11-19 22:10:33,067 scheduling-1:fixedDelayWithIntialDelay 
2019-11-19 22:10:34,069 scheduling-1:fixedDelayWithIntialDelay 
2019-11-19 22:10:35,069 scheduling-1:fixedDelayWithIntialDelay

可以看出,在项目启动后30秒左右,才开始执行任务。

2.4 Cron表达式

上述提供的功能并不能满足定时任务调度的所有需求,比如需要每个月1号发送短信,每周六做数据分析等。这里Cron表达式就派上用场了。

下面的例子表示每当秒数为06的时候就执行。代码如下:

@Scheduled(cron = "6 * * ? * *")
public void cron() {
  log.info("cron");
}

结果如下:

2019-11-19 22:20:06,003 scheduling-1:cron 
2019-11-19 22:21:06,004 scheduling-1:cron 
2019-11-19 22:22:06,002 scheduling-1:cron 

Cron表达式功能非常强大,网上资料很丰富,这里不展开讲了。

3 参数配置化

之前的例子都将参数写死在代码上了,如果需要更灵活,其实可以用参数来配置。这样需要修改参数的时候,不用修改代码、编译打包再部署了,直接修改配置文件即可。

代码如下:

@Scheduled(cron = "${pkslow.cron}")
public void cronWithConfig() {
  log.info("cronWithConfig");
}

在application.properties配置如下:

pkslow.cron=* * * ? * *

代码1秒执行一次。

4 如果她突然消失了

由于Spring的Scheduler默认是单线程的,这样会存在一个问题,如果某个任务执行卡住了,那就无法继续往下执行了。在日志上表现就是突然消失了。这种情况出现的概率还是不小的,如操作数据库死锁了,http请求timeout为无限等待,还有其它原因的死锁等。

当遇到这种情况,应通过命令jstack pid > pid.ThreadDump.txt获取当前线程情况,然后分析是否真的是卡住了,卡在了哪个环节,然后再分析具体代码。通过设置超时或重试等方法来解决。

5 结论

本文主要介绍了Spring的定时任务注解@Scheduled的使用,讲述了多种方式的使用和配置。它非常方便简洁,对于简单的定时任务足以应对了。


Code for all: GitHub

欢迎关注微信公众号<南瓜慢说>,将持续为你更新...

file

Recommendations:
Cloud Native
Terraform
Container: Docker/Kubernetes
Spring Boot / Spring Cloud
Https
如何制定切实可行的计划并好好执行

  • Author 作者: LarryDpk 南瓜慢说
  • Link 链接: https://www.pkslow.com/archives/spring-scheduled-annotation
  • 版权声明: 本博客所有文章除特别声明外,不可转载!
# Terraform101 # English # Terraform # Middleware # config # Go # Private # Kubernetes # pkslow # Test # HTTPS # Redis # Docker # Mac # Plan # Stream # MongoDB # Spring # DevOps # JVM # String # Map # Set # List # Performance # Email # Springboot # JavaCollections # ArrayList # Java
Terraform101 English Terraform Middleware config Go Private Kubernetes pkslow Test HTTPS Redis Docker Mac Plan Stream MongoDB Spring DevOps JVM String Map Set List Performance Email Springboot JavaCollections ArrayList Java
IDEA failed to import the class due to untrusted project
《Terraform 101 从入门到实践》 前言
  • Contents
  • Site Overview
南瓜慢说

南瓜慢说

多年Java开发,主要专注后端技术:Java/Spring/Springboot/微服务/大数据等。

多读书,多分享;多写作,多整理。

241 Posts
9 Categories
30 Tags
RSS
0%
© 2020 — 2022 南瓜慢说 pkslow The WebSite keeping alive:   粤ICP备20036375号