SpringBoot中@SchedulerLock注解实现定时任务中分布式锁的使用

背景

在SpringBoot项目中经常会去写一些定时任务，但是当我们的服务的实例部署多个的情况下，那么每个实例中的定时任务都会执行一遍，这显然不是我们想要的，我们只想让它执行一次。在没有引入像xxl-job之类的分布式任务调度框架的前提下，并且我们也不想对业务代码进行侵入，那么可以选择shedlock进行尝试使用。

1. 第一步：引入相关依赖

		<dependency>
            <groupId>net.javacrumbs.shedlock</groupId>
            <artifactId>shedlock-spring</artifactId>
            <version>4.14.0</version>
        </dependency>
<!--        <dependency>-->
<!--            <groupId>net.javacrumbs.shedlock</groupId>-->
<!--            <artifactId>shedlock-provider-jdbc-template</artifactId>-->
<!--            <version>4.14.0</version>-->
<!--        </dependency>-->
        <dependency>
            <groupId>net.javacrumbs.shedlock</groupId>
            <artifactId>shedlock-provider-redis-spring</artifactId>
            <version>2.5.0</version>
        </dependency>

这里说明一下：ShedLock是支持多种方式进行数据存储的，具体的详情可以看下Github的文档说明：文档
，因为我们项目里面已经引入并使用了Redis，所以我这里就选择了Redis作为存储。所以上边的依赖我也是使用了redis的provider的支持。

2. 第二步，添加配置类

@Configuration
public class ScheduledLockConfig {

    @Autowired
    private StringRedisTemplate stringRedisTemplate;

    @Bean
    public LockProvider lockProvider() {
        return new RedisLockProvider(stringRedisTemplate.getConnectionFactory());
    }
}

3. 第三步，在启动类上添加注解，否则不会生效

@EnableSchedulerLock(defaultLockAtMostFor = "PT10M")

4. 第四步，使用

	@Scheduled(cron = "0 0 0 * * *")
    @SchedulerLock(name = "resetPrizeRemainCount", lockAtLeastFor = "60000", lockAtMostFor = "60000")
    public void resetPrizeRemainCount() {
    }

当定时任务开始执行的时候，我们去查看redis你会发现，分布式锁已经生效。过期时间就是上边我们设置的时间。

当然，从文档中我们看到它还支持自定义provider，锁扩展等等，如有需要可以自行研究。

下面说一下注解具体的参数说明和使用方法：

• name
  锁的名称，是唯一的标识符。每个任务的锁名称应该唯一，因为它决定了这个锁在分布式环境中的唯一性。
• lockAtMostFor
  锁的最大保持时间。即使任务执行完成或崩溃，锁也将在指定的时间后自动释放。通常用于确保锁不会因为异常情况而永远无法释放。
  ISO-8601持续时间格式或简单的时间单位格式。例如：PT30S（表示30秒）、PT10M（表示10分钟）或10m（表示10分钟）。
• lockAtLeastFor
  锁的最小保持时间。在指定的时间内，即使任务执行完成，锁也不会释放。这有助于防止任务被频繁触发（如在短时间内的重复触发）。
• lockAtLeastForString 和 lockAtMostForString
  这两个参数与 lockAtLeastFor 和 lockAtMostFor 类似，但它们允许通过 Spring 的属性占位符（例如：${lock.duration}）来动态配置值。