Spring @Scheduled注解及工作原理

目录

• 1.@Scheduled注解定义
• 2.配置 @Scheduled
• 2.1 开启定时任务支持
• 2.2 创建定时任务
• 3. 常用属性
• 3.1 fixedRate
• 3.2 fixedDelay
• 3.3 cron
• 4.工作原理
• 4.1 基于TaskSchedulphper
• 4.2 使用 ThreadPoolTaskScheduler
• 4.3 定时任务的执行流程
• 5. 延时执行的定时任务
• 5.1 创建定时任务类
• 5.2 解释
• 6.自定义TaskScheduler

1.@Scheduled注解定义

简单来说， @Scheduled是 Spring 提供的一个注解，用于在方法上标记定时任务。通过它，我们可以轻松地在指定的时间间隔或特定的时间点执行某些代码，而不需要引入额外的定时任务库。

举个例子：

假设你有一个方法需要每隔5分钟执行一次，你只需要在方法上加上 @Scheduled注解，并设置相应的属性即可。

2.配置 @Scheduled

在开始使用 @Scheduled 之前，我们需要做一些配置工作。首先，确保你的 Spring 项目中引入了 spring-boot-starter，因为它已经包含了必要的依赖。

2.1 开启定时任务支持

在你的主类（通常标注了 @SpringBootApplication 的类）上添加@EnableScheduling注解，以启用定时任务的支持。

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.scheduling.annotation.EnableScheduling;
@SpringBootApplication
@EnableScheduling
public class ScheduledDemoApplication {
    public static void main(String[] args) {
        SpringApplication.run(ScheduledDemoApplication.class, args);
    }
}

2.2 创建定时任务

接下来，我们创建一个服务类，并在其中定义一个定时任务方法。例如，每隔5秒打印一条消息：

import org.springframework.scheduling.annotation.Scheduled;
import org.springframework.stereotype.Component;
@Component
public class ScheduledTasks {
    @Scheduled(fixedRate = 5000)
 public void reportCurrentTime() {
        System.out.println("每5秒执行一次任务，当前时间：" + System.currentTimeMillis());
    }
}

3. 常用属性

@Scheduled 注解提供了多种方式来配置定时任务的执行时间，主要包括以下几种

3.1 fixedRatejavascript

指定一个固定的时间间隔，以毫秒为单位，表示上一次任务开始执行后，多久再次执行。

@Scheduled(fixedRate = 5000) // 每5秒执行一次
public void fixedRateTask() {
    System.out.println("Fixed Rate Task - " + System.currentTimeMillis());
}

3.2 fixedDelay

指定一个固定的时间间隔，表示上一次任务执行完成后，等待多久再次执行。

@Scheduled(fixedDelay = 5000) // 上一次任务完成后5秒执行一次
public void fixedDelayTask() {
    System.out.println("Fixed Delay Task - " + System.currentTimeMillis());
}

3.3 cron

使用 cron 表达式确地指定任务的执行时间。cron 表达式可以让你定义复杂的时间计划。

@Scheduled(cron = "0 0/1 * * * ?") // 每分钟执行一次
public void cronTask() {
    System.out.println("Cron Task - " + System.currentTimeMillis());
}

4.工作原理

了解了如何使用 @Scheduled，那么它背后到底是如何运作的呢？让我们来深入探讨一下。

4.1 基于TaskScheduler

Spring 的定时任务是基于 TaskScheduler 接口实现的。当我们在方法上使用 @Scheduled 注解时，Spring 会自动为其创建一个调度器，并按照我们定义的时间计划来执行任务

4.2 使用 ThreadPoolTaskScheduler

默认情况下，Spring 使用 ThreadPoolTaskScheduler 作为TaskScheduler的实现类。它内部维护了一个线程池，用于执行定时任务。这样可以确保多个定时任务能够并发执行，而不会阻塞主线程。

注意： 如果你的应用中有多个定时任务，或者某些任务执行时间较长，建议自定义ThreadPoolTaskScheduler的线程池大小，以避免任务堆积或资源浪费。

4.3 定时任务的执行流程

1、初始化阶段：启动 Spring 应用时，@EnableScheduling 注编程解会触发 Spring 的配置，扫描所有被 @Scheduled 注解标记的方法。

2、注册任务：所有符合条件的定时任务方法会被注册到 TaskScheduler 中。

3、执行任务：根据配置的时间计划，TaskScheduler 会调度并在合适的线程中执行相应的任务方法。

5. 延时执行的定时任务

为了更好地理解 @Scheduled 的使用，我们来实现一个稍微复杂些的示例——延时执行任务。假设我们有一个任务需要在应用启动后延时10秒执行一次，然后每隔5秒重复执行。

5.1 创建定时任务类

import org.springframework.scheduling.annotation.Scheduled;
import org.springframework.stereotype.Component;
@Component
publicclass DelayedScheduledTasks {
    privateboolean firstRun = true;
    @Scheduled(fixedRate = 5000, initialDelay = 10000)
    public void delayedTask() {
        if (firstRun) {
            System.out.println("延时10秒后首次执行任务，当前时间：" + System.currentTimeMillis());
            firstRun = false;
        } else {
            System.out.println("每5秒执行一次任务，当前时间：" + System.currentTimeMillis());
        }
    }
}

5.2 解释

fixedRate = 5000: 任务每5秒执行一次。

initialDelay = 10000: 应用启动后，延时10秒首次执行任务。

6.自定义TaskScheduler

有时候，默认的 ThreadPoolTaskScheduler 可能无法满足我们的需求，比如需要更高的并发能力或特定的线程名称模式。这时候，我们可以自定义一个 Ta编程客栈skScheduler Bean。

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuraphption;
import org.springframework.scheduling.concurrent.ThreadPoolTaskScheduler;
@Configuration
publicclass SchedulerConfig {
    @Bean
    public ThreadPoolTaskScheduler taskScheduler() {
        ThreadPoolTaskScheduler scheduler = new ThreadPoolTaskScheduler();
        scheduler.setPoolSize(10); // 设置线程池大小
        scheduler.setThreadNamePrefix("MyScheduler-"); // 设置线程名称前缀
        scheduler.initialize();
        return scheduler;
    }
}

通过上述配置，我们创建了一个拥有10个线程的线程池，并为每个线程命名，方便日志追踪和调试。

到此这篇关于Spring @Scheduled注解详解的文章就介绍到这了,更多相关Spring @Scheduled注解内容请搜索编程客栈(www.devze.com)以前的文章或继续浏览下面的相关文章希望大家以后多多支持编程客栈(www.devze.com)！