基于 Redis 的分布式锁 spring-boot starter 组件, 使得项目拥有分布式锁能力变得异常简单, 支持 spring boot, 和 spirng mvc 等 spring 相关项目
快速开始
spring boot 项目接入
1. 添加 lock starter 组件依赖, 目前还没上传到公共仓库, 需要自己下源码 build , 已上传到 maven 中央仓库
- <dependency>
- <groupId>org.springframework.boot</groupId>
- <artifactId>spring-boot-klock-starter</artifactId>
- <version>1.2-SNAPSHOT</version>
- </dependency>
2.application.properties 配置 Redis 链接: spring.klock.address=127.0.0.1:6379
3. 在需要加分布式锁的方法上, 添加注解 @Klock, 如:
- @Service
- public class TestService {
- @Klock(waitTime = Long.MAX_VALUE)
- public String getValue(String param) throws Exception {
- if ("sleep".equals(param)) {// 线程休眠或者断点阻塞, 达到一直占用锁的测试效果
- Thread.sleep(1000 * 50);
- }
- return "success";
- }
- }
支持锁指定的业务 key, 如同一个方法 ID 入参相同的加锁, 其他的放行. 业务 key 的获取支持 Spel, 具体使用方式如下
使用参数说明
spring.klock.address : Redis 链接地址
spring.klock.password : Redis 密码
spring.klock.database : Redis 数据索引
spring.klock.waitTime : 获取锁最长阻塞时间 (默认: 60, 单位: 秒)
spring.klock.leaseTime: 已获取锁后自动释放时间 (默认: 60, 单位: 秒)
spring.klock.cluster-server.node-addresses : Redis 集群配置 如 127.0.0.1:7000,127.0.0.1:7001,127.0.0.1:7002
spring.klock.address 和 spring.klock.cluster-server.node-addresses 选其一即可
@Klock 注解参数说明
@Klock 可以标注四个参数, 作用分别如下
name:lock 的 name, 对应 Redis 的 key 值. 默认为: 类名 + 方法名
lockType: 锁的类型, 目前支持 (可重入锁, 公平锁, 读写锁). 默认为: 公平锁
waitTime: 获取锁最长等待时间. 默认为: 60s. 同时也可通过 spring.klock.waitTime 统一配置
leaseTime: 获得锁后, 自动释放锁的时间. 默认为: 60s. 同时也可通过 spring.klock.leaseTime 统一配置
lockTimeoutStrategy: 加锁超时的处理策略, 可配置为不做处理, 快速失败, 阻塞等待的处理策略, 默认策略为不做处理
customLockTimeoutStrategy: 自定义加锁超时的处理策略, 需指定自定义处理的方法的方法名, 并保持入参一致.
releaseTimeoutStrategy: 释放锁时, 持有的锁已超时的处理策略, 可配置为不做处理, 快速失败的处理策略, 默认策略为不做处理
customReleaseTimeoutStrategy: 自定义释放锁时, 需指定自定义处理的方法的方法名, 并保持入参一致.
锁超时说明
因为基于 Redis 实现分布式锁, 如果使用不当, 会在以下场景下遇到锁超时的问题:
加锁超时处理策略 (LockTimeoutStrategy):
NO_OPERATION 不做处理, 继续执行业务逻辑
FAIL_FAST 快速失败, 会抛出 KlockTimeoutException
KEEP_ACQUIRE 阻塞等待, 一直阻塞, 直到获得锁, 但在太多的尝试后, 会停止获取锁并报错, 此时很有可能是发生了死锁.
自定义 (customLockTimeoutStrategy) 需指定自定义处理的方法的方法名, 并保持入参一致, 指定自定义处理方法后, 会覆盖上述三种策略, 且会拦截业务逻辑的运行.
释放锁时超时处理策略 (ReleaseTimeoutStrategy):
NO_OPERATION 不做处理, 继续执行业务逻辑
FAIL_FAST 快速失败, 会抛出 KlockTimeoutException
自定义 (customReleaseTimeoutStrategy) 需指定自定义处理的方法的方法名, 并保持入参一致, 指定自定义处理方法后, 会覆盖上述两种策略, 执行自定义处理方法时, 业务逻辑已经执行完毕, 会在方法返回前和 throw 异常前执行.
来源: http://www.bubuko.com/infodetail-3045457.html