Spring定时任务新篇章:@EnableScheduling注解全解析,有两下子!

举报
bug菌 发表于 2024/07/28 16:37:06 2024/07/28
【摘要】 本专栏致力打造最硬核 Spring Boot 从零基础到进阶系列学习内容,🚀均为全网独家首发,打造精品专栏,专栏持续更新中…欢迎大家订阅持续学习。 如果想快速定位学习,可以看这篇【SpringBoot教程导航帖】,你想学习的都被收集在内,快速投入学习!!两不误。

📣前言

  在现代软件开发中,定时任务是常见的需求,如定期备份数据、定时发送邮件等。Spring框架提供了强大的支持来简化定时任务的创建和管理。@EnableScheduling注解是Spring框架中用于开启定时任务支持的关键工具。本文将深入探讨这一注解,帮助Java开发者轻松掌握定时任务的实现和管理。

  那么,具体如何实现呢?这将又会是干货满满的一期,全程无尿点不废话只抓重点教,具有非常好的学习效果,拿好小板凳准备就坐!希望学习的过程中大家认真听好好学,学习的途中有任何不清楚或疑问的地方皆可评论区留言或私信,bug菌将第一时间给予解惑,那么废话不多说,直接开整!Fighting!!

🌊环境说明

开发工具:IDEA 2021.3
JDK版本: JDK 1.8
Spring Boot版本:2.3.1 RELEASE
Maven版本:3.8.2


🏆本文收录于《Spring Boot从入门到精通》,专门攻坚指数提升,2023 年国内最系统+最强(更新中)。

本专栏致力打造最硬核 Spring Boot 从零基础到进阶系列学习内容,🚀均为全网独家首发,打造精品专栏,专栏持续更新中…欢迎大家订阅持续学习。 如果想快速定位学习,可以看这篇【SpringBoot教程导航帖】,你想学习的都被收集在内,快速投入学习!!两不误。


🌊摘要

  本文详细介绍了Spring框架中的@EnableScheduling注解,包括其定义、如何开启定时任务支持、源码解析、案例分析、应用场景、优缺点分析,以及如何编写测试用例。通过实际代码示例,引导读者深入理解并有效使用@EnableScheduling注解。

🌊正文

搭建Spring Boot应用

  首先,我们先创建个基础的Spring Boot项目,如果还不会点这里,此处就不详细赘述啦。

简介

  @EnableScheduling是一个方便的Spring注解,用于在Spring应用程序中启用定时任务的支持。它会自动注册TaskScheduler Bean,并允许开发者使用@Scheduled注解来声明定时任务。

源码解析

  @EnableScheduling注解通过导入SchedulingConfigurationAsyncConfiguration的实现来启用定时任务支持。

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Import(SchedulingConfiguration.class)
public @interface EnableScheduling {
}

  接着我将对上述代码进行详细的一个逐句解读,希望能够帮助到同学们,能以更快的速度对其知识点掌握学习,这也是我写此文的初衷,授人以鱼不如授人以渔,只有将其原理摸透,日后应对场景使用,才能得心应手,所以如果有基础的同学,可以略过如下代码分析步骤,然而没基础的同学,还是需要加强对代码的理解,方便你深入理解并掌握其常规使用。

这段Java代码展示了Spring框架中@EnableScheduling注解的定义。下面是对这个注解定义的逐行分析:

@Target(ElementType.TYPE)
  • @Target(ElementType.TYPE): 这个元注解指定了@EnableScheduling注解可以应用于Java类或接口上。这意味着它通常用于Spring配置类上,以启用类级别的配置。
@Retention(RetentionPolicy.RUNTIME)
  • @Retention(RetentionPolicy.RUNTIME): 这个元注解定义了@EnableScheduling注解的保留策略。RetentionPolicy.RUNTIME表示注解在编译后的字节码中会被保留,因此可以在运行时通过反射读取注解的信息。
@Documented
  • @Documented: 这个元注解指示@EnableScheduling注解应该被包含在JavaDoc中。这有助于生成的文档包含这些注解的信息,从而提高代码的可读性和可维护性。
@Import(SchedulingConfiguration.class)
  • @Import(SchedulingConfiguration.class): 这个元注解指示Spring容器在处理@EnableScheduling注解时,自动导入SchedulingConfiguration类。SchedulingConfiguration类提供了与定时任务相关的配置,如TaskScheduler Bean的定义。
