SpringBoot学习之定时任务-Scheduler

今日份学习记录：SpringBoot定时任务-Scheduler。

首先创建一个webservice项目：

IDEA自动构建，pom.xml如下：

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.3.0.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.minant</groupId>
    <artifactId>minant-service-schedule</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>minant-service-schedule</name>
    <description>schedule定时任务</description>

    <properties>
        <java.version>1.8</java.version>
    </properties>

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web-services</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
            <exclusions>
                <exclusion>
                    <groupId>org.junit.vintage</groupId>
                    <artifactId>junit-vintage-engine</artifactId>
                </exclusion>
            </exclusions>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>

</project>

spring-boot-starter-web-services依赖中就包含了有Scheduled的支持：

简单的配置一下application.yml:

server:
  port: 8082
  servlet:
    context-path: /
spring:
  application:
    name: schedule

再启动类上配置上注解@EnableScheduling

然后就可以着手编写自已的定时任务了。编写一个定时任务类：

package com.minant.sched;

import org.springframework.scheduling.annotation.Scheduled;
import org.springframework.stereotype.Component;

import java.util.Date;

/**
 * @ClassName MySchedule
 * @Description TODO 我的定时任务
 * @Author MinAnt
 * @Date 2020/5/16
 * @Version V1.0
 */
@Component
public class MySchedule {

    /**
     * 秒 分 小时 日 月 周 年
     * 一般不用年，只用6位表示即可
     * * 表示所有值
     * ？表示占位符，不指定其值，不关心其值
     * - 表示区间，
     * , 表示指定多个值，例如在周字段上设置 “MON,WED,FRI” 表示周一，周三和周五触发
     * / 用于递增触发。如在秒上面设置”5/15” 表示从5秒开始，每增15秒触发(5,20,35,50)。 在月字段上设置’1/3’所示每月1号开始，每隔三天触发一次。
     * */
    @Scheduled(cron = "0/2 * * * * ?")
    public void testCron() {
        System.out.println(new Date() +"开始吃饭。。。。。");
    }

    // 上次执行完5秒后再次执行
    // fixedDelayString 与其相同，不同就是以字符串形式表示，如
    // 配置文件中有time.fixedDelay
    // @Scheduled(fixedDelayString = "${time.fixedDelay}")
    /*@Scheduled(fixedDelay = 5000)
    public void testFixedDelay() throws InterruptedException {
        System.out.println(new Date() +"洗澡了。。。。。");
    }*/

    //上一次开始执行时间点之后5秒再执行
    // initialDelayString 意思相同，只是使用字符串的形式。唯一不同的是支持占位符
    /*@Scheduled(fixedRate = 5000)
    public void testfixedRate() {
        System.out.println(new Date() +"嗨起来。。。。。");
    }*/

    // 第一次延迟多长时间后再执行
    // initialDelayString 意思相同，只是使用字符串的形式。唯一不同的是支持占位符。
    @Scheduled(initialDelay = 10000, fixedDelay = 5000)
    public void testInit() {
        System.out.println(new Date() +"延迟10秒执行。。。。后每五秒执行一次。。。");
    }


}

先启动项目来看看效果先，稍后再做说明。

由控制台输出结果可以看出任务已经按设定规则在执行。下面就来解释下这些规则的配置：

@Scheduled注解就是标注该方法为要执行的任务，什么时候执行、怎么执行，就需要配置其中的属性来决定。其中一属性的含义如下：

• cron : cron 表达式。定时任务触发是时间的一个字符串表达形式。分为6或7个域，每一个域代表一个含义。

• Cron 有如下两种语法格式：

• （1） Seconds Minutes Hours Day Month Week Year
• （2）Seconds Minutes Hours Day Month Week
• corn 从左到右（用空格隔开）：秒 分 小时 月份中的日期 月份 星期中的日期 年份，一般我们只用6位的来表示就可以了。
• 各字段的含义：

• 序号	说明	允许值	允许特殊字符
  1	秒	0-59	， -  * /
  2	分	0-59	， -  * /
  3	时	0-23	， -  * /
  4	日	1-31	， -  * / L W C
  5	月	1-12	， -  * /
  6	星期	1-7	， -  * / ? L C #
  7	年（可选）	1970-2099	， -  * /

  ●星号(*)：可用在所有字段中，表示对应时间域的每一个时刻，例如，*在分钟字段时，表示“每分钟”；

  ●问号（?）：该字符只在日期和星期字段中使用，它通常指定为“无意义的值”，相当于占位符；

  ●减号(-)：表达一个范围，如在小时字段中使用“10-12”，则表示从 10 到 12 点，即 10,11,12；

  ●逗号(,)：表达一个列表值，如在星期字段中使用“MON,WED,FRI”，则表示星期一，星期三和星期 五；

  ●斜杠(/)：x/y 表达一个等步长序列，x 为起始值，y 为增量步长值。如在分钟字段中使用 0/15，则 表示为 0,15,30 和 45 秒，而 5/15 在分钟字段中表示 5,20,35,50，你也可以使用*/y，它等同于 0/y；

  ●L：该字符只在日期和星期字段中使用，代表“Last”的意思，但它在两个字段中意思不同。L 在日期 字段中，表示这个月份的最后一天，如一月的 31 号，非闰年二月的 28 号；如果 L 用在星期中，则表示星 期六，等同于 7。但是，如果 L 出现在星期字段里，而且在前面有一个数值 X，则表示“这个月的最后 X 天”， 例如，6L 表示该月的最后星期五；

  ●W：该字符只能出现在日期字段里，是对前导日期的修饰，表示离该日期最近的工作日。例如 15W 表示离该月 15 号最近的工作日，如果该月 15 号是星期六，则匹配 14 号星期五；如果 15 日是星期日， 则匹配 16 号星期一；如果 15 号是星期二，那结果就是 15 号星期二。但必须注意关联的匹配日期不能够 跨月，如你指定 1W，如果 1 号是星期六，结果匹配的是 3 号星期一，而非上个月最后的那天。W 字符串 只能指定单一日期，而不能指定日期范围；

  ●LW 组合：在日期字段可以组合使用 LW，它的意思是当月的最后一个工作日；

  ●井号(#)：该字符只能在星期字段中使用，表示当月某个工作日。如 6#3 表示当月的第三个星期五(6 表示星期五，#3 表示当前的第三个)，而 4#5 表示当月的第五个星期三，假设当月没有第五个星期三， 忽略不触发；

  ● C：该字符只在日期和星期字段中使用，代表“Calendar”的意思。它的意思是计划所关联的日期， 如果日期没有被关联，则相当于日历中所有日期。例如 5C 在日期字段中就相当于日历 5 日以后的第一天。 1C 在星期字段中相当于星期日后的第一天。 Cron 表达式对特殊字符的大小写不敏感，对代表星期的缩写英文大小写也不敏感。

  例如：

  @Scheduled(cron = "0 0 1 1 1 ?")//每年一月的一号的 1:00:00 执行一次
  @Scheduled(cron = "0 0 1 1 1,6 ?") //一月和六月的一号的 1:00:00 执行一次
  @Scheduled(cron = "0 0 1 1 1,4,7,10 ?") //每个季度的第一个月的一号的 1:00:00 执行一次
  @Scheduled(cron = "0 0 1 1 * ?")//每月一号 1:00:00 执行一次
  @Scheduled(cron="0 0 1 * * *") //每天凌晨 1 点执行一次

  • fixedDelay：上次执行完多少秒后再执行

  • 如@Scheduled(fixedDelay = 5000)，表示执行完任务5秒后再执行

  • fixedDelayString：与上功能相同，但以字符串型式表示，还支持配置

  • 如@Scheduled(fixedDelayString = "${time.fixedDelay}")，从配置文件中获取。

  • fixedRate：上次执行开始后多久再执行，不用等执行完

  • 如@Scheduled(fixedRate = 5000)，表示上次执行开始后5秒即再执行

  • fixedRateString：与上功能相同，但以字符串型式表示，还支持配置

  • initialDelay：首次开始延迟多长时间执行

  • 如@Scheduled(initialDelay = 10000, fixedDelay = 5000)，表示首次10秒延迟，后每执行完后5秒再执行

  • initialDelayString：与上功能相同，但以字符串型式表示，还支持配置

  至此SpringBoot的Scheduler定时任务学习记录结束。

  参考：https://msd.misuland.com/pd/2884250137616452282

  stay hungry stay foolish! 加油！！