Spring Task使用介绍

本文介绍了Spring框架中的SpringTask组件,如何使用cron表达式来定时执行Java代码,包括全注解方式的实现步骤和示例。并通过代码仓库提供了实践案例。

Spring Task

介绍

Spring Task 是Spring框架提供的任务调度工具,可以按照约定的时间自动执行某个代码逻辑。

定位定时任务框架

作用定时自动执行某段Java代码

为什么要在Java程序中使用Spring Task?

应用场景:

1). 信用卡每月还款提醒

在这里插入图片描述

2). 银行贷款每月还款提醒
在这里插入图片描述

3). 火车票售票系统处理未支付订单

在这里插入图片描述

**强调:**只要是需要定时处理的场景都可以使用Spring Task

cron表达式

cron表达式其实就是一个字符串,通过cron表达式可以定义任务触发的时间

**构成规则:**分为6或7个域,由空格分隔开,每个域代表一个含义

每个域的含义分别为:秒、分钟、小时、日、月、周、年(可选)

举例:

2022年10月12日上午9点整 对应的cron表达式为:0 0 9 12 10 ? 2022

说明:一般的值不同时设置,其中一个设置,另一个用?表示。

**比如:**描述2月份的最后一天,最后一天具体是几号呢?可能是28号,也有可能是29号,所以就不能写具体数字。

为了描述这些信息,提供一些特殊的字符。这些具体的细节,我们就不用自己去手写,因为这个cron表达式,它其实有在线生成器。

cron表达式在线生成器:https://cron.qqe2.com/

在这里插入图片描述

可以直接在这个网站上面,只要根据自己的要求去生成corn表达式即可。所以一般就不用自己去编写这个表达式。

通配符:

* 表示所有值;

? 表示未说明的值,即不关心它为何值;

- 表示一个指定的范围;

, 表示附加一个可能值;

/ 符号前表示开始时间,符号后表示每次递增的值;

cron表达式案例:

*/5 * * * * ? 每隔5秒执行一次

0 */1 * * * ? 每隔1分钟执行一次

0 0 5-15 * * ? 每天5-15点整点触发

0 0/3 * * * ? 每三分钟触发一次

0 0-5 14 * * ? 在每天下午2点到下午2:05期间的每1分钟触发

0 0/5 14 * * ? 在每天下午2点到下午2:55期间的每5分钟触发

0 0/5 14,18 * * ? 在每天下午2点到2:55期间和下午6点到6:55期间的每5分钟触发

0 0/30 9-17 * * ? 朝九晚五工作时间内每半小时

0 0 10,14,16 * * ? 每天上午10点,下午2点,4点

入门案例

Spring Task使用步骤

Spring 3.0以后核心包自带了task 调度工具,我们只需要创建spring boot 3.0,然后便可以直接使用task调度工具。

1). 启动类添加注解 @EnableScheduling 开启任务调度

2). 自定义定时任务类

全注解的方式

  1. 在业务方法上提供注解 @Component @Scheduled

  2. 在启动类上开启注解支持 @EnableScheduling

@Scheduled所支持的参数

  1. cron:cron表达式,指定任务在特定时间执行;

  2. fixedDelay:表示上一次任务执行完成后多久再次执行,参数类型为long,单位ms;

  3. fixedDelayString:与fixedDelay含义一样,只是参数类型变为String;

  4. fixedRate:表示按一定的频率执行任务,参数类型为long,单位ms;

  5. fixedRateString: 与fixedRate的含义一样,只是将参数类型变为String;

  6. initialDelay:表示延迟多久再第一次执行任务,参数类型为long,单位ms;

  7. initialDelayString:与initialDelay的含义一样,只是将参数类型变为String;

  8. zone:时区,默认为当前时区,一般没有用到。

代码开发

整体架构
在这里插入图片描述

编写定时任务类:

在MyTask.java文件添加以下内容

package com.onenewcode.mytask.task;

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

@Component
public class MyTask {
    /*
    cron表达式 30秒进行一次
     */
    @Scheduled(cron = "0/30 * * * * ? ")
    public void processCorn(){
        System.out.println("corn 测试 30秒运行一次");
    }
    @Scheduled(fixedDelay = 10000)
    public void processFixedDelay(){
        System.out.println("fixedDelay 表示上一次任务执行完成后10000ms再次执行一次");
    }
    @Scheduled(fixedRate = 50000)
    public void processFixedRate(){
        System.out.println("corn 一定的频率执行任务,50000ms执行一次");
    }
//    此版本会失败
//    @Scheduled(initialDelayString = "35000")
//    public void processInitialDelay(){
//        System.out.println("延迟任务,35000ms执行一次");
//    }
}

