SpringBoot——@Schedled方式配置定时任务详解

2022-09-03 12:58:18

@Schedled注解详解

@Sechedled是为定时任务而生的注解,是springboot自带的注解,查看注解源码:

@Target({ElementType.METHOD, ElementType.ANNOTATION_TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Repeatable(Schedules.class)
public @interface Scheduled {
    String CRON_DISABLED = "-";
//cron表达式
    String cron() default "";
//接收一个java.util.TimeZone#ID
    String zone() default "";
//上一次执行完毕时间点之后多长时间再执行
    long fixedDelay() default -1L;
//支持占位符形式的字符串类型的fixedDelay
    String fixedDelayString() default "";
//上一次开始执行时间点之后多长时间再执行
    long fixedRate() default -1L;
//支持占位符形式的字符串类型的fixedRateString
    String fixedRateString() default "";
//第一次延迟多长时间后再执行
    long initialDelay() default -1L;
//支持占位符形式的字符串类型的initialDelay
    String initialDelayString() default "";
}

可以看出:Scheduled注解中的参数用来设置“定时”动作,通常情况下,比较常用的参数是cron(),这意味着我们需要学会一些cron表达式相关的语法。

如何用Scheduled注解来实现定时任务

  1. 在springboot项目入口类配置@Schedled开启定时任务支持
    @SpringBootApplication
    /**
     * 开启定时任务支持
     */
    @EnableScheduling
    public class TestApplication  extends SpringBootServletInitializer {
        public static void main(String[] args) {
            SpringApplication.run(TestApplication.class, args);
        }
        @Override
        protected SpringApplicationBuilder configure(SpringApplicationBuilder builder) {
            return builder.sources(this.getClass());
        }
    }
  2. 编写定时任务类及定时任务
    @Component
    public class CountRewardScheduled {
    
        private Logger logger = LoggerFactory.getLogger(CountRewardScheduled.class);
    
        /**
         * 每10秒执行一次定时任务
         */
        @Scheduled(cron = "0/10 * * * * ? ")
        public void testCron(){
            
            logger.info("Scheduled 执行一次定时任务");
            // 业务逻辑
    
        }
    }
  3. 启动项目,可看到结果

 cron表达式

cron表达式是一个字符串其语法为:

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

其中[年]为非必填项,因此通常cron表达式通常由6或7部分内容组成,内容的取值为数字或者一些cron表达式约定的特殊字符,这些特殊字符称为“通配符”,每一个通配符分别代指一种值。cron表达式可以用这样的表格来表示:

顺序

取值范围

特殊字符串范围

0~60

, - * /

0-60

, - * /

0-23

, - * /

1-31

, - * /

1-12 / JAN-DEC

, - * ? / L W

1-7 / SUN-SAT

, - * ? / L #

年(可省略)

1970-2099

, - * /

其中通配符的解释以及作用如下:

通配符

代表的值

解释

*

所有值

如:时字段为*,代表每小时都触发

?

不指定值

如:周字段为?,代表表达式不关心是周几

-

区间

如:时字段设置2-5,代表2,3,4,5点钟时都触发

,

多个值

如:时字段设置2,3,5,代表2,3,5点都会触发

/

递增值

如:时字段设置0/2,代表每两个小时触发,时字段设置 2/5,代表从2时开始每隔5小时触发一次

L

最后值

如:日字段设置L,代表本月最后一天

W

最近工作日

如:在日字段设置13W,代表没约13日最近的那个工作日触发一次

#

序号

如:在周字段设置5#2,代表每月的第二个周五

 常用cron表达式:

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触发 

有些子表达式能包含一些范围或列表
例如:子表达式(天(星期))可以为 “MON-FRI”,“MON,WED,FRI”,“MON-WED,SAT”
“*”字符代表所有可能的值
因此,“*”在子表达式(月)里表示每个月的含义,“*”在子表达式(天(星期))表示星期的每一天
 
“/”字符用来指定数值的增量
例如:在子表达式(分钟)里的“0/15”表示从第0分钟开始,每15分钟
         在子表达式(分钟)里的“3/20”表示从第3分钟开始,每20分钟(它和“3,23,43”)的含义一样

“?”字符仅被用于天(月)和天(星期)两个子表达式,表示不指定值
当2个子表达式其中之一被指定了值以后,为了避免冲突,需要将另一个子表达式的值设为“?”
 
“L” 字符仅被用于天(月)和天(星期)两个子表达式,它是单词“last”的缩写
但是它在两个子表达式里的含义是不同的。
在天(月)子表达式中,“L”表示一个月的最后一天
在天(星期)自表达式中,“L”表示一个星期的最后一天,也就是SAT
如果在“L”前有具体的内容,它就具有其他的含义了
例如:“6L”表示这个月的倒数第6天,“FRIL”表示这个月的最一个星期五
注意:在使用“L”参数时,不要指定列表或范围,因为这会导致问题
  • 作者:1-只小猴子
  • 原文链接:https://blog.csdn.net/s1078229131/article/details/90260205
    更新时间:2022-09-03 12:58:18