用 Shedlock 轻松化解 Spring Schedule 多实例问题

后端

2024-02-07 11:08:20

引言

在分布式系统中，调度任务的并发执行可能会导致各种问题。例如，如果多个实例同时尝试更新同一个数据库表，可能会导致数据损坏。为了避免这些问题，我们需要在调度任务中实现某种形式的并发控制。

Shedlock 简介

Shedlock 是一个轻量级 Java 库，可帮助您在分布式系统中轻松实现分布式锁。Shedlock 使用数据库作为锁存储，因此它可以在任何支持 JDBC 的数据库中使用。

Shedlock 的主要优点包括：

简单易用： Shedlock 的 API 非常简单易用，您只需几行代码就可以实现分布式锁。
高性能： Shedlock 的性能非常高，即使在高并发场景下也能保持良好的性能。
可扩展性强： Shedlock 可以轻松扩展到大型分布式系统中使用。

使用 Shedlock 解决 Spring Schedule 多实例问题

要使用 Shedlock 解决 Spring Schedule 多实例问题，您需要执行以下步骤：

在您的项目中添加 Shedlock 的依赖。
配置 Shedlock。
在您的调度任务中使用 Shedlock。

1. 添加 Shedlock 依赖

您可以使用 Maven 或 Gradle 在您的项目中添加 Shedlock 的依赖。

Maven：

<dependency>
  <groupId>net.javacrumbs.shedlock</groupId>
  <artifactId>shedlock-spring</artifactId>
  <version>5.13.0</version>
</dependency>

Gradle：

implementation 'net.javacrumbs.shedlock:shedlock-spring:5.13.0'

2. 配置 Shedlock

在配置 Shedlock 时，您需要指定锁存储的类型以及锁存储的配置信息。

您可以使用以下代码配置 Shedlock：

@Configuration
public class ShedlockConfig {

  @Bean
  public ShedlockConfig shedlockConfig() {
    return ShedlockConfig.builder()
        .lockProvider(LockProvider.JDBC)
        .databaseType(DatabaseType.MYSQL)
        .table("shedlock")
        .build();
  }

  @Bean
  public ShedlockAspect shedlockAspect() {
    return ShedlockAspect.aspect();
  }
}

在上面的代码中，我们指定了锁存储的类型为 JDBC，锁存储的配置信息包括数据库类型、表名等。

3. 在调度任务中使用 Shedlock

在调度任务中使用 Shedlock，您需要在任务方法上添加 @Shedlock 注解。

您可以使用以下代码在调度任务中使用 Shedlock：

@Component
public class MyTask {

  @Scheduled(fixedRate = 1000)
  @Shedlock(lockAtLeastFor = 60000, lockAtMostFor = 120000)
  public void run() {
    // 您的任务逻辑
  }
}

在上面的代码中，我们使用了 @Shedlock 注解来指定锁的持有时间。这意味着，该任务将在 60 秒内获得锁，并在 120 秒后释放锁。