spring @Scheduled定時任務注解使用方法及注意事項小結

更新時間：2025年02月08日 11:17:23 作者：angen2018

Spring的@Scheduled注解用于定時任務調度,默認單線程依次執(zhí)行,可以通過配置多線程調度器或使用@Async注解實現并行執(zhí)行,常見參數包括cron、fixedRate、fixedDelay、initialDelay等,本文介紹spring @Scheduled定時任務注解使用方法,感興趣的朋友一起看看吧

@Scheduled 注解是 Spring 提供的一個注解式定時任務調度工具，用于簡化定時任務的實現。它的默認行為是單線程執(zhí)行，即任務默認在同一個線程中依次執(zhí)行。如果任務拋出異?；驁?zhí)行時間過長，可能會影響后續(xù)任務的調度。

在 Spring 中，使用 @Scheduled 注解定義的多個定時任務默認是單線程依次執(zhí)行的。這意味著，如果多個定時任務被觸發(fā)在同一時間執(zhí)行，它們會按照任務注冊的順序依次執(zhí)行，而不是并行執(zhí)行。

默認行為

單線程執(zhí)行：Spring 的 @Scheduled 注解默認使用單線程調度器（SimpleScheduledExecutor），因此多個任務會串行執(zhí)行。
任務阻塞：如果一個任務執(zhí)行時間過長，會阻塞后續(xù)任務的執(zhí)行。

如何實現并行執(zhí)行

如果需要多個定時任務并行執(zhí)行，可以通過以下方法實現：

方法 1：配置多線程調度器

可以通過配置 ThreadPoolTaskScheduler 來為 @Scheduled 任務提供一個線程池，從而允許多個任務并行執(zhí)行。

示例代碼：

@Configuration
public class ScheduleConfig {
    @Bean
    public ThreadPoolTaskScheduler taskScheduler() {
        ThreadPoolTaskScheduler scheduler = new ThreadPoolTaskScheduler();
        scheduler.setPoolSize(5); // 設置線程池大小
        scheduler.setThreadNamePrefix("my-scheduled-task-");
        return scheduler;
    }
}

在 @Scheduled 注解中指定使用自定義調度器：

@Scheduled(fixedRate = 5000, scheduler = "taskScheduler")
public void task1() {
    // 任務內容
}

方法 2：使用 @Async注解

可以通過結合 @Async 注解和 @EnableAsync 注解，使每個 @Scheduled 任務在獨立的線程中異步執(zhí)行。

示例代碼：

@Configuration
@EnableAsync
public class AsyncConfig {
    @Bean
    public TaskScheduler taskScheduler() {
        ThreadPoolTaskScheduler scheduler = new ThreadPoolTaskScheduler();
        scheduler.setPoolSize(5); // 設置線程池大小
        return scheduler;
    }
}

在任務方法上添加 @Async 注解：

@Async
@Scheduled(fixedRate = 5000)
public void task1() {
    // 任務內容
}

方法 3：通過配置文件設置線程池大小

在 Spring Boot 中，可以通過配置文件直接設置 spring.task.scheduling.pool.size 屬性來增加線程池大小。

示例配置：

spring.task.scheduling.pool.size=5

總結

默認行為：@Scheduled 注解默認是單線程依次執(zhí)行。
并行執(zhí)行：可以通過配置多線程調度器或使用 @Async 注解實現并行執(zhí)行。
推薦方式：配置多線程調度器（ThreadPoolTaskScheduler）是最常用的方式，適合大多數場景。

通過以上方法，可以輕松實現多個定時任務的并行執(zhí)行！

以下是 @Scheduled 注解的參數大全及其詳細說明：

1. cron

含義：指定一個 cron 表達式，用于定義任務的執(zhí)行時間。
格式：cron 表達式由 6 或 7 個字段組成，分別表示秒、分、小時、日、月、星期（和年）。
示例：
- 每隔 5 秒執(zhí)行一次：0/5 * * * * *
- 每天 23 點執(zhí)行一次：0 0 23 * * *
- 每月 1 號凌晨 1 點執(zhí)行一次：0 0 1 1 * *

2. zone

含義：指定時區(qū)，用于解析 cron 表達式。
類型：String，默認值為空字符串，表示使用服務器的默認時區(qū)。
示例：Asia/Shanghai

3. fixedRate

含義：指定任務以固定的時間間隔執(zhí)行，單位為毫秒。
類型：long，默認值為 -1，表示不使用固定速率。
示例：@Scheduled(fixedRate = 5000) 表示每隔 5 秒執(zhí)行一次

4. fixedRateString

含義：與 fixedRate 類似，但使用字符串類型，支持占位符。
類型：String，默認值為空字符串。
示例：@Scheduled(fixedRateString = "5000") 表示每隔 5 秒執(zhí)行一次

5. fixedDelay

含義：指定任務在上一次執(zhí)行結束后，經過固定的時間間隔再執(zhí)行下一次，單位為毫秒。
類型：long，默認值為 -1，表示不使用固定延遲。
示例：@Scheduled(fixedDelay = 5000) 表示上一次任務執(zhí)行結束后，等待 5 秒再執(zhí)行下一次

6. fixedDelayString

含義：與 fixedDelay 類似，但使用字符串類型，支持占位符。

類型：String，默認值為空字符串。

示例：@Scheduled(fixedDelayString = "5000") 表示上一次任務執(zhí)行結束后，等待 5 秒再執(zhí)行下一次

7. initialDelay

含義：指定任務首次執(zhí)行前的延遲時間，單位為毫秒。
類型：long，默認值為 -1，表示不使用初始延遲。
示例：@Scheduled(initialDelay = 5000, fixedRate = 10000) 表示首次延遲 5 秒后執(zhí)行，之后每隔 10 秒執(zhí)行一次

8. initialDelayString

含義：與 initialDelay 類似，但使用字符串類型，支持占位符。
類型：String，默認值為空字符串。
示例：@Scheduled(initialDelayString = "5000", fixedRateString = "10000") 表示首次延遲 5 秒后執(zhí)行，之后每隔 10 秒執(zhí)行一次

9. CRON_DISABLED