Spring Schedule如何動態(tài)添加修改定時任務(wù)

1、快速開始

通常情況下，我們使用的功能很簡單，只需要在配置類上加一個@EnableScheduling注解，然后在Bean對應(yīng)的方法上添加@Scheduled注解即可。但一般情況下，還會自定義對應(yīng)的線程池等信息，如下所示。

@EnableScheduling
@Configuration
public class SchedulerConfig implements SchedulingConfigurer {

    @Override
    public void configureTasks(ScheduledTaskRegistrar taskRegistrar) {
        ThreadPoolTaskScheduler taskScheduler = threadPoolTaskScheduler();
        taskRegistrar.setScheduler(taskScheduler);
    }

    @Bean
    public ThreadPoolTaskScheduler threadPoolTaskScheduler() {
        ThreadPoolTaskScheduler scheduler = new ThreadPoolTaskScheduler();
        scheduler.setPoolSize(Runtime.getRuntime().availableProcessors() / 3 + 1);
        scheduler.setThreadNamePrefix("scheduler-");
        scheduler.setRemoveOnCancelPolicy(true);
        return scheduler;
    }
}

@Scheduled注解通常有三種調(diào)度方式，fixedRate、fixedDelay和cron。

• fixedRate：定時執(zhí)行，如@Scheduled(fixedRate= 2000)會每隔兩秒執(zhí)行一次
• fixedDelay：固定延遲，如@Scheduled(fixedDelay= 2000)會在上次任務(wù)執(zhí)行完成后，延遲兩秒再觸發(fā)下一次
• cron：自定義規(guī)則，比較復(fù)雜，功能更強大

2、Schedule的動態(tài)修改

以cron表達式任務(wù)為例，在上面的基礎(chǔ)上，如果有如下定時任務(wù)，在每天凌晨一點執(zhí)行一次，但是后面發(fā)現(xiàn)時間不合適，需要修改觸發(fā)時間為凌晨兩點，按照現(xiàn)有的方式，通常只能修改代碼重新部署了。

@Scheduled(cron = "0 0 1 * * ?")
public void foo() {
    // do something
}

可能有人會問，為啥不用Quartz？Quartz自然是非常方便強大的，但不是本篇要講的內(nèi)容，本篇就偏要使用SpringSchedule來實現(xiàn)動態(tài)的cron表達式任務(wù)。

在上面的快速開始一節(jié)中，通過configureTasks，我們可以拿到ScheduledTaskRegistrar實例，在這個實例中提供了很多的操作定時任務(wù)方法

public ScheduledTask scheduleTriggerTask(TriggerTask task) {/**/}
public ScheduledTask scheduleCronTask(CronTask task) {/**/}
public ScheduledTask scheduleFixedRateTask(IntervalTask task) {/**/} 
public ScheduledTask scheduleFixedRateTask(FixedRateTask task) {/**/}
public ScheduledTask scheduleFixedDelayTask(IntervalTask task) {/**/}
public ScheduledTask scheduleFixedDelayTask(FixedDelayTask task) {/**/}

修改第一步中的配置如下，為了操作簡單，這里直接通過ApplicationRunner來進行測試

@Slf4j
@EnableScheduling
@Configuration
public class SchedulerConfig implements SchedulingConfigurer, ApplicationRunner {

    private ScheduledTaskRegistrar taskRegistrar;

    @Override
    public void configureTasks(ScheduledTaskRegistrar taskRegistrar) {
        ThreadPoolTaskScheduler taskScheduler = threadPoolTaskScheduler();
        taskRegistrar.setScheduler(taskScheduler);

        this.taskRegistrar = taskRegistrar;
    }

    @Bean
    public ThreadPoolTaskScheduler threadPoolTaskScheduler() {
        ThreadPoolTaskScheduler scheduler = new ThreadPoolTaskScheduler();
        scheduler.setPoolSize(Runtime.getRuntime().availableProcessors() / 3 + 1);
        scheduler.setThreadNamePrefix("scheduler-");
        scheduler.setRemoveOnCancelPolicy(true);
        return scheduler;
    }

