Spring Boot 中啟用定時任務的操作方法

更新時間：2024年11月15日 09:33:15 作者：種樹人20240819

文章主要介紹了如何在Spring Boot中啟用定時任務,包括使用@EnableScheduling注解、配置項控制定時任務是否開啟以及如何關閉cron定時任務,感興趣的朋友跟隨小編一起看看吧

添加 @EnableScheduling 注解

可以添加在 Application 類上

@SpringBootApplication
@EnableScheduling
public class Application {
    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }
}

定義定時任務類和方法

定時任務類要注冊為Spring IoC 容器的 Bean，或者通過 @Bean 將某個方法的返回值（返回值為定時任務類對象）注冊為 Spring IoC 的Bean。

package com.cmcc.nlpt.sitemessage.task;
import org.springframework.scheduling.annotation.Scheduled;
import org.springframework.stereotype.Component;
@Component
public class ScheduledTask {
    /**
     * 每日0點執(zhí)行
     */
    @Scheduled (cron = "0 0 0 * * ?")
    public void doCronTask() {
    }
    /**
     * 本次任務結束到下次任務開始的時間間隔為5秒
     */
    @Scheduled (fixedDelay = 5000)
    public void doFixedDelayTask() {
    }
    /**
     * 兩次任務開始時間間間隔為5秒
     */
    @Scheduled(fixedRate = 5000)
    public void doFixedRateTask() {
    }
    /**
     * 第一次任務啟動延時1秒，后續(xù)任務結束到下次任務開始的時間間隔為5秒
     */
    @Scheduled(initialDelay = 1000, fixedDelay = 5000)
    public void doInitialDelayTask() {
    }
}

通過配置項控制定時任務是否開啟

方法一 @ConditionalOnProperty

此方法是控制任務類是否注冊為 Spring IoC 的 Bean，可以控制上述所有類型的定時任務是否注冊。

# enabled 配置為 false 時定時任務就不會開啟
scheduled-task:
  enabled: true

@Component
@ConditionalOnProperty(name = "scheduled-task.enabled", havingValue = "true")
public class ScheduledTask {
    /**
     * 每日0點執(zhí)行
     */
    @Scheduled (cron = "0 0 0 * * ?")
    public void doCronTask() {
    }
    /**
     * 本次任務結束到下次任務開始的時間間隔為5秒
     */
    @Scheduled (fixedDelay = 5000)
    public void doFixedDelayTask() {
    }
    /**
     * 兩次任務開始時間間間隔為5秒
     */
    @Scheduled(fixedRate = 5000)
    public void doFixedRateTask() {
    }
    /**
     * 第一次任務啟動延時1秒，后續(xù)任務結束到下次任務開始的時間間隔為5秒
     */
    @Scheduled(initialDelay = 1000, fixedDelay = 5000)
    public void doInitialDelayTask() {
    }
}

方法二 Boolean 標志位

使用此方法定時任務還是會被調度執(zhí)行，只是在任務執(zhí)行時什么都不做，也可以控制上述所有類型的定時任務。

scheduled-task:
  enabled: true

@Component
@ConditionalOnProperty(name = "scheduled-task.enabled", havingValue = "true")
public class ScheduledTask {
    @Value("${scheduled-task.enabled}")
    private Boolean taskEnabled;
    @Scheduled (fixedDelay = 5000)
    public void doFixedDelayTask() {
        if (!taskEnabled) {
            return;
        }
        System.out.println("start to doFixedDelayTask");
    }
}

使用"-"使 cron 定時任務關閉

此方法只適用于 cron 類型的定時任務，不適用于其它類型的定時任務。

注意：yml 文件中配置 - 時要加上雙引號或單引號，否則會報錯。

關閉 cron 定時任務的配置：

scheduled-task:
  cron: "-"

開始 cron 定時任務的配置，將 cron 表達式配置上即可：

scheduled-task:
  cron: 0 0 0 * * ?

@Component
public class ScheduledTask {
    /**
     * 每日0點執(zhí)行
     */
    @Scheduled (cron = "${scheduled-task.cron}")
    public void doCronTask() {
    }
}