学而实习之 不亦乐乎

SpringBoot 定时任务 @Scheduled 的使用

2024-01-21 21:33:21

最近的开发中遇到了定时任务,之前都是在 Linux 中使用定时任务(crontab)来执行脚本。其实在 SpringBoot 也有自带的定时任务的实现,并且使用起来也很方便。SpringBoot 通过注解 @Scheduled 配置可以快速实现,直接在方法加上 @Scheduled 注解即可(注意! 在使用时需要在类上添加注解 @EnableScheduling,表示开启定时任务)。

一、@Scheduled注解

cron 参数是最经常使用的参数,它是一个表达式,最多接收7个参数,从左到右分别表示:秒 分 时 天 月 周 年;参数以空格隔开,其中年不是必须参数,可以省略。如下:

/**
 * cron 一共可以有7个参数 以空格分开 其中年不是必须参数
 * [秒] [分] [小时] [日] [月] [周] [年]
 * 一下表示
 */
@Scheduled(cron ="0 0 0 * * * ?")
public void testScheduledCron(){
}

cron参数意义:

  • 秒   是   0-59    , - * /
  • 分   是   0-59    , - * /
  • 时   是   0-23    , - * /
  • 日   是   1-31    , - * ? / L W
  • 月   是   1-12    , - * /
  • 周(周一 ~ 周日)  是   1-7     , - * ? / L #
  • 年   否   1970-2099   , - * /

 

常用通配符:

  • *:表示所有值 比如用在日 表示每一天。
  • ?:表示不指定值 比如周配置  表示不指定星期几执行。
  • /:表示递增触发 比如  用在分 5/20 从第五分钟开始 每增加20分钟执行一次。
  • -:表示区间 比如用在 1-6  表示一月到六月执行。

 

二、其他参数

1、zone 参数

zone能够指定获取的时区,默认是空,表示使用服务器所在时区,比如Asia/BeiJingi或者Asia/Shanghai。

2、fixedDelay

fixedDelay表示上次调用结束后与下次调用之间的固定时间,单位是毫秒。

@Scheduled(fixedDelay= 3000)

表示距离上次调用后三秒再执行

3、fixedDelayString

fixedDelayString与fixedDelay是几乎一样的,唯一的差异是fixedDelayString是支持占位符的。

4、fixedRate

fixedRate表示多久执行一次,单位是毫秒。与cron的/通配符用法相似;

@Scheduled(fixedRate= 3000)

表示每三秒执行一次

5、fixedRateString

fixedRate的升级,支持占位符

6、initialDelay

表示第一次延迟多少毫秒执行,单位是毫秒

@Scheduled(initialDelay= 3000)

表示第一次执行时,延迟3秒执行

7、initialDelayString

initialDelay的升级,支持占位符。

三、实例

每天凌晨零点执行

@Scheduled(cron ="0 0 0 * * * ?")

每隔五分钟执行

@Scheduled(cron ="0 */5 0 * * * ?")

四、注意

@Scheduled使用时,是在本机进行任务调度,但是目前几乎所有的应用为了增加发负载量,都是使用多机部署。这就导致了一个非常严重的分布式问题:在每一台机器上都会在同时执行定时调度任务,可能产生很多重复数据或者导致系统出现其他的业务逻辑BUG,所以在使用@Scheduled进行任务调度时,一定要配合redis的分布式锁来使用,让定时调度任务只在一台机器上执行,避免BUG出现。