Spring ShedLock 指南

还需要提供的另一个配置是 Spring 配置类上的@EnableScheduling 和@EnableSchedulerLock 注释：

@SpringBootApplication
@EnableScheduling
@EnableSchedulerLock(defaultLockAtMostFor = "PT30S")
public class SpringApplication {
    
    public static void main(String[] args) {
        SpringApplication.run(SpringApplication.class, args);
    }
}

defaultLockAtMostFor 参数指定在执行节点结束时应保留锁的默认时间量。它使用 ISO8601 Duration 格式。

在下一节中，我们将了解如何重写此默认值。

4 创建任务

要创建由 ShedLock 处理的计划任务，我们只需将方法上配置@Scheduled 和@SchedulerLock 注释：

@Component
class TaskScheduler {
    
    @Scheduled(cron = "*/15 * * * * *")
    @SchedulerLock(name = "TaskScheduler_scheduledTask",
    lockAtLeastForString = "PT5M", lockAtMostForString = "PT14M")
    public void scheduledTask() {
        // ...
    }
}

首先，让我们来看看@Scheduled。它支持 cron 格式，这个表达式意味着'每 15 分钟'。

接下来，看看@SchedulerLock，name 参数必须是唯一的，ClassName_methodName 通常足以实现它。我们不希望同时有多个相同名称方法运行，所以 ShedLock 使用唯一名称来实现该目的。

我们还添加了几个可选参数。

首先，我们添加了 lockAtLeastForString，以便我们可以在方法调用之间产生时间间隔。使用'PT5M'意味着此方法至少可以锁定 5 分钟。换句话说，这意味着这种方法可以由 ShedLock 运行，而不是每五分钟运行一次。

接下来，我们添加了 lockAtMostForString 来指定在执行节点完成时应该保留多长时间。使用'PT14M'意味着它将被锁定不超过 14 分钟。

在正常情况下，ShedLock 会在任务完成后直接释放锁。但是，实际上，我们没有必要这样做，因为@EnableSchedulerLock 中提供了默认值，但我们选择在此处重写它。

5 总结

在本文中，我们学习了如何使用 ShedLock 创建和同步计划任务。