专栏首页Java后端技术栈cwnaitSpring Boot 如何快速实现定时任务

Spring Boot 如何快速实现定时任务

在开发项目的时候,使用定时任务的情况还是非常之多的,比如说:早上八点统一推送昨天的“战报”、金融相关行业则会涉及每天的对账等。

在 Spring + SpringMVC 环境中,一般来说,要实现定时任务,我们有两种方案:一种是使用 Spring 自带的定时任务处理器 @Scheduled 注解;另一种就是使用第三方框架 Quartz 。Spring Boot 源自 Spring+SpringMVC ,因此天然具备这两个 Spring 中的定时任务实现策略,当然也支持 Quartz,本文我们就来看下 Spring Boot 中使用@Scheduled的方式实现定时任务。

位于spring-context-**.jar包中可以找到对应的定时 相关的几个注解,请看下图:

@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Import({SchedulingConfiguration.class})
@Documented
public @interface EnableScheduling {
}

这里项目还是沿用前面Spring Boot实战系列中的Spring Boot项目。请看是如何快速搞定的

第一步:给启动类添加注解@EnableScheduling

@EnableScheduling
@SpringBootApplication
public class DemoApplication {

    public static void main(String[] args) {
        SpringApplication.run(DemoApplication.class, args);
    }

}

第二步:创建自己的定时类

@Component
public class MyScheduled {
    @Scheduled(fixedRate = 5000)
    public void reportCurrentTime() {
        //写你的业务代码
        System.out.println(new Date());
    }
}

启动项目,可以看到每五秒打印一次时间,证明是每五秒执行一次任务。

这么轻松就搞定了Spring Boot定时任务。

回头再看看@Scheduled注解的源码