public @interface EnableScheduling {
}
  • public @interface EnableScheduling: 这行代码声明了EnableScheduling是一个公共的注解类型。

@EnableScheduling注解的主要作用是启用Spring应用程序中的定时任务支持。通过在配置类上添加此注解,Spring会自动配置所需的基础设施,包括TaskScheduler Bean,并允许开发者使用@Scheduled注解来声明和配置定时执行的方法。

使用@EnableScheduling注解后,Spring会注册一个TaskScheduler Bean,通常是一个ScheduledExecutorService的实例,用于执行定时任务。开发者可以在需要执行定时任务的方法上使用@Scheduled注解,指定执行计划,如固定延迟、固定速率等。

这种机制简化了定时任务的配置和管理,使得开发者可以专注于定时任务的业务逻辑,而不必处理底层的调度细节。

  并附上部分相关注解源码截图,这里我就简单给附上,感兴趣的同学可以扒扒源码,深入去学习下开源框架的设计构思及理念,这也是掌握一个架构的核心目标,但是基础一般或者零基础的同学,建议先从使用上深入,而不是一口吃掉一个胖子,得不偿失。

  实际运用场景展示如下,这也是我日常项目开发中的实操之一,分享给大家看看,仅供参考:

案例分析

  考虑以下使用@EnableScheduling@Scheduled注解的Spring应用程序:

@SpringBootApplication
@EnableScheduling
public class SchedulingApplication {

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

    @Scheduled(fixedRate = 5000)
    public void reportCurrentTime() {
        System.out.println("The time is now: " + new Date());
    }
}

  在这个例子中,reportCurrentTime方法将每5秒执行一次,打印当前时间。

  接着我将对上述代码进行详细的一个逐句解读,希望能够帮助到同学们,能以更快的速度对其知识点掌握学习,这也是我写此文的初衷,授人以鱼不如授人以渔,只有将其原理摸透,日后应对场景使用,才能得心应手,所以如果有基础的同学,可以略过如下代码分析步骤,然而没基础的同学,还是需要加强对代码的理解,方便你深入理解并掌握其常规使用。

这段Java代码演示了如何在Spring Boot应用程序中使用@EnableScheduling注解来启用和执行定时任务。以下是对这段代码的详细解析:

类定义和注解

  • @SpringBootApplication: 这个注解是Spring Boot的便利注解,它包含了@Configuration@EnableAutoConfiguration@ComponentScan三个注解。它告诉Spring Boot自动配置应用程序,并扫描当前及子包中的Bean。

  • @EnableScheduling: 这个注解用于启用定时任务的支持。添加此注解后,Spring容器会扫描使用@Scheduled注解的方法,并按计划执行它们。

主函数

  • public static void main(String[] args): 这是Java应用程序的入口点。SpringApplication.run方法用于启动Spring Boot应用程序。

定时任务方法

  • @Scheduled(fixedRate = 5000): 这个注解声明了一个定时任务,fixedRate属性指定了任务应该每隔5000毫秒(5秒)执行一次。还有其它的计划选项,比如fixedDelaycron等。

  • public void reportCurrentTime(): 这是一个公共方法,没有参数和返回值。它被@Scheduled注解标记,因此会按照指定的计划执行。

  • System.out.println("The time is now: " + new Date());: 方法体中,使用System.out.println打印当前时间。new Date()创建了一个新的Date对象,表示当前的日期和时间。

应用场景

  这个应用程序可以作为一个简单的定时任务示例,适用于需要周期性执行的任务,如:

  • 定期记录系统状态。
  • 定时发送通知或提醒。
  • 定时执行数据备份或清理。

注意事项

  • 确保应用程序在支持定时任务的环境中运行,因为某些服务器环境可能限制了定时任务的执行。
  • 考虑任务执行的时间间隔和系统负载,避免过度消耗资源。
  • 处理可能的异常,确保定时任务的稳定性。

测试用例编写

  编写测试用例以验证定时任务的正确性:

@RunWith(SpringRunner.class)
@SpringBootTest
public class SchedulingApplicationTest {

    @Autowired
    private SchedulingApplication schedulingApplication;

