微技术

关注技术领域,分享资讯和经验。

Java定时注解@Scheduled的使用,fixedDelay,fixedRate,cron的使用

项目中经常使用定时任务,spring提供了定时注解,很方便就可以使用

参数简介
1 一个cron表达式有至少6个(也可能7个),使用空格分隔时间元素
按顺序依次为:[秒] [分] [小时] [日] [月] [周] [年]

秒(0~59)
分钟(0~59)
小时(0~23)
天(月)(0~31,但是你需要考虑你月的天数)
月(0~11)
天(星期)(1~7 1=SUN 或 SUN,MON,TUE,WED,THU,FRI,SAT)
年份(1970-2099)
2 其中每个元素可以是一个值(如6),一个连续区间(9-12),一个间隔时间(8-18/4)(/表示每隔4小时),一个列表(1,3,5),通配符。由于"月份中的日期"和"星期中的日期"这两个元素互斥的,必须要对其中一个设置
设置用例:

*/5 * * * * ?   每五秒一次
0 */5 * * * ?   每五分一次
0 0 10,14,16 * * ?   每天上午10点,下午2点,4点
0 0/30 9-17 * * ?   朝九晚五工作时间内每半小时
0 0 12 ? * WED   表示每个星期三中午12点
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触发
3 表达式能包含一些范围或列表

子表达式(天(星期))可以为 “MON-FRI”,“MON,WED,FRI”,“MON-WED,SAT”
4 “*” 字符代表所有可能的值

“*” 在子表达式(月)里表示每个月的含义,“*”在子表达式(天(星期))表示星期的每一天
5 “/”字符用来指定数值的增量

在子表达式(分钟)里的“0/15”表示从第0分钟开始,每15分钟
在子表达式(分钟)里的“3/20”表示从第3分钟开始,每20分钟(它和“3,23,43”)的含义一样
6 “?”字符仅被用于天(月)和天(星期)两个子表达式,表示不指定值

当2个子表达式其中之一被指定了值以后,为了避免冲突,需要将另一个子表达式的值设为“?”
7 “L” 字符仅被用于天(月)和天(星期)两个子表达式,它是单词“last”的缩写,它在两个子表达式里的含义是不同的

在天(月)子表达式中,“L”表示一个月的最后一天
在天(星期)自表达式中,“L”表示一个星期的最后一天,也就是SAT
8 如果在“L”前有具体的内容,它就具有其他的含义了
“6L”表示这个月的倒数第6天,“FRIL”表示这个月的最一个星期五
在使用“L”参数时,不要指定列表或范围,因为这会导致问题
字段 允许值 允许的特殊字符
0-59 , - * /
0-59 , - * /
小时 0-23 , - * /
日期 1-31 , - * ? / L W C
月份 1-12 或者 JAN-DEC , - * /
星期 1-7 或者 SUN-SAT , - * ? / L C #
年(可选) 留空, 1970-2099 , - * /
9 默认使用服务器默认时区

可以设置为java.util.TimeZone中的zoneId, 每天零点执行@Scheduled(cron = “0 0 0 * * ?”, zone = “Asia/Shanghai”)
10 fixedDelay

@Scheduled(fixedDelay = 5000) //上一次执行完毕时间点之后5秒再执行
11 fixedDelayString

与 fixedDelay 意思相同,只是使用字符串的形式,唯一不同的是支持占位符
@Scheduled(fixedDelayString = “5000”) //上一次执行完毕时间点之后5秒再执行
12 fixedRate

@Scheduled(fixedRate = 5000) //上一次开始执行时间点之后5秒再执行
13 fixedRateString

与 fixedRate 意思相同,只是使用字符串的形式,唯一不同的是支持占位符
14 initialDelay

@Scheduled(initialDelay=1000, fixedRate=5000) //第一次延迟1秒后执行,之后按fixedRate的规则每5秒执行一次
15 initialDelayString

initialDelay 的字符串String格式,initialDelay 意思相同,只是使用字符串的形式,唯一不同的是支持占位符
16 1 需要使能@Scheduled注解,在类前面添加@EnableScheduling进行使能,否则定时注解默认无效

项目创建
1 需要使能@Scheduled注解,在类前面添加@EnableScheduling进行使能,否则定时注解默认无效

package com.yg.schedule.service;

import lombok.extern.slf4j.Slf4j;
import org.springframework.scheduling.annotation.EnableScheduling;
import org.springframework.scheduling.annotation.Scheduled;
import org.springframework.stereotype.Service;

/**
 * @Author suolong
 * @Date 2022/3/21 14:14
 * @Version 1.0
 */
@Service
@EnableScheduling
@Slf4j
public class ScheduleService {

    @Scheduled(fixedDelay = 1*1000) //毫秒为单位,该函数全部完成之后,暂停一秒开始执行第二次
    public void fixedDelayTest(){
        log.info("FixedDelay test");
    }

    @Scheduled(fixedRate = 1*1000) //毫秒为单位,调用一次函数,马上开始计时一秒,然后执行第二次
    public void fixedRateTest(){
        log.info("FixedRate test");
    }

    //cron语法:[秒] [分] [小时] [日] [月] [周] [年]
    //每隔一秒执行一次
    @Scheduled(cron = "0/1 * * * * *")
    public void cronTest(){
        log.info("Cron test");
    }
}


2 pom文件

<?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.6.4</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.yg</groupId>
    <artifactId>schedule</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>schedule</name>
    <description>Demo project for Spring Boot</description>
    <properties>
        <java.version>1.8</java.version>
    </properties>
    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <optional>true</optional>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
                <configuration>
                    <excludes>
                        <exclude>
                            <groupId>org.projectlombok</groupId>
                            <artifactId>lombok</artifactId>
                        </exclude>
                    </excludes>
                </configuration>
            </plugin>
        </plugins>
    </build>

</project>


3 启动类

package com.yg.schedule;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class ScheduleApplication {

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

}
4 整体项目目录


测试结果
1 fixedDelay和fixedRate测试

2 cron测试


心得
定时任务使用这些应该是足够了