百度360必应搜狗淘宝本站头条
当前位置:网站首页 > 编程网 > 正文

四、springBoot 优雅的创建定时任务

yuyutoo 2024-10-12 00:07 11 浏览 0 评论

前言

好几天没写了,工作有点忙,最近工作刚好做一个定时任务统计的,所以就将springboot 如何创建定时任务整理了一下。总的来说,springboot创建定时任务是非常简单的,不用像spring 或者springmvc 需要在xml 文件中配置,在项目启动的时候加载。spring boot 使用注解的方式就可以完全支持定时任务。不过基础注解的话,可能有的需求定时任务的时间会经常变动,注解就不好修改,每次都得重新编译,所以想将定时时间存在数据库,然后项目读取数据库执行定时任务,所以就有了基于接口的定时任务。下面就分基于注解和基于接口详细讲解。

基于注解

pom.xml 文件不用修改,我们原本的项目就支持,其实定时器是springboot框架自带的,不用引入什么依赖。我们直接创建一个autotask 包,创建一个AutoTask类。

@EnableScheduling
@Component
@Slf4j
public class AutoTask {
 @Scheduled(cron="*/6 * * * * ?")
 private void process(){
 log.info("autoTask ");
 }
}

这样一个定时器就创建啦,在项目启动后,会每隔6s 打印“autoTask”的日志。是不是很简单。主要用到的两个注解就是@EnableScheduling 和 @Scheduled。注解@EnableScheduling 就是开启定时任务的。哪个类的中的方法想要定期执行,就在这个类上加入这个注解。当然这个这个注解也可以加在启动类上。加在启动类上表示项目中所有的类都可以创建定时任务。

@Scheduled 注解就是我们常见的定时器啦,后面的cron 就是定时任务表达式。在方法上注解,表示这个方法定期执行。

不过@Scheduled 可以进行两种配置,我们熟悉的cron ,还有一种是fixedRate。比如fixedRate=6000 表示方法每6秒钟执行一次。我们来启动项目看一下,可以看到两个方法都在定期执行。

基于接口

上面可以看到springboot 基于注解是非常方便的。但是对于频繁变动或者一个项目中有很多的定时器那就不方便管理了。所以统一将定时器信息存放在数据库中。

DROP TABLE IF EXISTS `scheduled`;
CREATE TABLE `scheduled` (
 `cron_id` varchar(30) NOT NULL PRIMARY KEY,
 `cron_name` varchar(30) NULL,
 `cron` varchar(30) NOT NULL
);
INSERT INTO `scheduled` VALUES ('1','定时器任务一','0/6 * * * * ?');

在dao 层mapper1包下创建一个CronMapper接口,很简单的就获取cron

public interface CronMapper {
 @Select("select cron from scheduled where cron_id = #{id}")
 public String getCron(int id);
}

这里我们就不写service 层了。直接在autotask 包下创建一个AutoTaskFromDB类

@Slf4j
@Component
public class AutoTaskFromDB implements SchedulingConfigurer {
 @Autowired
 protected CronMapper cronMapper;
 @Override
 public void configureTasks(ScheduledTaskRegistrar scheduledTaskRegistrar) {
 scheduledTaskRegistrar.addTriggerTask(() -> process(),
 triggerContext -> {
 String cron = cronMapper.getCron(1);
 if (cron.isEmpty()) {
 log.info("cron 为空");
 }
 return new CronTrigger(cron).nextExecutionTime(triggerContext);
 }
 );
 }
 private void process(){
 log.info("formDB ");
 }
}

可以看到也很简单,就是实现SchedulingConfigurer 这个吧接口,addTriggerTask()是添加一个定时器。process()方法是我们需要定时执行的方法体。CronTrigger(cron).nextExecutionTime(triggerContext) 就是从数据库读取的cron 创建定时器。

这个类我没有加上@EnableScheduling 注解,因为我在启动类上加上了,如果你们启动类上没有加,这里记得加上。

测试一下;下图可以看到三个定时任务都执行了,fromDB 是从数据库读取的。

cron

cron 用法网上有很多,也没有什么讲的这里就附带记录下

结构

cron表达式是一个字符串,分为6或7个域,每两个域之间用空格分隔,其语法格式为:"秒域 分域 时域 日域 月域 周域 年域"

取值范围

域名 可取值 可取符号(仅列部分常用) 秒域 0~59的整数 * - , / 分域 0~59的整数 * - , / 时域

0~23的整数 * - , / 日域

1~31的整数 * - , / ? L 月域

1~12的整数或JAN~DEC * - , / 周域

1~7的整数或SUN~SAT * - , / ? L # 年域

1970~2099的整数

* - , / 常例

番外

本来这个知识点不应该放在这里讲的,但是不多,顺带写了,刚好也能做定时器。我们项目中往往有一些需求需要在项目启动的时候就执行,那这个我们怎么实现了。其实spring boot 使用起来也非常简单,只用实现 ApplicationRunner 就好了。我们在autotask 包下创建一个AutoTaskFromSpringRunner类

@Slf4j
@Component
public class AutoTaskFromSpringRunner implements ApplicationRunner {
 @Override
 public void run(ApplicationArguments args) throws Exception {
 process();
 }
 private void process(){
 log.info(" run ApplicationArguments");
 }
}