    @Test
    public void testReportCurrentTimeScheduled() throws InterruptedException {
        // 模拟等待第一个定时任务执行
        Thread.sleep(6000); // 等待6秒以确保任务至少执行一次

        // 验证定时任务是否执行,例如检查日志输出或特定状态标记
        // 这里需要根据实际的实现细节来编写验证逻辑
    }
}

  这个测试用例使用了Spring TestContext框架来测试SchedulingApplication类。通过模拟等待并验证定时任务的执行结果,可以确保定时任务按预期工作。

  通过上述解析,我们可以看到@EnableScheduling@Scheduled注解如何简化在Spring Boot应用程序中实现定时任务的过程。这种机制使得开发者可以轻松地集成和执行周期性任务,而不必处理底层的调度细节。

应用场景案例列举

  @EnableScheduling注解通常应用于以下场景:

  • 定期执行任务:如定时数据备份、定时清理缓存等。
  • 周期性任务:如每小时检查一次系统状态。
  • 固定延迟任务:在方法执行结束后,等待固定时间再次执行。

优缺点分析

  使用@EnableScheduling注解的优点包括:

  • 简化配置:通过注解自动配置定时任务支持。
  • 易于使用:通过@Scheduled注解轻松声明定时任务。

缺点可能包括:

  • 性能考虑:不当的定时任务配置可能影响系统性能。
  • 错误处理:需要适当处理定时任务中的异常。

类代码方法介绍

  使用@EnableScheduling注解的类通常包含一个或多个使用@Scheduled注解的方法。

测试用例

  编写测试用例以验证定时任务的正确性:

public class SchedulingApplicationTest {

    public static void main(String[] args) {
        // 创建Spring应用上下文
        AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext();
        context.register(SchedulingApplication.class);
        context.refresh();

        // 获取定时任务的代理Bean
        Runnable task = context.getBean("reportCurrentTime", Runnable.class);

        // 模拟定时任务执行
        task.run();

        // 验证定时任务逻辑
        assertTrue(task instanceof MethodInvokingFactoryBean);
    }
}

  接着我将对上述代码进行详细的一个逐句解读,希望能够帮助到同学们,能以更快的速度对其知识点掌握学习,这也是我写此文的初衷,授人以鱼不如授人以渔,只有将其原理摸透,日后应对场景使用,才能得心应手,所以如果有基础的同学,可以略过如下代码分析步骤,然而没基础的同学,还是需要加强对代码的理解,方便你深入理解并掌握其常规使用。

这段Java代码是一个简单的测试示例,用于验证Spring应用程序中的定时任务是否能够正确执行。以下是对这段代码的详细解析:

测试类定义

  • public class SchedulingApplicationTest: 定义了一个名为SchedulingApplicationTest的测试类。

主函数

  • public static void main(String[] args): Java程序的入口点,这里用作执行测试。

创建Spring应用上下文

  • AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext();: 创建了Spring的AnnotationConfigApplicationContext实例,这是用于注册和加载配置类的应用上下文。

  • context.register(SchedulingApplication.class);: 注册了SchedulingApplication类作为配置类。

  • context.refresh();: 刷新应用上下文,这会触发Spring的初始化流程,包括Bean的创建和@PostConstruct注解方法的执行。

获取定时任务的代理Bean

  • Runnable task = context.getBean("reportCurrentTime", Runnable.class);: 通过应用上下文获取名为"reportCurrentTime"的Bean,并将其强制转换为Runnable类型。这里假设reportCurrentTime方法被Spring代理为一个Runnable Bean。

模拟定时任务执行

  • task.run();: 调用Runnable接口的run方法,这将执行定时任务的逻辑。

验证定时任务逻辑

  • assertTrue(task instanceof MethodInvokingFactoryBean);: 使用断言来验证task对象是否是MethodInvokingFactoryBean的实例。这表明任务是通过反射调用目标方法的代理Bean。

注意事项

  • 测试用例中的assertTrue方法来自JUnit框架,需要导入相应的类。
  • 测试用例假设reportCurrentTime方法被注册为一个名为"reportCurrentTime"的Bean。在实际的Spring应用程序中,Bean的名称可能不是方法名,需要根据实际的配置来调整。
  • 由于@Scheduled注解的Bean通常是通过代理创建的,直接获取方法引用可能不会返回MethodInvokingFactoryBean。这个测试用例可能需要根据实际的Spring版本和配置进行调整。

示例代码扩展

  在实际的测试中,我们可能需要使用Mockito或其他测试工具来模拟和验证定时任务的行为:

