分布式系列教程（46） -分布式定时任务锁（ShedLock实现）

01 概述

定时任务经常被各个服务用到，比如定时清理日志，定时提醒，但是在分布式的环境下，一个任务会分配给多个微服务，每个微服务在某一时间可能会同时执行同一个事件，我们希望的是只有一个微服务去处理，这个时候需要用到了分布式定时任务锁，其中ShedLock是一种实现方式，本文来讲解。

备注：还可以使用xxl-job，有兴趣的童鞋可以参考之前写的博客《分布式系列教程（17） - 分布式任务调度平台XXL-JOB》）。

02 什么是ShedLock？

ShedLock其实就是分布式定时任务锁，是一个在分布式环境中使用的定时任务框架，用于解决在分布式环境中的多个实例的相同定时任务在同一时间点重复执行的问题。

它的实现方式有如下几种：

• Mongo
• Redis
• Hazelcast
• ZooKeeper
• 。。。。。。

接下来讲解使用JDBC锁。

03 使用方式

1.添加Maven依赖：

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

<!-- 使用JDBC锁 -->
<dependency>
    <groupId>net.javacrumbs.shedlock</groupId>
    <artifactId>shedlock-provider-jdbc-template</artifactId>
    <version>2.2.0</version>
</dependency>

2.配置

@Configuration
public class ScheduledLockConfig
{
    @Bean
    public LockProvider lockProvider(DataSource dataSource) {
        return new JdbcTemplateLockProvider(dataSource);
    }
}

3.数据库中添加一张表（shedlock表）：

名	类型	注释
name	varchar	每个定时任务名字
lock_until	timestamp	锁的结束时间
locked_at	timestamp	锁的开始时间
locked_by	varchar	服务名称

4.在启动类上加上注解EnableSchedulerLock，开启定时任务锁，指定一个默认的锁的时间：

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

5.实现的代码（添加SchedulerLock注解）：

@Component
public class ScheduledLock
{
    private static final int lockTime = 1000;
 
    @Scheduled(cron = "0/2 * * * * ?")
    @SchedulerLock(name = "TaskScheduler_scheduledTask", lockAtMostFor = lockTime, lockAtLeastFor = lockTime)
    public void run()
    {
        System.out.print(new Date().toString() + "\n");
    }
}

参数名	描述
name	定时任务的名字，就是数据库中的内个主键
lockAtMostFor	锁的最大时间单位为毫秒
lockAtMostForString	最大时间的字符串形式，例如：PT30S 代表30秒
lockAtLeastFor	锁的最小时间单位为毫秒
lockAtLeastForString	最小时间的字符串形式

执行结果（没有重复时间）：

注意：如果要指定别的表名，可以配置第2步的LockProvider：

<bean id="lockProvider" class="net.javacrumbs.shedlock.provider.jdbctemplate.JdbcTemplateLockProvider">
    <constructor-arg name="tableName" ref="dataSource"/>
</bean>

参考博客：

• https://www.cnblogs.com/song27/p/12066702.html
• https://www.cnblogs.com/gutousu/p/10235160.html