Spring第38篇:定时器详解(@Scheduled & @EnableScheduling)

2023-11-11

Spring中 @Scheduled & @EnableScheduling 这2个注解,可以用来快速开发定时器,使用特别的简单。

如何使用?

用法

1、需要定时执行的方法上加上@Scheduled注解,这个注解中可以指定定时执行的规则,稍后详细介绍。

2、Spring容器中使用@EnableScheduling开启定时任务的执行,此时spring容器才可以识别@Scheduled标注的方法,然后自动定时执行。

案例

db中有很多需要推送的任务,然后将其检索出来,推送到手机端,来个定时器,每秒一次从库中检测需要推送的消息,然后推送到手机端。

package com.javacode2018.scheduled.demo1;

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

@Component
public class PushJob {

    //推送方法,每秒执行一次
    @Scheduled(fixedRate = 1000)
    public void push() throws InterruptedException {
        System.out.println("模拟推送消息," + System.currentTimeMillis());
    }

}

来个spring配置类,需要使用@EnableScheduling标注

package com.javacode2018.scheduled.demo1;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.ComponentScan;
import org.springframework.scheduling.annotation.EnableScheduling;

import java.util.concurrent.Executors;
import java.util.concurrent.ScheduledExecutorService;

@ComponentScan
@EnableScheduling //在spring容器中启用定时任务的执行
public class MainConfig1 {

    @Bean
    public ScheduledExecutorService scheduledExecutorService() {
        return Executors.newScheduledThreadPool(20);
    }
}

测试类

package com.javacode2018.scheduled;

import com.javacode2018.scheduled.demo1.MainConfig1;
import org.junit.Test;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;

import java.util.concurrent.TimeUnit;

public class ScheduledTest {
    @Test
    public void test1() throws InterruptedException {
        AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext();
        context.register(MainConfig1.class);
        context.refresh();
        //休眠一段时间,房子junit自动退出
        TimeUnit.SECONDS.sleep(10000);
    }

}

运行输出,每秒会输出一次,如下:

模拟推送消息,1595840822998
模拟推送消息,1595840823998
模拟推送消息,1595840824998
模拟推送消息,1595840825998
模拟推送消息,1595840826998
模拟推送消息,1595840827998
模拟推送消息,1595840828998

@Scheduled配置定时规则

@Scheduled可以用来配置定时器的执行规则,非常强大,@Scheduled中主要有8个参数,我们一一来了解一下。