@Test
public void testScheduledTaskExecution() {
    // 创建Spring应用上下文和注册配置类
    // ...

    // 模拟外部依赖或配置
    // ...

    // 触发定时任务执行
    Runnable task = context.getBean("reportCurrentTime", Runnable.class);
    task.run();

    // 验证定时任务是否产生了预期的结果
    // 例如,检查日志、数据库记录或其他状态变化
    // ...
}

  这个扩展示例展示了如何在测试中使用Spring的应用上下文来创建和管理Bean,并触发定时任务的执行。通过验证任务的执行结果,可以确保定时任务按预期工作。

小结

  在当今快节奏的软件开发环境中,定时任务已成为后端服务不可或缺的一部分。Spring框架通过@EnableScheduling注解,为开发者提供了一种声明式的方式来处理这些任务,极大地简化了定时任务的配置和管理。本文从基础概念出发,深入探讨了@EnableScheduling注解的工作原理、使用方法以及在Spring Boot应用中的实践案例。

  通过实际代码示例,我们学习了如何使用@Scheduled注解来定义任务的执行计划,包括固定延迟、固定速率以及复杂的Cron表达式。案例分析展示了如何将定时任务应用于数据备份、状态检查等常见场景。同时,我们也讨论了使用@EnableScheduling注解的优缺点,指出了在配置定时任务时可能遇到的问题,并提供了相应的解决方案。

  此外,本文还提供了测试用例的编写示例,强调了在开发过程中验证定时任务正确性的重要性。通过JUnit和Mockito等测试工具,我们能够模拟定时任务的执行环境,确保任务按预期工作。

总结

  @EnableScheduling注解作为Spring框架中处理定时任务的关键工具,其强大之处在于简化了任务的配置和调度过程。通过本文的学习,我们不仅掌握了如何声明和管理定时任务,还学会了如何编写测试用例来验证这些任务的行为。这种能力对于构建可靠和高效的后端服务至关重要。

  随着技术的不断演进,@EnableScheduling注解将继续在Spring生态中发挥重要作用,助力开发者构建更加健壮、灵活的应用程序。让我们持续关注和学习,掌握更多高效工具和最佳实践,共同推动软件行业的发展。


  本文的探讨和分析旨在提供一个全面的视角,帮助开发者深入理解并有效利用@EnableScheduling注解。希望每位读者都能从中获得有价值的信息和启发,将这些知识应用到实际开发中,不断提升自己的技术水平和专业能力。

… …

  ok,以上就是我这期的全部内容啦,若想学习更多,你可以持续关注我,我会把这个多线程篇系统性的更新,保证每篇都是实打实的项目实战经验所撰。只要你每天学习一个奇淫小知识,日积月累下去,你一定能成为别人眼中的大佬的!功不唐捐,久久为功!

「赠人玫瑰,手留余香」,咱们下期拜拜~~

🌊热文推荐

滴~如下推荐【Spring Boot 进阶篇】的学习大纲,请小伙伴们注意查收。

Spring Boot进阶(01):使用Spring Boot和Redis轻松实现高性能、高可用的缓存服务。

Spring Boot进阶(02):防止程序员疯狂 Debug:快速掌握 Validation 参数校验技巧,让你的代码健康起来!

Spring Boot进阶(03):【实战教程】MyBatis-Plus秒级实现字段自动填充,让你的代码更优雅!

Spring Boot进阶(04):震惊!使用MyBatis-Plus,快速实现自定义SQL分页功能!

Spring Boot进阶(05):Spring Boot与RabbitMQ完美融合,打造高效消息队列服务!

Spring Boot进阶(06):【超详细】Windows10搭建RabbitMQ Server服务端,让你轻松实现消息队列管理!

Spring Boot进阶(07):如何使用EasyPoi实现Java中Excel的导入导出?完整教程请收藏,让你的Excel操作更高效!

Spring Boot进阶(08):使用EasyPoi实现Excel/Word携带图片导出,打造精美的报表

Spring Boot进阶(09):用EasyPoi实现Excel多sheet导入导出,轻松管理海量数据!

Spring Boot进阶(10):「从Excel到PDF,EasyPoi助你一键完美转换!」

Spring Boot进阶(11):实现纯文本转成.csv格式文件,Spring Boot轻松搞定!附完整代码

Spring Boot进阶(12):如何快速获取Excel文件中的Sheet页数量?Spring Boot教程带你一步步实现

Spring Boot进阶(13):如何优雅获取@ApiModelProperty(value = “序列号“, name = “uuid“)中的value值,附源码

