控制Spring Boot定时任务只执行一次的方案

环境

• Spring Boot 3.2.5

1. 简介

在本篇文章中，我们将探讨如何控制定时任务在Spring Boot应用中只执行一次。定时任务通常用于自动化诸如报告生成、发送通知等任务，默认情况下，它们是周期性执行的。但在某些场景下，例如资源初始化或数据迁移，可能只需要任务在某个时间点执行一次。

本文将介绍几种实现方式，从简单的@Scheduled注解延迟执行，到更灵活的TaskScheduler和自定义触发器，帮助我们避免任务重复执行。

2. 实战案例

2.1 仅指定开始时间

虽然@Scheduled注解提供了直接的定时任务调度方式，但它的灵活性有限，尤其是对一次性任务的控制。为了解决这一问题，Spring提供了TaskScheduler接口，允许我们编程式地安排任务，并指定任务的开始时间。这种方式非常适合需要动态调度任务的场景。

使用TaskScheduler，我们可以指定一个Runnable任务和一个Instant对象，表示任务应在何时执行。以下是一个简单的示例：

public class TaskComponent {
    private TaskScheduler taskScheduler = new SimpleAsyncTaskScheduler();

    public void schedule(Runnable task, Instant startTime) {
        taskScheduler.schedule(task, startTime);
    }
}

TaskScheduler的其他方法通常用于周期性任务，但这里的方法特别适合一次性任务。

注意：我们使用了SimpleAsyncTaskScheduler，在Spring 6.1以上版本中，你可以使用虚拟线程来执行任务：

SimpleAsyncTaskScheduler scheduler = new SimpleAsyncTaskScheduler();
scheduler.setVirtualThreads(true);

你可以通过如下方式测试定时任务的执行：

@Test
public void testOnceTask() throws InterruptedException {
    CountDownLatch latch = new CountDownLatch(1);

    scheduler.schedule(() -> {
        latch.countDown();
        // TODO: 执行任务的具体逻辑
    }, Instant.now().plus(Duration.ofSeconds(1)));

    latch.await();
}

这里的CountDownLatch仅在单元测试中用于协助验证任务的执行，实际生产环境下无需使用。

2.2 使用@Scheduled注解

如果希望使用@Scheduled注解，我们可以设置初始延迟时间（initialDelay），并确保不设置fixedDelay或fixedRate属性。示例如下：

@Component
public class TaskComponent {
    @Scheduled(initialDelay = 3000)
    public void task() {
        // TODO: 执行任务的具体逻辑
    }
}

该任务将在3秒的初始化延迟后执行，且不会重复执行。

2.3 自定义触发器

通过实现PeriodicTrigger，我们可以更灵活地控制任务的执行时间。重写nextExecution()方法可以确保任务只执行一次。示例如下：

public class PackTrigger extends PeriodicTrigger {
    public PackTrigger(Instant when) {
        super(Duration.ofSeconds(1));
        Duration difference = Duration.between(Instant.now(), when);
        setInitialDelay(difference);
    }

    @Override
    public Instant nextExecution(TriggerContext triggerContext) {
        if (triggerContext.lastCompletion() == null) {
            return super.nextExecution(triggerContext);
        }
        // 返回null，任务将不再执行
        return null;
    }
}

由于任务只需要执行一次，因此我们可以将周期时间设置为任意值。nextExecution()方法会判断任务是否已经执行过，若未执行则调用默认的执行逻辑，若已执行则返回null，停止后续执行。

调用示例如下：

TaskScheduler taskScheduler = new SimpleAsyncTaskScheduler();
taskScheduler.schedule(() -> {
    System.out.printf("%s, 执行任务%n", Thread.currentThread().getName());
}, new PackTrigger(Instant.now().plusSeconds(2)));

这种自定义触发器的方式为定时任务的控制提供了更多灵活性，也是当前最优的实现方式。

3. 总结

通过以上几种方式，我们可以在Spring Boot中灵活地实现只执行一次的定时任务。无论是简单的注解方式，还是自定义触发器，都能有效地控制任务的执行时间，满足各种业务场景的需求。