@Target({ElementType.METHOD, ElementType.ANNOTATION_TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Repeatable(Schedules.class)
public @interface Scheduled {
    String CRON_DISABLED = "-";

    String cron() default "";

    String zone() default "";

    long fixedDelay() default -1L;

    String fixedDelayString() default "";

    long fixedRate() default -1L;

    String fixedRateString() default "";

    long initialDelay() default -1L;

    String initialDelayString() default "";
}

简要说明:

  1. 首先使用 @Scheduled 注解开启一个定时任务。
  2. fixedRate 表示任务执行之间的时间间隔,具体是指两次任务的开始时间间隔,即第二次任务开始时,第一次任务可能还没结束。
  3. fixedDelay 表示任务执行之间的时间间隔,具体是指本次任务结束到下次任务开始之间的时间间隔。
  4. initialDelay 表示首次任务启动的延迟时间。
  5. 所有时间的单位都是毫秒。

上面这是一个基本用法,除了这几个基本属性之外,@Scheduled 注解也支持 cron 表达式,使用 cron 表达式,可以非常丰富的描述定时任务的时间。cron 表达式格式如下:

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

具体取值如下:

这一块需要大家注意的是,月份中的日期和星期可能会起冲突,因此在配置时这两个得有一个是 ?

通配符含义:

  • ? 表示不指定值,即不关心某个字段的取值时使用。需要注意的是,月份中的日期和星期可能会起冲突,因此在配置时这两个得有一个是 ?
  • ` 表示所有值,例如:在秒的字段上设置 `,表示每一秒都会触发
  • , 用来分开多个值,例如在周字段上设置 "MON,WED,FRI" 表示周一,周三和周五触发
  • - 表示区间,例如在秒上设置 "10-12",表示 10,11,12秒都会触发
  • / 用于递增触发,如在秒上面设置"5/15" 表示从5秒开始,每增15秒触发(5,20,35,50)
  • # 序号(表示每月的第几个周几),例如在周字段上设置"6#3"表示在每月的第三个周六,(用 在母亲节和父亲节再合适不过了)
  • 周字段的设置,若使用英文字母是不区分大小写的 ,即 MON 与mon相同
  • L 表示最后的意思。在日字段设置上,表示当月的最后一天(依据当前月份,如果是二月还会自动判断是否是润年), 在周字段上表示星期六,相当于"7"或"SAT"(注意周日算是第一天)。如果在"L"前加上数字,则表示该数据的最后一个。例如在周字段上设置"6L"这样的格式,则表示"本月最后一个星期五"
  • W 表示离指定日期的最近工作日(周一至周五),例如在日字段上设置"15W",表示离每月15号最近的那个工作日触发。如果15号正好是周六,则找最近的周五(14号)触发, 如果15号是周未,则找最近的下周一(16号)触发,如果15号正好在工作日(周一至周五),则就在该天触发。如果指定格式为 "1W",它则表示每月1号往后最近的工作日触发。如果1号正是周六,则将在3号下周一触发。(注,"W"前只能设置具体的数字,不允许区间"-")
  • LW 可以一组合使用。如果在日字段上设置"LW",则表示在本月的最后一个工作日触发(一般指发工资 )

下面给出几个表达式配置案例

“0 0 12 * * ?” 每天中午12点触发 “0 15 10 ? * *” 每天上午10:15触发 “0 15 10 * * ?” 每天上午10:15触发 “0 15 10 * * ? *” 每天上午10:15触发 “0 15 10 * * ? 2005” 2005年的每天上午10:15触发 “0 * 14 * * ?” 在每天下午2点到下午2:59期间的每1分钟触发 “0 0/5 14 * * ?” 在每天下午2点到下午2:55期间的每5分钟触发 “0 0/5 14,18 * * ?” 在每天下午2点到2:55期间和下午6点到6:55期间的每5分钟触发 “0 0-5 14 * * ?” 在每天下午2点到下午2:05期间的每1分钟触发 “0 10,44 14 ? 3 WED” 每年三月的星期三的下午2:10和2:44触发 “0 15 10 ? * MON-FRI” 周一至周五的上午10:15触发 “0 15 10 15 * ?” 每月15日上午10:15触发 “0 15 10 L * ?” 每月最后一日的上午10:15触发 “0 15 10 ? * 6L” 每月的最后一个星期五上午10:15触发 “0 15 10 ? * 6L 2002-2005” 2002年至2005年的每月的最后一个星期五上午10:15触发 “0 15 10 ? * 6#3” 每月的第三个星期五上午10:15触发

例如,在 @Scheduled 注解中来一个简单的 cron 表达式,每隔10秒触发一次,代码如下:

@Component
public class MyScheduled {

    @Scheduled(cron = "0/10 * * * * *")
    public void test(){
        System.out.println(new Date()+"开始执行 ");
    }
}

启动项目,输出

总结,其实在Spring Boot项目中实现定时任务很简单,两步就搞定了:

  1. 在程序的入口Appliaction类上添加@EnableScheduling注解。
  2. 在定时方法上加@Scheduled注解。

由于篇幅有限,Quartz的实现方式留到下一次,ok,今天就这么轻松的结束啦。

本文分享自微信公众号 - Java后端技术全栈(jjs-2018),作者:田老师

原文出处及转载信息见文内详细说明,如有侵权,请联系 yunjia_community@tencent.com 删除。

原始发表时间:2020-08-27

本文参与腾讯云自媒体分享计划,欢迎正在阅读的你也加入,一起分享。

我来说两句

0 条评论
登录 后参与评论

相关文章

  • 教你写一个迷你版的Tomcat~

    Tomcat,这只3脚猫,大学的时候就认识了,直到现在工作中,也常会和它打交道。这是一只神奇的猫,今天让我来抽象你,实现你!

    用户4143945
  • 代理模式实现方式及优缺点对比

    代理模式最典型的应用就是AOP,本文结合主要讲解了代理模式的几种实现方式:静态代理和动态代理,这里动态代理又可以分为jdk代理和Cglib代理,另外,本文也对这...

    用户4143945
  • SpringCloud实战: Feign<上>

    很多使用spring cloud 主要是注册中心,动态配置中心,服务调用,负载均衡,熔断,网关。Feign是一个声明式的Web Service客户端,整合了注解...

    用户4143945
  • Springboot的默认定时任务——Scheduled注解

    本博客参考博文地址。 1.pom依赖: 引入springboot starter包即可 <dependencies> <dependency> ...

    用户1134788
  • Spring Task中cron表达式详解

    _{秒}:取值范围(0-59),不允许为空值,若值不合法,调度器将抛出SchedulerException异常

    JouyPub
  • Hybris CronJob

    一、概念     CronJobs提供了在特定的时间或者间隔内处理业务逻辑的方法。一般创建一个Cronjob有两种方式,第一种是定义Java类,由Hybris生...

    JMCui
  • Spring之定时任务基本使用篇

    文章链接:https://liuyueyi.github.io/hexblog/2018/08/01/180801-Spring之定时任务基本使用篇/

    一灰灰blog
  • Cron表达式

    源码地址:http://download.csdn.net/download/xushaonian/5790307

    跟着阿笨一起玩NET
  • Quarzt定时调度任务

    简介 Quarzt是一个项目中定时执行任务的开源项目,Quartz是OpenSymphony开源组织在Job scheduling领域又一个开源项目,它可以与J...

    李家酒馆酒保
  • Quartz作业调度框架

    Quartz 是一个开源的作业调度框架,它完全由 Java 写成,并设计用于 J2SE 和 J2EE 应用中。它提供了巨大的灵活性而不牺牲简单性。你能够用它来为...

    java达人

扫码关注云+社区

领取腾讯云代金券