Spring项目多实例部署ShedLock分布式定时任务锁框架介绍

spring shedlock用于在分布式服务的情况下执行定时任务,例如定时删除数据库中的一些数据,做数据迁移等等操作,这篇文章主要介绍了Spring项目多实例部署ShedLock分布式定时任务锁框架介绍的相关资料,需要的朋友可以参考下

目录

• 前言
• 一、核心用途
• 1. 解决的核心痛点
• 2. 框架定位
• 3. 核心原理
• 二、注解参数详解
• 参数说明与配置建议
• 三、完整使用步骤（Spring Boot 环境）
• 方案1：基于 MySQL / JDBC（最通用）
• 步骤1：引入依赖
• 步骤2：创建锁表
• 步骤3：配置类开启 ShedLock
• 步骤4：在定时方法上添加注解
• 方案2：基于 Redis 实现
• 替换依赖
• 替换 LockProvider 配置
• 四、多节点执行流程
• 五、避坑与注意事项
• 六、优缺点总结
• 优点
• 缺点
• 七、适用场景

前言

net.javacrumbs.shedlock.core.SchedulerLock 是 ShedLock 分布式定时任务锁框架的核心注解（并非普通类），专门用于解决 Spring 项目多实例部署时，@Scheduled 定时任务重复执行的问题。

一、核心用途

1. 解决的核心痛点

Spring 原生的 @Scheduled 是单机定时任务。当应用分布式部署（多节点/多副本）时，每个节点都会独立触发定时任务，导致：

• 数据重复插入/计算
• 数据库并发写冲突
• 重复发送消息、通知
• 资源浪费与业务逻辑异常

@SchedulerLock 的作用就是给定时任务加分布式互斥锁：同一时刻，全局只有一个节点能执行该定时任务，其余节点直接跳过本次执行。

2. 框架定位

• 它不是分布式调度中心（区别于 XXL-Job、Elastic-Job），不负责任务触发、分片、日志监控，只做「任务互斥锁」。
• 完全兼容 Spring 原生 @Scheduled，仅通过注解增强，业务代码侵入极低。
• 支持多种锁存储介质：MySQL、Redis、MongoDB、ZooKeeper 等。

3. 核心原理

1. 通过 Spring AOP 拦截标注了 @SchedulerLock 的定时方法；
2. 任务触发时，通过 LockProvider 向公共存储（DB/Redis）抢占同名锁；
3. 抢到锁：执行业务逻辑，执行完成后自动释放锁；
4. 抢不到锁：直接跳过本次任务，不阻塞、不等待；
5. 内置锁超时机制：即使执行节点宕机，超过设定时间后锁自动释放，避免永久死锁。

二、注解参数详解

@Target({ElementType.METHOD, ElementType.ANNOTATION_TYPE})
@Retention(RetentionPolicy.RUNTIME)
public @interface SchedulerLock {
    // 【必填】锁的全局唯一名称
    String name();

    // 锁最大持有时间（毫秒数，旧版写法）
    long lockAtMostFor() default -1;
    // 锁最大持有时间（ISO-8601字符串，推荐写法）
    String lockAtMostForString() default "";

    // 锁最小持有时间（毫秒数，旧版写法）
    long lockAtLeastFor() default -1;
    // 锁最小持有时间（ISO-8601字符串，推荐写法）
    String lockAtLeastForString() default "";
}

参数说明与配置建议

参数	作用	配置建议	示例
name	锁的唯一标识，同名任务全局互斥	每个定时任务必须唯一，建议用「业务名_任务名」	order_auto_cancel_task
lockAtMostForString	锁的最长持有时间，超时自动释放	必须大于任务实际最大执行时长，建议设为预估耗时的2~3倍，防止宕机死锁	PT10M = 10分钟
lockAtLeastForString	锁的最短持有时间，任务执行完后仍会持有锁	针对执行快、频率高的任务，避免任务瞬间执行完后，其他节点在同一周期内重复抢到锁	PT30S = 30秒

ISO-8601 持续时间格式常用写法：PT30S（30秒）、PT5M（5分钟）、PT1H（1小时）、PT2H30M（2小时30分）。

三、完整使用步骤（Spring Boot 环境）

ShedLock 依赖外部存储实现分布式锁，生产环境最常用两种方案：MySQL/JDBC（无额外中间件） 和 Redis。

方案1：基于 MySQL / JDBC（最通用）

步骤1：引入依赖

    net.javacrumbs.shedlock
    shedlock-spring
    4.44.0


    net.javacrumbs.shedlock
    shedlock-provider-jdbc-template
    4.44.0

// Gradle
implementation 'net.javacrumbs.shedlock:shedlock-spring:4.44.0'
implementation 'net.javacrumbs.shedlock:shedlock-provider-jdbc-template:4.44.0'

步骤2：创建锁表

在业务数据库中执行建表语句，表名和字段固定：