    @Override
    public void run(ApplicationArguments args) throws Exception {
        CronTask cronTask = new CronTask(() -> log.info("foo-----------"), "0/2 * * * * ?");
        ScheduledTask fooTask = taskRegistrar.scheduleCronTask(cronTask);

        ExecutorService executor = Executors.newSingleThreadExecutor(Thread::new);

        executor.execute(() -> {
            try {
                // 等10秒
                TimeUnit.SECONDS.sleep(10);
                Runnable runnable = fooTask.getTask().getRunnable();
                // 停止foo任務(wù)
                fooTask.cancel();
                // 重新添加，并修改觸發(fā)時間為每3秒一次
                taskRegistrar.scheduleCronTask(new CronTask(runnable, "0/3 * * * * ?"));
                // 再添加一個bar任務(wù)，每秒執(zhí)行一次
                taskRegistrar.scheduleCronTask(new CronTask(() -> log.info("bar..."), "0/1 * * * * ?"));
            } catch (InterruptedException e) {
                e.printStackTrace();
            }
        });
    }
}

日志如下，從日志中可以看到，上面的操作是成功的，而且也是非常方便的，可以很方便的動態(tài)添加定時任務(wù)，其余幾個方法就不寫出來了，感興趣的可以自己試一下。

2023-04-28 16:38:21.547  INFO 8592 --- [           main] com.example.SpringBootQuartzApplication  : Started SpringBootQuartzApplication in 1.101 seconds (JVM running for 1.563)
2023-04-28 16:38:22.002  INFO 8592 --- [    scheduler-1] com.example.task.SchedulerConfig         : foo-----------
2023-04-28 16:38:24.001  INFO 8592 --- [    scheduler-1] com.example.task.SchedulerConfig         : foo-----------
2023-04-28 16:38:26.001  INFO 8592 --- [    scheduler-2] com.example.task.SchedulerConfig         : foo-----------
2023-04-28 16:38:28.001  INFO 8592 --- [    scheduler-1] com.example.task.SchedulerConfig         : foo-----------
2023-04-28 16:38:30.002  INFO 8592 --- [    scheduler-3] com.example.task.SchedulerConfig         : foo-----------
2023-04-28 16:38:32.002  INFO 8592 --- [    scheduler-1] com.example.task.SchedulerConfig         : bar
2023-04-28 16:38:33.000  INFO 8592 --- [    scheduler-2] com.example.task.SchedulerConfig         : bar
2023-04-28 16:38:33.000  INFO 8592 --- [    scheduler-3] com.example.task.SchedulerConfig         : foo-----------
2023-04-28 16:38:34.002  INFO 8592 --- [    scheduler-3] com.example.task.SchedulerConfig         : bar
2023-04-28 16:38:35.001  INFO 8592 --- [    scheduler-3] com.example.task.SchedulerConfig         : bar
2023-04-28 16:38:36.001  INFO 8592 --- [    scheduler-1] com.example.task.SchedulerConfig         : foo-----------
2023-04-28 16:38:36.001  INFO 8592 --- [    scheduler-3] com.example.task.SchedulerConfig         : bar
2023-04-28 16:38:37.002  INFO 8592 --- [    scheduler-3] com.example.task.SchedulerConfig         : bar
2023-04-28 16:38:38.002  INFO 8592 --- [    scheduler-3] com.example.task.SchedulerConfig         : bar
2023-04-28 16:38:39.001  INFO 8592 --- [    scheduler-1] com.example.task.SchedulerConfig         : foo-----------
2023-04-28 16:38:39.001  INFO 8592 --- [    scheduler-3] com.example.task.SchedulerConfig         : bar

當(dāng)然，上面的例子中，因為都是在run方法內(nèi)，所以沒那么多講究，一般在正式使用的時候，會在scheduleXXXTask返回的ScheduledTask實例保存起來，比如保存到map中并給一個唯一key之類的，以方便后續(xù)操作，又或者自定義類實現(xiàn)Runable接口并在其中指定能唯一標識這個任務(wù)的方法。具體如何實現(xiàn)，就看具體場景了。

quartz以及xxl-job等框架也是非常優(yōu)秀的任務(wù)調(diào)度框架，提供的功能更為強大，但對于比較簡單的小項目來說，沒有引入的必要，Spring Schedule已經(jīng)足夠用了。

到此這篇關(guān)于Spring中的Schedule動態(tài)添加修改定時任務(wù)詳解的文章就介紹到這了,更多相關(guān)Schedule動態(tài)添加修改定時任務(wù)內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

最新評論