Shedlock

定时任务锁ShedLock

在分布式系统中,为了保证在多个实例运行的情况下,定时任务只执行一次,这时候就可以使用ShedLock。

当然也有其他的解决方案,比如Quartz、Elastic-Job、IP判断等。

ShedLock的优势是轻量级,因为它不是一个分布式定时任务框架,它只是实现了锁机制。

官方文档:

https://github.com/lukas-krecan/ShedLock

ShedLock的原理是在公共存储的前提下实现锁机制。公共存储可以是:

JdbcTemplate,Mongo,DynamoDB,Redis,ElasticSearch,ZooKeeper等。

一、基础配置

下面简单介绍下JdbcTemplate的配置方式。

1.创建表shedlock

# MS SQL
CREATE TABLE shedlock(name VARCHAR(64) NOT NULL, lock_until datetime2 NOT NULL,
    locked_at datetime2 NOT NULL, locked_by VARCHAR(255) NOT NULL, PRIMARY KEY (name));

2.添加依赖项

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

3.注入配置Bean

@Bean
public LockProvider lockProvider(DataSource dataSource) {
            return new JdbcTemplateLockProvider(
                JdbcTemplateLockProvider.Configuration.builder()
                .withJdbcTemplate(new JdbcTemplate(getDatasource()))
                .usingDbTime() // Works on Postgres, MySQL, MariaDb, MS SQL, Oracle, DB2, HSQL and H2
                .build()
            );
}

二、Demo

1.启动类

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

2.定时任务类

@Scheduled(cron = "0 0 3 * * ?")
@SchedulerLock(name = "uniqueNameOfTask", lockAtMostFor = "20s", lockAtLeastFor = "5s")
public void doSomeTask() {
    // do job
}