springboot 定时任务 @Scheduled 配置文件获取cron

Posted 2023-04-05 globalcoding

在Application启动类上加上 @EnableScheduling ，在类上加上@Component，在方法上加上@Scheduled，就可以启动一个定时任务。

1.定时任务启动

@Slf4j
@EnableScheduling
@SpringBootApplication
public class MyApplication 
    public static void main(String[] args) 
        SpringApplication.run(MyApplication.class, args);
        log.info(">>>>>>>>>>>>>>>>>>>>>>>启动完成<<<<<<<<<<<<<<<<<<<<<<<");
    

@Component
public class MyTask 
    private static SimpleDateFormat sdf = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");

    @Scheduled(cron = "* * * * * ?")
    public void t1()
        System.out.println(sdf.format(new Date()));
    

 以上是将定时任务的时间写死在了代码里。

2.通过配置文件获取cron时间

如果要将时间写在application.yml，如下

#application.yml中的配置

myScheduled:
  myCron: * * * * * ?

@Scheduled(cron = "$myScheduled.myCron")
public void t1()
    System.out.println(sdf.format(new Date()));

3.关闭定时任务

Spring Boot 2.1 以上的版本，在 cron 中使用 "-"  。

#application.yml中的配置

myScheduled:
  myCron: "-"

#注意：在yml文件中，-需要用双引号，因为在yml文件中 - 是特殊符号，代表list。在properties文件中，不需要双引号

是否可以写未来的一个时间，例如2099年，这样在有生之年他都不会执行了。但@Scheduled 不识别年。

4.通过开关来控制定时任务

 加一个开关，来控制所有的定时任务是否开启。

原理：

加了@Scheduled的方法之所以被执行，是因为被 ScheduledAnnotationBeanPostProcessor 这个类拦截。而这个类是由@EnableScheduling 生成。源码如下：

@Import(SchedulingConfiguration.class)
public @interface EnableScheduling 


//EnableScheduling注解有个@Import(SchedulingConfiguration.class)，SchedulingConfiguration的源码如下，
//他干了个事 new ScheduledAnnotationBeanPostProcessor()

@Configuration
public class SchedulingConfiguration 
//... 为了减少空间 我省略了其他代码
    public ScheduledAnnotationBeanPostProcessor scheduledAnnotationProcessor() 
        return new ScheduledAnnotationBeanPostProcessor();
    

所以，我们控制所有的定时任务是否开启，就需要自己来创建ScheduledAnnotationBeanPostProcessor，即首先要去掉启动类上的@EnableScheduling，

然后再通过@Configuration和@Bean来创建ScheduledAnnotationBeanPostProcessor，@Conditional这个注解是用来判断true还是false，即开关的作用。

@Configuration
public class ScheduledConfig 
//@Conditional判断ScheduledCondition获取到值是true还是false，true则创建bean

    @Conditional(ScheduledCondition.class)
    @Bean
    public ScheduledAnnotationBeanPostProcessor processor() 
        return new ScheduledAnnotationBeanPostProcessor();
    

 @Conditional(ScheduledCondition.class)中的ScheduledCondition，用来获取配置文件中的值

public class ScheduledCondition implements Condition 
    @Override
    public boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata) 
        //读取配置中的属性
        return Boolean.valueOf(context.getEnvironment().getProperty("myEnable.myScheduled"));
    

#application.yml中的配置

myEnable:
  myScheduled: true

参考

https://segmentfault.com/a/1190000018805591

ruoyi项目的quartz模块，有专门的定时任务工具类，通过数据库配置定时任务，修改定时任务状态，可以在后台管理工具中手动切换，重启，执行任务。

RuoYi: 🎉 基于SpringBoot的权限管理系统 易读易懂、界面简洁美观。 核心技术采用Spring、MyBatis、Shiro没有任何其它重度依赖。直接运行即可用 (gitee.com)

SpringBoot系列：Spring Boot定时任务Spring Schedule

Spring Schedule是Spring提供的定时任务框架，相较于Quartz，Schedule更加简单易用，在中小型应用中，对于大部分需求，Schedule都可以胜任。

一、Spring Schedule使用演示

在 SpringBoot使用Spring Schedule非常简单，因为SpringBoot自身的starter中已经集成了Schedule，而不需要我们做更多的处理。

使用@EnableScheduling注解开启定时功能，该注解可以使用在启动类上，也可以注解于定时任务的类上。然后使用@Scheduled注解配合其参数完成定时任务。

例如我们需要每一秒执行一次的任务， 写成@Scheduled(fixedRate = 1000)即可。

@EnableScheduling
@Component
public class Task {

    private static final SimpleDateFormat dateFormat = new SimpleDateFormat("HH:mm:ss");