CREATE TABLE shedlock (
    name       VARCHAR(64)  NOT NULL COMMENT '锁名称，主键',
    lock_until TIMESTAMP(3) NOT NULL COMMENT '锁过期时间',
    locked_at  TIMESTAMP(3) NOT NULL DEFAULT CURRENT_TIMESTAMP(3) COMMENT '加锁时间',
    locked_by  VARCHAR(255) NOT NULL COMMENT '持有锁的节点标识',
    PRIMARY KEY (name)
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COMMENT='ShedLock分布式定时任务锁表';

步骤3：配置类开启 ShedLock

import net.javacrumbs.shedlock.core.LockProvider;
import net.javacrumbs.shedlock.provider.jdbctemplate.JdbcTemplateLockProvider;
import net.javacrumbs.shedlock.spring.annotation.EnableSchedulerLock;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.scheduling.annotation.EnableScheduling;

import javax.sql.DataSource;

@Configuration
@EnableScheduling // 开启Spring原生定时任务
@EnableSchedulerLock(defaultLockAtMostFor = "PT10M") // 全局默认最大锁时长
public class ShedLockConfig {

    /**
     * 配置JDBC锁提供者
     */
    @Bean
    public LockProvider lockProvider(DataSource dataSource) {
        return new JdbcTemplateLockProvider(dataSource);
    }
}

步骤4：在定时方法上添加注解

import net.javacrumbs.shedlock.core.SchedulerLock;
import org.springframework.scheduling.annotation.Scheduled;
import org.springframework.stereotype.Component;

@Component
public class OrderTask {

    /**
     * 每5分钟执行一次：自动取消超时未支付订单
     */
    @Scheduled(cron = "0 */5 * * * ?")
    @SchedulerLock(
            name = "order_auto_cancel_task",
            lockAtMostForString = "PT15M",  // 最多持有15分钟，宕机也会自动释放
            lockAtLeastForString = "PT1M"   // 最少持有1分钟，避免执行太快导致重复
    )
    public void cancelTimeoutOrder() {
        // 业务逻辑：取消超时订单
        System.out.println("执行超时订单取消任务");
    }
}

方案2：基于 Redis 实现

适合项目已接入 Redis、不想新增数据库表的场景，业务代码完全不变，仅替换依赖和配置。

替换依赖

    net.javacrumbs.shedlock
    shedlock-provider-redis-lettuce
    4.44.0

替换 LockProvider 配置

@Bean
public LockProvider lockProvider(RedisConnectionFactory redisConnectionFactory) {
    return new LettuceLockProvider(redisConnectionFactory);
}

四、多节点执行流程

以双节点部署、5分钟执行一次的订单取消任务为例：

1. 到触发时间点，节点A、节点B同时触发 cancelTimeoutOrder 方法；
2. ShedLock 切面拦截，两个节点同时向 MySQL 的 shedlock 表写入/更新 order_auto_cancel_task 记录；
3. 节点A写入成功，抢到锁，执行业务逻辑；
4. 节点B写入失败（主键冲突），直接跳过本次任务，不执行业务逻辑；
5. 节点A执行完成，更新 lock_until 为当前时间，释放锁；
6. 若节点A执行中途宕机，15分钟后 lock_until 到期，锁自动失效，下一轮其他节点可正常抢占。

五、避坑与注意事项

1. 方法必须是 public：Spring AOP 基于代理实现，private/protected 方法无法被拦截，注解会失效。
2. 锁名必须全局唯一：不同任务不能使用相同 name，否则会互相阻塞。
3. 集群时间必须同步：锁的过期判断依赖系统时间，节点时间差过大可能导致锁逻辑异常。
4. 同类内部调用不生效：同一个类中通过 this.xxx() 调用带注解的方法，不走代理，锁不生效。
5. 仅适配 @Scheduled：该注解专门为定时任务设计，普通业务方法不生效；普通分布式锁请使用 Redisson 等框架。
6. 抢锁失败直接跳过：ShedLock 不会阻塞等待锁，也不会重试；需要重试请自行实现。

六、优缺点总结

优点

• 侵入性极低：仅加一行注解，原有定时任务代码无需改造
• 自动防死锁：超时自动释放机制，避免节点宕机导致任务永久挂起
• 多存储兼容：可灵活切换 MySQL、Redis、Mongo 等存储
• 轻量无额外服务：不需要独立部署调度中心，运维成本低

缺点

• 功能单一：只解决重复执行问题，不支持任务分片、动态调整、失败告警、日志管理
• 无重试机制：抢锁失败直接跳过，不适合必须执行的核心任务
• 依赖外部存储：存储中间件故障会导致所有定时任务失效

七、适用场景

• 中小型项目，多实例部署，需要快速解决定时任务重复执行问题
• 已有 Spring @Scheduled 任务，不想引入重量级调度中心
• 数据清理、状态同步、报表生成等对执行精度要求不极端的定时任务

到此这篇关于Spring项目多实例部署ShedLock分布式定时任务锁框架介绍的文章就介绍到这了,更多相关ShedLock分布式定时任务锁内容请搜索爱读视界以前的文章或继续浏览下面的相关文章希望大家以后多多支持爱读视界！

您可能感兴趣的文章:

• SpringBoot整合ShedLock解决定时任务防止重复执行的问题
• Spring Cloud分布式定时器之ShedLock的实现
• Spring Boot集成ShedLock分布式定时任务的实现示例
• SpringBoot 集成 ShedLock 分布式锁的示例详解
• SpringBoot集成ShedLock实现分布式定时任务流程详解
• SpringBoot配置ShedLock分布式定时任务
• SpringBoot集成ShedLock实现分布式定时任务
• Spring Boot 整合 ShedLock 处理定时任务重复执行的问题小结
• SpringBoot集成ShedLock实现分布式定时任务的示例代码
• SpringBoot使用shedlock做定时任务的实现示例