开启任务调度:

启动类添加注解 @EnableScheduling

package com.onenewcode.mytask;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.scheduling.annotation.EnableScheduling;

@SpringBootApplication
@EnableScheduling
public class MyTaskApplication {

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

}

测试结果

在这里插入图片描述

代码仓库

https://github.com/onenewcode/MyTask
### Spring Task 使用指南 #### 1. Spring Task 基本概念 Spring Task 是一种轻量级的任务调度框架,支持通过简单的注解或 XML 配置来实现定时任务的功能。它主要依赖于 `@Scheduled` 和 `ThreadPoolTaskScheduler` 来完成任务的计划和执行。 --- #### 2. 示例代码:基本配置与使用方法 以下是基于注解方式的一个简单示例: ```java // 启用 Scheduled 支持 @SpringBootApplication @EnableScheduling public class TaskApplication { public static void main(String[] args) { SpringApplication.run(TaskApplication.class, args); } } ``` 定义一个带有 `@Scheduled` 注解的方法: ```java @Component public class MyTask { @Scheduled(cron = "0/5 * * * * ?") // 每隔 5 秒钟执行一次 public void performTask() { System.out.println("当前时间:" + LocalDateTime.now()); } @Scheduled(fixedRate = 10000) // 每隔 10 秒钟执行一次 public void fixedRateTask() { System.out.println("Fixed Rate Task 执行时间:" + LocalDateTime.now()); } } ``` --- #### 3. 高级功能:动态修改 Cron 表达式 如果需要在运行时动态更改任务的时间安排,则可以借助 `ThreadPoolTaskScheduler` 实现[^3]。下面是一个完整的例子: ```java @Service public class DynamicTaskService { @Autowired private ThreadPoolTaskScheduler taskScheduler; private final AtomicReference<ScheduledFuture<?>> scheduledFutureRef = new AtomicReference<>(); public void startDynamicTask() { stopDynamicTask(); scheduledFutureRef.set( taskScheduler.schedule(() -> System.out.println("动态任务执行时间:" + LocalDateTime.now()), new CronTrigger("*/5 * * * * ?"))); // 初始设置每 5 秒触发一次 } public void changeCronExpression(String cronExpr) { stopDynamicTask(); scheduledFutureRef.set( taskScheduler.schedule(() -> System.out.println("更新后的动态任务执行时间:" + LocalDateTime.now()), new CronTrigger(cronExpr))); } public void stopDynamicTask() { ScheduledFuture<?> future = scheduledFutureRef.getAndSet(null); if (future != null && !future.isDone()) { future.cancel(true); } } } ``` 调用该服务类中的方法即可控制任务启动、停止以及动态调整 Cron 表达式。 --- #### 4. 配置说明 为了使 Spring Task 正常工作,通常需要在项目的 `application.properties` 或 `application.yml` 文件中进行一些必要的配置。 ##### (1)启用线程池 默认情况下,Spring Task 使用单一线程处理所有任务。可以通过如下配置增加并发能力[^3]: ```properties spring.task.scheduling.pool.size=5 ``` 这表示最多允许同时运行 5 个任务。 ##### (2)自定义线程池(可选) 对于更复杂的场景,可能需要完全掌控线程池的行为。此时可通过 Java Bean 定义自己的 `TaskScheduler` 实例: ```java @Configuration public class SchedulerConfig { @Bean public TaskScheduler taskScheduler() { ThreadPoolTaskScheduler scheduler = new ThreadPoolTaskScheduler(); scheduler.setPoolSize(10); // 设置线程池大小为 10 scheduler.setThreadNamePrefix("task-scheduler-"); return scheduler; } } ``` --- #### 5. 注意事项 - **重复执行问题** 如果发现某些任务被多次执行,请检查是否存在多个应用实例部署的情况。分布式环境下建议引入 Redis 或数据库锁机制防止冲突[^3]。 - **Cron 表达式的正确性** 确保提供的 Cron 表达式语法无误,并且符合预期行为。推荐在线工具验证其合法性。 --- ###
评论
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
红包 添加红包
表情包 插入表情
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

过去日记

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值