Spring 实现动态定时任务

一、前言

平时我们使用 Spring 去实现一个单体项目的定时任务，用得比较多的是 @Scheduled 注解，但是该注解的局限性是不能动态的更改定时任务的时间；这时就需要使用其他方式去实现动态的定时任务了，Spring 给我们提供了 SchedulingConfigurer 接口，使用它就能够实现动态的定时任务。

二、使用

直接实现 SchedulingConfigurer 接口即能做到动态的修改定时任务的时间，下面先写一个配置类 TestScheduleConfig。注：别忘了添加 @EnableScheduling 注解

/**
 * 动态定时任务测试
 *
 * @author zxb
 * @date 2022-06-08 17:53
 **/
@Configuration
@EnableScheduling
@Log4j2
public class TestScheduleConfig implements SchedulingConfigurer {
    /**
     * cron 表达式，可以设置；默认 1s 执行一次
     */
    @Getter
    @Setter
    private String cron = "0/1 * * * * ? ";

    private final Runnable runnable = () -> {
        if (log.isInfoEnabled()) {
            log.info("运行的任务......");
        }
    };

    @Override
    public void configureTasks(ScheduledTaskRegistrar taskRegistrar) {
        taskRegistrar.addTriggerTask(runnable, triggerContext -> {
            // 下一次执行定时任务的 cron 表达式
            CronTrigger trigger = new CronTrigger(cron);
            if (log.isInfoEnabled()) {
                log.info("执行的 cron 为：".concat(cron));
            }
            return trigger.nextExecutionTime(triggerContext);
        });
    }
}

需要重写 configureTasks 方法，该方法会在应用启动完成后自动调用，其中参数为 ScheduledTaskRegistrar 类型，从下图看来添加任务有几种类型，分别是固定 corn 表达式的任务（与@Scheduled 一样）、固定延时与固定速率任务、触发式任务。本次使用的是 addTriggerTask 方法。

三、测试

我们默认给定时任务设置每秒执行一次任务，然后过 10 秒修改为 10 秒执行一次，过 20 秒修改为每 2 秒执行一次，下面看看效果。

/**
 * @author zxb
 * @date 2022-06-08 17:58
 **/
@SpringBootTest
@Log4j2
public class ScheduleTest {
    @Autowired
    private TestScheduleConfig testScheduleConfig;

    @Test
    @SneakyThrows
    public void test() {
        TimeUnit.SECONDS.sleep(10);
        log.info("更改 cron 时间为 10 秒一次");
        testScheduleConfig.setCron("0/10 * * * * ? ");

        TimeUnit.SECONDS.sleep(20);
        log.info("更改 cron 时间为 2 秒一次");
        testScheduleConfig.setCron("0/2 * * * * ? ");
        
        TimeUnit.SECONDS.sleep(60);
    }
}

执行结果如下图所示，控制台输出更改 cron 表达式后，任务的执行时间并没有立即更改，而是更改下一次任务的执行时间。

四、总结

我们在需要动态设置定时任务而 @Scheduled 注解不满足应用场景的时，可以使用 SchedulingConfigurer 接口进行代替，使用起来也很简单。但该方案仅仅适用于单体服务，当分布式时请使用类似 XXL-JOB 这样的支持分布式的定时任务框架，或者加个分布式锁（使用数据库实现乐观锁也可以）防止多节点同时执行任务，导致任务重复执行问题。