启动项目看一下,可以发现这个会在项目启动后执行,但是只会执行一次。

那这个怎么用来做定时器呢?当然是结合线程来做啦,但是这个方法其实不建议,b毕竟线程很容易出问题,但是提供一种思路:

@Slf4j
@Component
public class AutoTaskFromSpringRunner implements ApplicationRunner {
 @Override
 public void run(ApplicationArguments args) throws Exception {
 process();
 new Thread(() -> {
 while (true) {
 process2();
 try {
 Thread.sleep(6000);
 } catch (InterruptedException e) {
 log.error("{}",e);
 }
 }
 }).start();
 }
 private void process(){
 log.info(" run ApplicationArguments");
 }
 private void process2(){
 log.info("线程定时器");
 }
}

启动项目看下,发现也是可以起到定时器的作用的。

好了,就说这么多啦,今天项目的代码也同步到github 上啦。github地址:https://github.com/QuellanAn/zlflovemm

后续加油?

欢迎大家关注个人公众号 "程序员爱酸奶"

分享各种学习资料,包含java,linux,大数据等。资料包含视频文档以及源码,同时分享本人及投递的优质技术博文。

如果大家喜欢记得关注和分享哟?

相关推荐

Python操作Word文档神器:python-docx库从入门到精通

Python操作Word文档神器:python-docx库从入门到精通动动小手,点击关注...

Python 函数调用从入门到精通:超详细定义解析与实战指南 附案例

一、函数基础:定义与调用的核心逻辑定义:函数是将重复或相关的代码块封装成可复用的单元,通过函数名和参数实现特定功能。它是Python模块化编程的基础,能提高代码复用性和可读性。定义语法:...

等这么长时间Python背记手册终于来了,入门到精通(视频400集)

本文毫无套路!真诚分享!前言:无论是学习任何一门语言,基础知识一定要扎实,基础功非常的重要,找一个有丰富编程经验的老师或者师兄带着你会少走很多弯路,你的进步速度也会快很多,无论我们学习的目的是什么,...

图解Python编程:从入门到精通系列教程(附全套速查表)

引言本系列教程展开讲解Python编程语言,Python是一门开源免费、通用型的脚本编程语言,它上手简单,功能强大,它也是互联网最热门的编程语言之一。Python生态丰富,库(模块)极其丰富,这使...

Python入门教程(非常详细)从零基础入门到精通,看完这一篇就够

本书是Python经典实例解析,采用基于实例的方法编写,每个实例都会解决具体的问题和难题。主要内容有:数字、字符串和元组,语句与语法,函数定义,列表、集、字典,用户输入和输出等内置数据结构,类和对象,...

Python函数全解析:从入门到精通,一文搞定!

1.为什么要用函数?函数的作用:封装代码,提高复用性,减少重复,提高可读性。...

Python中的单例模式:从入门到精通

Python中的单例模式:从入门到精通引言单例模式是一种常用的软件设计模式,它保证了一个类只有一个实例,并提供一个全局访问点。这种模式通常用于那些需要频繁创建和销毁的对象,比如日志对象、线程池、缓存等...

【Python王者归来】手把手教你,Python从入门到精通!

用800个程序实例、5万行代码手把手教你,Python从入门到精通!...

Python从零基础入门到精通:一个月就够了

如果想从零基础到入门,能够全职学习(自学),那么一个月足够了。...

Python 从入门到精通:一个月就够了

要知道,一个月是一段很长的时间。如果每天坚持用6-7小时来做一件事,你会有意想不到的收获。作为初学者,第一个月的月目标应该是这样的:熟悉基本概念(变量,条件,列表,循环,函数)练习超过30个编...

Python零基础到精通,这8个入门技巧让你少走弯路,7天速通编程!

Python学习就像玩积木,从最基础的块开始,一步步搭建出复杂的作品。我记得刚开始学Python时也是一头雾水,走了不少弯路。现在回头看,其实掌握几个核心概念,就能快速入门这门编程语言。来聊聊怎么用最...

神仙级python入门教程(非常详细),从0到精通,从看这篇开始!

python入门虽然简单,很多新手依然卡在基础安装阶段,大部分教程对一些基础内容都是一带而过,好多新手朋友,对一些基础知识常常一知半解,需要在网上查询很久。...

Python类从入门到精通,一篇就够!

一、Python类是什么?大家在生活中应该都见过汽车吧,每一辆真实存在、能在路上跑的汽车,都可以看作是一个“对象”。那这些汽车是怎么生产出来的呢?其实,在生产之前,汽车公司都会先设计一个详细的蓝图...

学习Python从入门到精通:30天足够了,这才是python基础的天花板

当年2w买的全套python教程用不着了,现在送给有缘人,不要钱,一个月教你从入门到精通1、本套视频共487集,本套视频共分4季...

30天Python 入门到精通(3天学会python)

以下是一个为期30天的Python入门到精通学习课程,专为零基础新手设计。课程从基础语法开始,逐步深入到面向对象编程、数据处理,最后实现运行简单的大语言模型(如基于HuggingFace...

取消回复欢迎 发表评论: