ShedLock日常使用

首发于个人博客：ShedLock日常使用

场景模拟

定时器Scheduler在平时使用比较频繁，比如定时数据整理，定时向客户发送问候信息等...，定时任务的配置比较简单，比如在springboot中，配置好@Scheduled和@EnableScheduling之后，定时器就能正常执行，实现定时任务的功能。

但是在这样的情况下：如果开发的服务需要水平部署实现负载均衡，那么定时任务就会同时在多个服务实例上运行，那么一方面，可能由于定时任务的逻辑处理需要访问公共资源从而造成并发问题；另一方面，就算没有并发问题，那么一个同样的任务多个服务实例同时执行，也会造成资源的浪费。因此需要一种机制来保证多个服务实例之间的定时任务正常、合理地执行。

ShedLock介绍

ShedLock的出现就是为了解决上述问题，它可以保证多个一个定时任务在多个服务实例之间最多只执行一次，是一个在分布式环境中保证定时任务合理执行的框架。

Github项目地址：https://github.com/lukas-krecan/ShedLock.

ShedLock的实现原理是采用公共存储实现的锁机制，使得同一时间点只有第一个执行定时任务的服务实例能执行成功，并在公共存储中存储"我正在执行任务，从什么时候（预计）执行到什么时候"，其他服务实例执行时如果发现任务正在执行，则直接跳过本次执行，从而保证同一时间一个任务只被执行一次。

上面提到的公共存储目前支持的有：

• Monogo
• DynamoDB
• JdbcTemplate
• ZooKeeper (using Curator)
• Redis (using Spring RedisConnectionFactory)
• Redis (using Jedis)
• Hazelcast

值得注意的是，ShedLock不是一个分布式的定时任务框架，只是一个锁，用于保证分布式环境中的定时任务合理执行。贴一段原话：Please note that ShedLock is not and will never be full-fledged scheduler, it's just a lock. If you need a distributed scheduler, please use another project. ShedLock is designed to be used in situations where you have scheduled tasks that are not ready to be executed in parallel, but can be safely executed repeatedly. For example if the task is fetching records from a database, processing them and marking them as processed at the end without using any transaction. In such case ShedLock may be right for you.

依赖说明：

• Java 8
• slf4j-api
• Spring Framework (optional)

ShedLock使用

以SpringBoot为例。

引入依赖：

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

定义一个定时任务：

@Component
public class DataHouseKeepingScheduler {
    @Scheduled(cron = "*/5 * * * * ?")
    private void dataHouseKeeping(){
        System.out.println(String.format("[%s] DataHouseKeeping job run...", new Date()));
    }
}

添加ShedLock

在主类或者@EnableScheduling的地方添加@EnableSchedulerLock(defaultLockAtMostFor = "PT30S")

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

然后在@Scheduled(...)的地方添加@SchedulerLock(name = "scheduledTaskName")

@Component
public class DataHouseKeepingScheduler {
    @Scheduled(cron = "*/5 * * * * ?")
    @SchedulerLock(name = "dataHouseKeepingLock", lockAtLeastForString = "20000", lockAtMostForString = "30000")
    private void dataHouseKeeping(){
        System.out.println(String.format("[%s] DataHouseKeeping job run...", new Date()));
    }
}

@SchedulerLock的作用是保证当前定时任务的方法执行时获得锁，忽略其他相同任务的执行。但是，name必须要指定，ShedLock就是根据这个name进行相同任务判定的（后面会细说）。注解中还有两个参数：

• lockAtLeastForString: 锁持有的最小时间（ms）。比如示例代码中设定的5000ms表示当前方法执行时获取到的锁的最小时间是20s，20s之内，就算当前定时任务已经执行完成，其他任务也无法获得锁，必须等5s之后才能获取。
• lockAtMostForString: 锁持有的最大时间（ms）。当前任务获取的锁的最大持有时间为30s，30s之后就算没有执行完，其他定时任务也可以获取锁去执行任务。

配置LockProvider，此处以jdbc为例。先引入依赖：

<dependency>
    <groupId>net.javacrumbs.shedlock</groupId>
    <artifactId>shedlock-provider-jdbc-template</artifactId>
    <version>2.3.0</version>
</dependency>

配置@Bean:

@Component
public class ShedLockConfig {
    @Resource
    private DataSource dataSource;

    @Bean
    private LockProvider lockProvider(){
        return new JdbcTemplateLockProvider(dataSource);
    }
}

此处的DataSource即为当前应用的数据源。

注意，如果使用SqlServer需要设置schema，可以在JdbcTemplateLockProvider的构造方法中设置：

new JdbcTemplateLockProvider(dataSource, "schema.shedlock")

创建存储锁信息的表。

MySQL

```sql
CREATE TABLE shedlock(
    name VARCHAR(64),
    lock_until TIMESTAMP(3) NULL,
    locked_at TIMESTAMP(3) NULL,
    locked_by  VARCHAR(255),
    PRIMARY KEY (name)
)

SQLServer

CREATE TABLE [dbo].[shedlock](
    [name] [varchar](64) NOT NULL,
    [lock_until] [datetime] NULL,
    [locked_at] [datetime] NULL,
    [locked_by] [varchar](255) NOT NULL,
 CONSTRAINT [PK_shedlock] PRIMARY KEY CLUSTERED
(
    [name] ASC
)WITH (PAD_INDEX = OFF, STATISTICS_NORECOMPUTE = OFF, IGNORE_DUP_KEY = OFF, ALLOW_ROW_LOCKS = ON, ALLOW_PAGE_LOCKS = ON) ON [PRIMARY]
) ON [PRIMARY]

Oracle

CREATE TABLE SHEDLOCK (
  name VARCHAR2(64 CHAR),
  lock_until TIMESTAMP,
  locked_at TIMESTAMP,
  locked_by  VARCHAR2(255 CHAR),
  PRIMARY KEY (name)
);

启动应用，定时任务开始执行：

[Mon Feb 25 22:38:15 CST 2019] DataHouseKeeping job run...
[Mon Feb 25 22:38:35 CST 2019] DataHouseKeeping job run...
[Mon Feb 25 22:38:55 CST 2019] DataHouseKeeping job run...

可以看到，虽然定时任务设定的是每5秒执行一次，但是控制台输出的却是每20秒一次，这时就是lockAtLeastForString="20000"生效了。

这时候来看看表里的数据：

总结

再次强调，ShedLock不是一个定时任务框架，而是一个保证定时任务在分布式环境中的合理执行的辅助框架，保证定时任务在分布式环境中同一时间最多只执行一次。同时一个任务在执行时，另一个任务无法获取锁时会跳过当前任务的执行。

最后关于ShedLock的版本说明（直接贴原话了）：

Version 1.x.x is compiled and tested with Spring 5 and Spring Data 2. It should be safe to use ShedLock 1.x.x with Spring 4 if you are not using Spring Redis lock provider which introduced incompatibility. In other words

• If you have dependency on spring-data-redis 2 - use ShedLock 1.x.x
• If you have dependency on spring-data-redis 1 - use ShedLock 0.x.x
• In all other cases, you can use both versions, prefereably 1.x.x

Demo源码地址

Demo源码地址：https://gitee.com/nickhan/ShedLockDemo