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

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

yuyutoo 2024-10-12 00:07 8 浏览 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,大数据等。资料包含视频文档以及源码,同时分享本人及投递的优质技术博文。

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

相关推荐

深度解读Spring框架的核心原理

深度解读Spring框架的核心原理在Java开发的世界里,提到Spring框架,就像提起一位久经沙场的老将,它几乎成了企业级应用开发的代名词。那么,这个被无数开发者膜拜的框架究竟有何独特之处?今天,我...

「Spring认证」Spring 框架概述

Spring是最流行的企业Java应用程序开发框架。全球数以百万计的开发人员使用SpringFramework来创建高性能、易于测试和可重用的代码。Spring框架是一个开源的Java...

学习Spring框架 这一篇就够了

1.spring概述1.1Spring是什么(理解)...

Spring框架双核解析:IOC与AOP的本质与实战

#Spring核心#IOC容器#AOP编程#Java框架设计...

Spring Boot与传统Spring框架的对比:探索Java开发的新境界

SpringBoot与传统Spring框架的对比:探索Java开发的新境界在Java生态系统中,Spring框架无疑是一个里程碑式的存在。从最初的简单依赖注入容器,到如今覆盖企业级开发方方面面的庞大...

Spring MVC框架源码深度剖析:从入门到精通

SpringMVC框架源码深度剖析:从入门到精通SpringMVC框架简介SpringMVC作为Spring框架的一部分,为构建Web应用程序提供了强大且灵活的支持。它遵循MVC(Model-V...

Spring框架入门

一.spring是什么?Spring是分层...

程序员必知必会技能之Spring框架基础——面向切面编程!

面向切面编程AOP(AspectOrientedProgramming)与OOP(ObjectOrientedProgramming,面向对象编程)相辅相成。AOP提供了与OOP不同的抽象软件结...

Spring Security安全框架深度解读:为你的应用穿上“钢铁铠甲”

SpringSecurity安全框架深度解读:为你的应用穿上“钢铁铠甲”在现代网络世界里,保护我们的应用程序免受各种威胁攻击至关重要。而在这个过程中,SpringSecurity框架无疑是我们最可...

Spring框架的设计哲学与实现:打造轻量级的企业级Java应用

Spring框架的设计哲学与实现:打造轻量级的企业级Java应用Spring框架自2003年诞生以来,已成为企业级Java应用开发的代名词。它不仅仅是一个框架,更是一种设计理念和哲学的体现。本文将带你...

Spring框架深度解析:从核心原理到底层实现的全方位避坑指南

一、Spring框架核心概念解析1.控制反转(IoC)与依赖注入(DI)Spring的核心思想是通过IoC容器管理对象的生命周期和依赖关系。传统开发中,对象通过new主动创建依赖对象,导致高耦合;而S...

Java框架 —— Spring简介

简介一般来说,Spring指的是SpringFramework,它提供了很多功能,例如:控制反转(IOC)、依赖注入...

Spring 框架概述,模块划分

Spring框架以控制反转(InversionofControl,IoC)和面向切面编程(Aspect-OrientedProgramming,AOP)为核心,旨在简化企业级应用开发,使开发者...

spring框架怎么实现依赖注入?

依赖注入的作用就是在使用Spring框架创建对象时,动态的将其所依赖的对象注入到Bean组件中,其实现方式通常有两种,一种是属性setter方法注入,另一种是构造方法注入。具体介绍如下:●属性set...

Spring框架详解

  Spring是一种开放源码框架,旨在解决企业应用程序开发的复杂性。一个主要优点就是它的分层体系结构,层次结构让你可以选择要用的组件,同时也为J2EE应用程序开发提供了集成框架。  Spring特征...

取消回复欢迎 发表评论: