概述
Spring为定时任务提供一个易于实现的API。在没有部署应用程序的多个实例之前,它很有效。默认情况下,Spring无法处理多个实例上的调度程序同步,而是在每个节点上同时执行作业。ShedLock库确保计划任务只能同时运行一次,可以代替Quartz。ShedLock支持Mongo,Redis,Hazelcast,ZooKeeper以及任何基于JDBC驱动程序的数据库。
https://github.com/lukas-krecan/ShedLock
入门
shedlock-spring基本依赖项:
<dependency>
<groupId>net.javacrumbs.shedlock</groupId>
<artifactId>shedlock-spring</artifactId>
</dependency>
再针对不同的锁,分别添加不同的依赖。如JDBC(数据库)锁添加:
<dependency>
<groupId>net.javacrumbs.shedlock</groupId>
<artifactId>shedlock-provider-jdbc-template</artifactId>
</dependency>
注意JDBC和JdbcTemplate是两种不同的锁。
ShedLock仅适用于具有共享数据库的环境。它在数据库中创建一个表或文档,用于存储有关当前锁的信息。为ShedLock创建一个PostgreSQL数据库表,以保留有关调度程序锁的信息:
CREATE TABLE shedlock(
name VARCHAR(64),
lock_until TIMESTAMP(3) NULL,
locked_at TIMESTAMP(3) NULL,
locked_by VARCHAR(255),
PRIMARY KEY (name)
)
Spring配置类上的@EnableScheduling和@EnableSchedulerLock注释:
@SpringBootApplication
@EnableScheduling
@EnableSchedulerLock(defaultLockAtMostFor = "PT30S")
public class SpringApplication {
public static void main(String[] args) {
SpringApplication.run(SpringApplication.class, args);
}
}
defaultLockAtMostFor参数指定在执行节点结束时应保留锁的默认时间量。它使用ISO8601 Duration格式。
创建任务
方法添加注解@Scheduled和@SchedulerLock注释:
@Component
class TaskScheduler {
// 每15分钟
@Scheduled(cron = "*/15 * * * * *")
@SchedulerLock(name = "TaskScheduler_scheduledTask", lockAtLeastForString = "PT5M", lockAtMostForString = "PT14M")
public void scheduledTask() {
}
}
@Scheduled 支持cron表达式;
@SchedulerLock注解有五个参数:
- name:定时任务的名字,即数据库中的内个主键,必须唯一
- lockAtMostFor:锁的最大时间单位为毫秒
- lockAtMostForString:最大时间的字符串形式,例如:PT30S 代表30秒
- lockAtLeastFor:锁的最小时间单位为毫秒
- lockAtLeastForString:最小时间的字符串形式
在正常情况下,ShedLock会在任务完成后直接释放锁。@EnableSchedulerLock中提供默认值。
参考
https://www.njlife.top/archives/shedlock-use