@Target({ElementType.METHOD, ElementType.ANNOTATION_TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Repeatable(Schedules.class)
public @interface Scheduled {

 String cron() default "";

 String zone() default "";

 long fixedDelay() default -1;

 String fixedDelayString() default "";

 long fixedRate() default -1;

 String fixedRateString() default "";

 long initialDelay() default -1;

 String initialDelayString() default "";

}

1. cron

该参数接收一个cron表达式cron表达式是一个字符串,字符串以5或6个空格隔开,分开共6或7个域,每一个域代表一个含义。

cron表达式语法

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

注:[年]不是必须的域,可以省略[年],则一共6个域

序号 说明 必填 允许填写的值 允许的通配符
1 0-59 , - * /
2 0-59 , - * /
3 0-23 , - * /
4 1-31 , - * ? / L W
5 1-12 / 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 * * ?

cron表达式使用占位符

另外,cron属性接收的cron表达式支持占位符。

如:配置文件:

time:
  cron: */5 * * * * *
  interval: 5

每5秒执行一次:

@Scheduled(cron="${time.cron}")
void testPlaceholder1() {
    System.out.println("Execute at " + System.currentTimeMillis());
}

@Scheduled(cron="*/${time.interval} * * * * *")
void testPlaceholder2() {
    System.out.println("Execute at " + System.currentTimeMillis());
}

2. zone

时区,接收一个java.util.TimeZone#IDcron表达式会基于该时区解析。默认是一个空字符串,即取服务器所在地的时区。比如我们一般使用的时区Asia/Shanghai。该字段我们一般留空。

3. fixedDelay

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

如:

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

4. fixedDelayString

与 3. fixedDelay 意思相同,只是使用字符串的形式。唯一不同的是支持占位符。

如:

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

占位符的使用(配置文件中有配置:time.fixedDelay=5000)

@Scheduled(fixedDelayString = "${time.fixedDelay}")
void testFixedDelayString() {
    System.out.println("Execute at " + System.currentTimeMillis());
}

5. fixedRate

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

如:

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

6. fixedRateString

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

7. initialDelay

第一次延迟多长时间后再执行。

如:

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

8. initialDelayString

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

@Schedules注解

这个注解不用多解释,看一下源码就知道作用了,当一个方法上面需要同时指定多个定时规则的时候,可以通过这个来配置

@Target({ElementType.METHOD, ElementType.ANNOTATION_TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Schedules {
 Scheduled[] value();
}

如:

//2个定时器,500毫秒的,1000毫秒的
@Schedules({@Scheduled(fixedRate = 500), @Scheduled(fixedRate = 1000)})
public void push3() {
}

为定时器定义线程池

定时器默认情况下使用下面的线程池来执行定时任务的

new ScheduledThreadPoolExecutor(1)

只有一个线程,相当于只有一个干活的人,如果需要定时执行的任务太多,这些任务只能排队执行,会出现什么问题?

如果有些任务耗时比较长,导致其他任务排队时间比较长,不能有效的正常执行,直接影响到业务。

看下面代码,2个方法,都使用了@Scheduled(fixedRate = 1000),表示每秒执行一次,而push1方法中模拟耗时2秒,方法会中打印出线程名称、时间等信息,一会注意观察输出

package com.javacode2018.scheduled.demo2;

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

import java.util.concurrent.TimeUnit;

@Component
public class PushJob {

    //推送方法,每秒执行一次
    @Scheduled(fixedRate = 1000)
    public void push1() throws InterruptedException {
        //休眠2秒,模拟耗时操作
        TimeUnit.SECONDS.sleep(2);
        System.out.println(Thread.currentThread().getName() + " push1 模拟推送消息," + System.currentTimeMillis());
    }

    //推送方法,每秒执行一次
    @Scheduled(fixedRate = 1000)
    public void push2() {
        System.out.println(Thread.currentThread().getName() + " push2 模拟推送消息," + System.currentTimeMillis());
    }

}

运行输出

pool-1-thread-1 push1 模拟推送消息,1595902615507
pool-1-thread-1 push2 模拟推送消息,1595902615507
pool-1-thread-1 push1 模拟推送消息,1595902617507
pool-1-thread-1 push2 模拟推送消息,1595902617507
pool-1-thread-1 push1 模拟推送消息,1595902619508
pool-1-thread-1 push2 模拟推送消息,1595902619508

注意上面的输出,线程名称都是pool-1-thread-1,并且有个问题,push2中2次输出时间间隔是2秒,这就是由于线程池中只有一个线程导致了排队执行而产生的问题。

可以通过自定义定时器中的线程池来解决这个问题,定义一个ScheduledExecutorService类型的bean,名称为taskScheduler

@Bean
public ScheduledExecutorService taskScheduler() {
    //设置需要并行执行的任务数量
    int corePoolSize = 20;
    return new ScheduledThreadPoolExecutor(corePoolSize);
}

此时问题就解决了,再次运行一下上面案例代码,结果如下,此时线程名称不一样了,且push2运行正常了

pool-1-thread-2 push2 模拟推送消息,1595903154636
pool-1-thread-2 push2 模拟推送消息,1595903155636
pool-1-thread-1 push1 模拟推送消息,1595903156636
pool-1-thread-3 push2 模拟推送消息,1595903156636
pool-1-thread-1 push2 模拟推送消息,1595903157636

源码 & 原理

EnableScheduling注解开始看,这个注解会导入SchedulingConfiguration

SchedulingConfiguration是一个配置类,内部定义了ScheduledAnnotationBeanPostProcessor类型的bean

ScheduledAnnotationBeanPostProcessor是一个bean后置处理器,内部有个postProcessAfterInitialization方法,spring中任何bean在初始化完毕之后,会自动调用postProcessAfterInitialization方法,而ScheduledAnnotationBeanPostProcessor在这个方法中会解析bean中标注有@Scheduled注解的方法,这些方法也就是需要定时执行的方法。

ScheduledAnnotationBeanPostProcessor还实现了一个接口:SmartInitializingSingletonSmartInitializingSingleton中有个方法afterSingletonsInstantiated会在spring容器中所有单例bean初始化完毕之后调用,定期器的装配及启动都是在这个方法中进行的。

org.springframework.scheduling.annotation.ScheduledAnnotationBeanPostProcessor#afterSingletonsInstantiated

案例源码

https://gitee.com/javacode2018/spring-series
本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系:hwhale#tublm.com(使用前将#替换为@)

Spring第38篇:定时器详解(@Scheduled & @EnableScheduling) 的相关文章

随机推荐

  • C/C++:01. C过渡到C++

    文章目录 前言 1 C 和C的历史渊源 2 C 中的 class 和C中的 struct 3 C 命名空间 名字空间 详解 3 1 namespace 是C 中的关键字 用来定义一个命名空间 语法格式为 3 2 namespace 的使用规
  • 时序预测

    时序预测 Python实现CNN SVM卷积支持向量机时间序列预测 目录 时序预测 Python实现CNN SVM卷积支持向量机时间序列预测 基本描述 模型描述 程序设计 参考资料 基本描述 Python实现CNN SVM卷积支持向量机时间
  • React09——使用脚手架编程

    使用create react app创建react应用 react脚手架 xxx脚手架 用来帮助程序员快速创建一个基于xxx库的模板项目 包含了所有需要的配置 语法检查 jsx编译 devServer 下载好了所有相关的依赖 可以直接运行一
  • 求解:AttributeError: module ‘requests‘ has no attribute ‘args‘解决方法

    运行id request args get id 报错 解决办法 导入 from flask import request 我搜了一下 好多都没有解决办法 问题解决了的小伙伴动动发财的小手给点点赞吧
  • python 从CSV文件中读取数据并画日期折线图

    python 从CSV文件中读取数据并画日期折线图 代码环境 python 3 7 PyCharm 2019 1 1 问题描述 用pandas read csv读取文件中的数据后 希望以第一列 时间 为横轴 以第五列 数字数据 为纵轴画出日
  • 关于ADC_NbrOfChannel与ADC_RegularChannelConfig

    ADC NbrOfChannel是设置要转换的总通道数 ADC RegularChannelConfig 是配置各个通道 里面的第2个参数是你的通道名 第3个参数是这个通道名的转换顺序号 就是转换顺序怎么定义的 就是在第3个参数定义的 例
  • python依赖管理工具

    python依赖管理方案 pip作为python默认的包管理工具 提供了在线安装python依赖包的工具 但是内置的pip freeze默认打包整个机器上的python依赖环境 不太友好 下面简单介绍4个常用的依赖管理工具 pip pip
  • xpath定位元素方法_前端css基础篇(三) background背景元素position定位以及清除浮动的四种方法...

    一 background背景元素 1 background color背景颜色 可以简写 background 默认值是transparent 透明 不能继承 2 background image背景图片 可以简写background ur
  • 背包问题动态规划

    1 01背包问题 有N件物品 背包容量为V 第i件物品占容量c i 价值是w i 求装入哪些物品背包的价值最大 每个物品只能放一次或零次 动态规划思想很简单解决 用一个数组f i v 来表示前i件物品 容量为v的最大价值 那么推出转移方程f
  • 内存泄漏的场景

    当然可以 以下是每个场景的详细例子以及解决方法 未被释放的全局变量 例子 function leakMemory globalVar new Array 1000000 join leakMemory 解决方法 使用var let cons
  • 知乎爬虫(一)

    项目github地址 https github com Lee Jiazheng zhihu spider 知乎作为一个内容平台 有大量的新奇内容值得我们爬取 承受前人诸多知识 所以也写点东西为初学者提供一个学习的途径 爬虫 就是在一张大网
  • BUCK电源芯片BST引脚100nF电容的作用

    BUCK电源芯片大部分都有一个BOOT或者BST的引脚 这个引脚一般通过一个100nF的电容接到我们的开关输出引脚SW 那么大家知道这个100nF电容的作用吗 首先大家来看下BUCK芯片BOOT和SW引脚的内部结构 一般是由两个NMOS组成
  • finally用法

    一 finally是否执行 1 只有与 finally 相对应的 try 语句块得到执行的情况下 finally 语句块才会执行 当finally 相对应的 try 语句块之前 已经抛出错误 或者已经返回 return 就不会执行final
  • git查询和设置用户名及邮箱

    由于从原来的旧机子换到了新机子 很多东西都需要重新来 包括git 在vscode终端中安装了git 也ssh连到了远程的仓库 以为一切都ok了 在本地完成任务要推到远程时 告诉我说远程不知道我的身份 需要指明用户名和邮箱 我是个不太记东西的
  • AI算法实现与云平台应用

    陈迪豪 第四范式先知平台架构师 个人兴趣广泛 在开源社区比较活跃 维护了1600 star的容器Web管理平台Seagull 大二加入了小米做Android移动端开发 然后有幸学习到后端基础架构技术 参与了HBase ZooKeeper等社
  • 线程通信例题(12A34B56C.....5152Z)/ 生产者消费者面包超市...

    两个线程实现 一个线程专门打印数字 一个线程专门打印字母12A34B56C78D 5152Z public class Test public static void main String args Resource resource n
  • n行Python代码系列:两行代码将JSON文本转换成标准字典类型

    老猿Python博文目录 https blog csdn net LaoYuanPython article details 98245036 一 引言 最近看到好几篇类似 n行Python代码 的博文 看起来还挺不错 简洁 实用 传播了知
  • 大数据技术——VMbox的安装和网络配置

    大数据实训案例 实验报告 题目 大数据实验环境搭建 姓名 xxx 学号 xxxxxxx 实验日期 2023 x x 一 实验目的 1 掌握Linux操作系统的安装和使用方法 2 掌握hadoop的安装和使用方法 二 实验平台 操作系统 Ub
  • [USACO08FEB]修路Making the Grade

    题目链接 走这里 题目分析 考虑绝对值的几何意义 显然 b 里的数一定在 a 里出现过 离不离散化问题不大 用下标作第二位状态就行 设 dp i j 表示第 i 个数 高度为 a j 时的最优解 方程见代码 代码 include
  • Spring第38篇:定时器详解(@Scheduled & @EnableScheduling)

    Spring中 Scheduled EnableScheduling 这2个注解 可以用来快速开发定时器 使用特别的简单 如何使用 用法 1 需要定时执行的方法上加上 Scheduled注解 这个注解中可以指定定时执行的规则 稍后详细介绍