    @Scheduled(fixedRate = 1000)
    public void taskOne(){
        System.out.println("现在时间：" + dateFormat.format(new Date()));
    }

}

启动程序，该定时就可以间隔一秒持续执行了。

使用Spring Schedule就是这么简单，如果有更多其他的需求，配合@Scheduled的其他参数，基本也可以实现。

一、@Scheduled参数详解

cron

支持传入cron表达式：[秒] [分] [小时] [日] [月] [周] [年]，[年]不是必须的域，可以省略[年]，则一共6个域。

位置	说明	必填	允许填写的值	允许的通配符
1	秒	是	0-59	- * /
2	分	是	0-59	- * /
3	时	是	0-23	- * /
4	日	是	1-31	- * ? / L W
5	月	是	1-12 or JAN-DEC	- * /
6	周	是	1-7 or SUN-SAT	- * ? / L #
7	年	否	1970-2099	- * /

• * 表示所有值。 例如:在分的字段上设置 *,表示每一分钟都会触发。
• ? 表示不指定值。使用的场景为不需要关心当前设置这个字段的值。例如:要在每月的10号触发一个操作，但不关心是周几，所以需要周位置的那个字段设置为”?” 具体设置为 0 0 0 10 * ?
• - 表示区间。例如 在小时上设置 “10-12”,表示 10,11,12点都会触发。
• , 表示指定多个值，例如在周字段上设置 “MON,WED,FRI” 表示周一，周三和周五触发/ 用于递增触发。如在秒上面设置”5/15” 表示从5秒开始，每增15秒触发(5,20,35,50)。 在月字段上设置’1/3’所示每月1号开始，每隔三天触发一次。
• L 表示最后的意思。在日字段设置上，表示当月的最后一天(依据当前月份，如果是二月还会依据是否是润年[leap]), 在周字段上表示星期六，相当于”7”或”SAT”。如果在”L”前加上数字，则表示该数据的最后一个。例如在周字段上设置”6L”这样的格式,则表示“本月最后一个星期五”
• W 表示离指定日期的最近那个工作日(周一至周五). 例如在日字段上置”15W”，表示离每月15号最近的那个工作日触发。如果15号正好是周六，则找最近的周五(14号)触发, 如果15号是周未，则找最近的下周一(16号)触发.如果15号正好在工作日(周一至周五)，则就在该天触发。如果指定格式为 “1W”,它则表示每月1号往后最近的工作日触发。如果1号正是周六，则将在3号下周一触发。(注，”W”前只能设置具体的数字,不允许区间”-“)。
• # 序号(表示每月的第几个周几)，例如在周字段上设置”6#3”表示在每月的第三个周六.注意如果指定”#5”,正好第五周没有周六，则不会触发该配置(用在母亲节和父亲节再合适不过了) ；小提示：’L’和 ‘W’可以一组合使用。如果在日字段上设置”LW”,则表示在本月的最后一个工作日触发；周字段的设置，若使用英文字母是不区分大小写的，即MON与mon相同。

示例

• 每隔5秒执行一次：/5 * * * ?
• 每隔1分钟执行一次：0 /1 * * ?
• 每天23点执行一次：0 0 23 * * ?
• 每天凌晨1点执行一次：0 0 1 * * ?
• 每月1号凌晨1点执行一次：0 0 1 1 * ?
• 每月最后一天23点执行一次：0 0 23 L * ?
• 每周星期天凌晨1点实行一次：0 0 1 ? * L
• 在26分、29分、33分执行一次：0 26,29,33 * * * ?
• 每天的0点、13点、18点、21点都执行一次：0 0 0,13,18,21 * * ?

zone

表示时区，接收一个 java.util.TimeZone#ID。cron表达式会基于该时区解析。默认是一个空字符串，即取服务器所在地的时区。

fixedDelay

上一次执行完毕时间点之后多长时间再执行。

fixedDelayString

与fixedDelay类似，传入字符串，也可支持传入${}占位符读取配置文件。

    @Scheduled(fixedDelayString = "${task.two.fixedDelay}")
    void taskTwo() {
       System.out.println("现在时间：" + dateFormat.format(new Date()));
    }

fixedRate

上一次开始执行时间点之后多长时间再执行。

fixedRate与fixedDelay的区别就是：fixedDelay是在上一个任务结束后才开始进行间隔计时，也就是说两次任务之间的时间差等于间隔+任务执行耗时，而fixedRate是在上一个任务一开始就已经开始进行间隔计时了，可以视为固定等于设置的间隔时间。

fixedRateString

与fixedRate一样，传入字符串，支持占位符读取配置文件。

initialDelay

第一次任务延迟时间。

initialDelayString

同initialDelay，支持占位符读取配置信息。