Spring Boot进阶(14):Spring Boot高级应用:手把手教你连接数据库并获取指定表结构!一文教会你

Spring Boot进阶(15):用Spring Boot实现动态数据库分页查询表结构信息!

Spring Boot进阶(16):使用Redis实现手机验证码功能,让你的用户注册更加便捷!

Spring Boot进阶(17):Swagger2高级配置:定制header请求头等参数

Spring Boot进阶(18):轻松管理定时任务!Spring Boot@Scheduled让你事半功倍

Spring Boot进阶(19):探索ElasticSearch:如何利用Spring Boot轻松实现高效数据搜索与分析

Spring Boot进阶(20):「打造高性能Web应用」——使用Jetty容器配置Spring Boot

Spring Boot进阶(21):优化Spring Boot应用性能,使用Undertow容器提升响应速度

Spring Boot进阶(22):决战容器之巅:Tomcat vs Undertow!性能对比分析揭秘最佳选择!

Spring Boot进阶(23):终极解决方案!教你实现高效文件上传!

Spring Boot进阶(24):秒传!快速实现高效多文件上传的最佳解决方案

Spring Boot进阶(25):如何写出高效的文件上传单元测试?让你的测试更智能更高效!

Spring Boot进阶(26):从小白到高手,掌握Mybatis中resultType和resultMap的秘密!

Spring Boot进阶(27):Spring Boot进阶(27):Kafka大显身手,快速构建消息驱动应用!(环境搭建+演示)

Spring Boot进阶(28):如何让Spring Boot应用在Linux中以后台服务方式启动,并实现滚动日志查看及保存至实体文件?

Spring Boot进阶(29):如何正确使用Spring Boot注解@PathVariable、@RequestParam和@RequestBody: Postman演示教程

Spring Boot进阶(30):@RestController与@Controller的区别及使用场景详解,附带精彩实战演示

… …

  若想系统性的从0到1的入门进阶学习,可以参考这篇专栏总结《2024最新首发,全网最全 Spring Boot 学习宝典(附思维导图)》本专栏致力打造全网最硬核 Spring Boot 学习及进阶SpringBoot 系列教学内容,🚀均为全网独家首发,致力打造精品硬核干货,专栏永持续更新。欢迎大家订阅学习。一分耕耘一份收获!

  如果想快速定位学习,可以看这篇【一站式教程导航】,你想学习的都被收录系统整理在内,以最快的速度投入并学习掌握!!你值得拥有。

  在入门及进阶之途,我必助你一臂之力,系统性学习,从入门到精通,带你不走弯路,直奔终点!投资自己,性价比永远最高,都这么说了,你还不赶紧来白嫖??

  本文涉及所有源代码,均已上传至GitHub开源,供同学们一对一参考 GitHub传送门,同时,原创开源不易,欢迎给个star🌟,想体验下被🌟的感jio,非常感谢❗

📣文末

我是bug菌,CSDN | 掘金 | InfoQ | 51CTO | 华为云 | 阿里云 | 腾讯云 等社区博客专家,C站博客之星Top30,华为云2023年度十佳博主,掘金多年度人气作者Top40,掘金等各大社区签约作者,51CTO年度博主Top12,掘金/InfoQ/51CTO等社区优质创作者;全网粉丝合计 30w+;硬核微信公众号「猿圈奇妙屋」,欢迎你的加入!免费白嫖最新BAT互联网公司面试真题、4000G PDF电子书籍、简历模板等海量资料,你想要的我都有,关键是你不来拿哇。

【版权声明】本文为华为云社区用户原创内容,转载时必须标注文章的来源(华为云社区)、文章链接、文章作者等基本信息, 否则作者和本社区有权追究责任。如果您发现本社区中有涉嫌抄袭的内容,欢迎发送邮件进行举报,并提供相关证据,一经查实,本社区将立刻删除涉嫌侵权内容,举报邮箱: cloudbbs@huaweicloud.com
  • 点赞
  • 收藏
  • 关注作者

评论(0

0/1000
抱歉,系统识别当前为高风险访问,暂不支持该操作

全部回复

上滑加载中

设置昵称

在此一键设置昵称,即可参与社区互动!

*长度不超过10个汉字或20个英文字符,设置后3个月内不可修改。

*长度不超过10个汉字或20个英文字符,设置后3个月内不可修改。