SpringBoot+一个注解，轻松实现Redis分布式锁

一、业务背景

有些业务请求&＃xff0c;属于耗时操作&＃xff0c;需要加锁&＃xff0c;防止后续的并发操作&＃xff0c;同时对数据库的数据进行操作&＃xff0c;需要避免对之前的业务造成影响。

二、分析流程

使用 Redis 作为分布式锁&＃xff0c;将锁的状态放到 Redis 统一维护&＃xff0c;解决集群中单机 JVM 信息不互通的问题&＃xff0c;规定操作顺序&＃xff0c;保护用户的数据正确。

梳理设计流程

1. 新建注解 &＃64;interface&＃xff0c;在注解里设定入参标志

2. 增加 AOP 切点&＃xff0c;扫描特定注解

3. 建立 &＃64;Aspect 切面任务&＃xff0c;注册 bean 和拦截特定方法

4. 特定方法参数 ProceedingJoinPoint&＃xff0c;对方法 pjp.proceed() 前后进行拦截

5. 切点前进行加锁&＃xff0c;任务执行后进行删除 key

核心步骤&＃xff1a;加锁、解锁和续时

加锁

使用了 RedisTemplate 的 opsForValue.setIfAbsent 方法&＃xff0c;判断是否有 key&＃xff0c;设定一个随机数 UUID.random().toString&＃xff0c;生成一个随机数作为 value。

从 redis 中获取锁之后&＃xff0c;对 key 设定 expire 失效时间&＃xff0c;到期后自动释放锁。

按照这种设计&＃xff0c;只有第一个成功设定 Key 的请求&＃xff0c;才能进行后续的数据操作&＃xff0c;后续其它请求由于无法获得&＃x1f510;资源&＃xff0c;将会失败结束。

超时问题

担心 pjp.proceed() 切点执行的方法太耗时&＃xff0c;导致 Redis 中的 key 由于超时提前释放了。

例如&＃xff0c;线程 A 先获取锁&＃xff0c;proceed 方法耗时&＃xff0c;超过了锁超时时间&＃xff0c;到期释放了锁&＃xff0c;这时另一个线程 B 成功获取 Redis 锁&＃xff0c;两个线程同时对同一批数据进行操作&＃xff0c;导致数据不准确。

解决方案&＃xff1a;增加一个「续时」

任务不完成&＃xff0c;锁不释放&＃xff1a;

维护了一个定时线程池 ScheduledExecutorService&＃xff0c;每隔 2s 去扫描加入队列中的 Task&＃xff0c;判断是否失效时间是否快到了&＃xff0c;公式为&＃xff1a;【失效时间】<&＃61; 【当前时间】&＃43;【失效间隔&＃xff08;三分之一超时&＃xff09;】

/*** 线程池&＃xff0c;每个 JVM 使用一个线程去维护 keyAliveTime&＃xff0c;定时执行 runnable*/
private static final ScheduledExecutorService SCHEDULER &＃61; 
new ScheduledThreadPoolExecutor(1, 
new BasicThreadFactory.Builder().namingPattern("redisLock-schedule-pool").daemon(true).build());
static {SCHEDULER.scheduleAtFixedRate(() -> {// do something to extend time}, 0,  2, TimeUnit.SECONDS);
}

三、设计方案

经过上面的分析&＃xff0c;设计出了这个方案&＃xff1a;

前面已经说了整体流程&＃xff0c;这里强调一下几个核心步骤&＃xff1a;

• 拦截注解 &＃64;RedisLock&＃xff0c;获取必要的参数

• 加锁操作

• 续时操作

• 结束业务&＃xff0c;释放锁

四、实操

之前也有整理过 AOP 使用方法&＃xff0c;可以参考一下

相关属性类配置

业务属性枚举设定

public enum RedisLockTypeEnum {/*** 自定义 key 前缀*/ONE("Business1", "Test1"),TWO("Business2", "Test2");private String code;private String desc;RedisLockTypeEnum(String code, String desc) {this.code &＃61; code;this.desc &＃61; desc;}public String getCode() {return code;}public String getDesc() {return desc;}public String getUniqueKey(String key) {return String.format("%s:%s", this.getCode(), key);}
}

任务队列保存参数

public class RedisLockDefinitionHolder {/*** 业务唯一 key*/private String businessKey;/*** 加锁时间 (秒 s)*/private Long lockTime;/*** 上次更新时间&＃xff08;ms&＃xff09;*/private Long lastModifyTime;/*** 保存当前线程*/private Thread currentTread;/*** 总共尝试次数*/private int tryCount;/*** 当前尝试次数*/private int currentCount;/*** 更新的时间周期&＃xff08;毫秒&＃xff09;,公式 &＃61; 加锁时间&＃xff08;转成毫秒&＃xff09; / 3*/private Long modifyPeriod;public RedisLockDefinitionHolder(String businessKey, Long lockTime, Long lastModifyTime, Thread currentTread, int tryCount) {this.businessKey &＃61; businessKey;this.lockTime &＃61; lockTime;this.lastModifyTime &＃61; lastModifyTime;this.currentTread &＃61; currentTread;this.tryCount &＃61; tryCount;this.modifyPeriod &＃61; lockTime * 1000 / 3;}
}

设定被拦截的注解名字

&＃64;Retention(RetentionPolicy.RUNTIME)
&＃64;Target({ElementType.METHOD, ElementType.TYPE})
public &＃64;interface RedisLockAnnotation {/*** 特定参数识别&＃xff0c;默认取第 0 个下标*/int lockFiled() default 0;/*** 超时重试次数*/int tryCount() default 3;/*** 自定义加锁类型*/RedisLockTypeEnum typeEnum();/*** 释放时间&＃xff0c;秒 s 单位*/long lockTime() default 30;
}

核心切面拦截的操作

RedisLockAspect.java 该类分成三部分来描述具体作用

Pointcut 设定

/*** &＃64;annotation 中的路径表示拦截特定注解*/
&＃64;Pointcut("&＃64;annotation(cn.sevenyuan.demo.aop.lock.RedisLockAnnotation)")
public void redisLockPC() {
}

Around 前后进行加锁和释放锁

前面步骤定义了我们想要拦截的切点&＃xff0c;下一步就是在切点前后做一些自定义操作&＃xff1a;

&＃64;Around(value &＃61; "redisLockPC()")
public Object around(ProceedingJoinPoint pjp) throws Throwable {// 解析参数Method method &＃61; resolveMethod(pjp);RedisLockAnnotation annotation &＃61; method.getAnnotation(RedisLockAnnotation.class);RedisLockTypeEnum typeEnum &＃61; annotation.typeEnum();Object[] params &＃61; pjp.getArgs();String ukString &＃61; params[annotation.lockFiled()].toString();// 省略很多参数校验和判空String businessKey &＃61; typeEnum.getUniqueKey(ukString);String uniqueValue &＃61; UUID.randomUUID().toString();// 加锁Object result &＃61; null;try {boolean isSuccess &＃61; redisTemplate.opsForValue().setIfAbsent(businessKey, uniqueValue);if (!isSuccess) {throw new Exception("You can&＃39;t do it&＃xff0c;because another has get the lock &＃61;-&＃61;");}redisTemplate.expire(businessKey, annotation.lockTime(), TimeUnit.SECONDS);Thread currentThread &＃61; Thread.currentThread();// 将本次 Task 信息加入「延时」队列中holderList.add(new RedisLockDefinitionHolder(businessKey, annotation.lockTime(), System.currentTimeMillis(),currentThread, annotation.tryCount()));// 执行业务操作result &＃61; pjp.proceed();// 线程被中断&＃xff0c;抛出异常&＃xff0c;中断此次请求if (currentThread.isInterrupted()) {throw new InterruptedException("You had been interrupted &＃61;-&＃61;");}} catch (InterruptedException e ) {log.error("Interrupt exception, rollback transaction", e);throw new Exception("Interrupt exception, please send request again");} catch (Exception e) {log.error("has some error, please check again", e);} finally {// 请求结束后&＃xff0c;强制删掉 key&＃xff0c;释放锁redisTemplate.delete(businessKey);log.info("release the lock, businessKey is [" &＃43; businessKey &＃43; "]");}return result;
}

上述流程简单总结一下&＃xff1a;

• 解析注解参数&＃xff0c;获取注解值和方法上的参数值

• redis 加锁并且设置超时时间

• 将本次 Task 信息加入「延时」队列中&＃xff0c;进行续时&＃xff0c;方式提前释放锁

• 加了一个线程中断标志

• 结束请求&＃xff0c;finally 中释放锁

续时操作

这里用了 ScheduledExecutorService&＃xff0c;维护了一个线程&＃xff0c;不断对任务队列中的任务进行判断和延长超时时间&＃xff1a;

// 扫描的任务队列
private static ConcurrentLinkedQueue holderList &＃61; new ConcurrentLinkedQueue();
/*** 线程池&＃xff0c;维护keyAliveTime*/
private static final ScheduledExecutorService SCHEDULER &＃61; new ScheduledThreadPoolExecutor(1,new BasicThreadFactory.Builder().namingPattern("redisLock-schedule-pool").daemon(true).build());
{// 两秒执行一次「续时」操作SCHEDULER.scheduleAtFixedRate(() -> {// 这里记得加 try-catch&＃xff0c;否者报错后定时任务将不会再执行&＃61;-&＃61;Iterator iterator &＃61; holderList.iterator();while (iterator.hasNext()) {RedisLockDefinitionHolder holder &＃61; iterator.next();// 判空if (holder &＃61;&＃61; null) {iterator.remove();continue;}// 判断 key 是否还有效&＃xff0c;无效的话进行移除if (redisTemplate.opsForValue().get(holder.getBusinessKey()) &＃61;&＃61; null) {iterator.remove();continue;}// 超时重试次数&＃xff0c;超过时给线程设定中断if (holder.getCurrentCount() > holder.getTryCount()) {holder.getCurrentTread().interrupt();iterator.remove();continue;}// 判断是否进入最后三分之一时间long curTime &＃61; System.currentTimeMillis();boolean shouldExtend &＃61; (holder.getLastModifyTime() &＃43; holder.getModifyPeriod()) <&＃61; curTime;if (shouldExtend) {holder.setLastModifyTime(curTime);redisTemplate.expire(holder.getBusinessKey(), holder.getLockTime(), TimeUnit.SECONDS);log.info("businessKey : [" &＃43; holder.getBusinessKey() &＃43; "], try count : " &＃43; holder.getCurrentCount());holder.setCurrentCount(holder.getCurrentCount() &＃43; 1);}}}, 0, 2, TimeUnit.SECONDS);
}

这段代码&＃xff0c;用来实现设计图中虚线框的思想&＃xff0c;避免一个请求十分耗时&＃xff0c;导致提前释放了锁。

这里加了「线程中断」Thread#interrupt&＃xff0c;希望超过重试次数后&＃xff0c;能让线程中断&＃xff08;未经严谨测试&＃xff0c;仅供参考哈哈哈哈&＃xff09;

不过建议如果遇到这么耗时的请求&＃xff0c;还是能够从根源上查找&＃xff0c;分析耗时路径&＃xff0c;进行业务优化或其它处理&＃xff0c;避免这些耗时操作。

所以记得多打点 Log&＃xff0c;分析问题时可以更快一点。记录项目日志&＃xff0c;一个注解搞定

五、开始测试

在一个入口方法中&＃xff0c;使用该注解&＃xff0c;然后在业务中模拟耗时请求&＃xff0c;使用了 Thread#sleep

&＃64;GetMapping("/testRedisLock")
&＃64;RedisLockAnnotation(typeEnum &＃61; RedisLockTypeEnum.ONE, lockTime &＃61; 3)
public Book testRedisLock(&＃64;RequestParam("userId") Long userId) {try {log.info("睡眠执行前");Thread.sleep(10000);log.info("睡眠执行后");} catch (Exception e) {// log errorlog.info("has some error", e);}return null;
}

使用时&＃xff0c;在方法上添加该注解&＃xff0c;然后设定相应参数即可&＃xff0c;根据 typeEnum 可以区分多种业务&＃xff0c;限制该业务被同时操作。

测试结果&＃xff1a;

2020-04-04 14:55:50.864  INFO 9326 --- [nio-8081-exec-1] c.s.demo.controller.BookController       : 睡眠执行前
2020-04-04 14:55:52.855  INFO 9326 --- [k-schedule-pool] c.s.demo.aop.lock.RedisLockAspect        : businessKey : [Business1:1024], try count : 0
2020-04-04 14:55:54.851  INFO 9326 --- [k-schedule-pool] c.s.demo.aop.lock.RedisLockAspect        : businessKey : [Business1:1024], try count : 1
2020-04-04 14:55:56.851  INFO 9326 --- [k-schedule-pool] c.s.demo.aop.lock.RedisLockAspect        : businessKey : [Business1:1024], try count : 2
2020-04-04 14:55:58.852  INFO 9326 --- [k-schedule-pool] c.s.demo.aop.lock.RedisLockAspect        : businessKey : [Business1:1024], try count : 3
2020-04-04 14:56:00.857  INFO 9326 --- [nio-8081-exec-1] c.s.demo.controller.BookController       : has some error
java.lang.InterruptedException: sleep interruptedat java.lang.Thread.sleep(Native Method) [na:1.8.0_221]

我这里测试的是重试次数过多&＃xff0c;失败的场景&＃xff0c;如果减少睡眠时间&＃xff0c;就能让业务正常执行。

如果同时请求&＃xff0c;你将会发现以下错误信息&＃xff1a;

表示我们的锁&＃x1f510;的确生效了&＃xff0c;避免了重复请求。

六、总结

对于耗时业务和核心数据&＃xff0c;不能让重复的请求同时操作数据&＃xff0c;避免数据的不正确&＃xff0c;所以要使用分布式锁来对它们进行保护。

再来梳理一下设计流程&＃xff1a;

1. 新建注解 &＃64;interface&＃xff0c;在注解里设定入参标志

2. 增加 AOP 切点&＃xff0c;扫描特定注解

3. 建立 &＃64;Aspect 切面任务&＃xff0c;注册 bean 和拦截特定方法

4. 特定方法参数 ProceedingJoinPoint&＃xff0c;对方法 pjp.proceed() 前后进行拦截

5. 切点前进行加锁&＃xff0c;任务执行后进行删除 key

本次学习是通过 Review 小伙伴的代码设计&＃xff0c;从中了解分布式锁的具体实现&＃xff0c;仿照他的设计&＃xff0c;重新写了一份简化版的业务处理。对于之前没考虑到的「续时」操作&＃xff0c;这里使用了守护线程来定时判断和延长超时时间&＃xff0c;避免了锁提前释放。

于是乎&＃xff0c;同时回顾了三个知识点&＃xff1a;

1、AOP 的实现和常用方法

2、定时线程池 ScheduledExecutorService 的使用和参数含义

3、线程 Thread#interrupt 的含义以及用法&＃xff08;这个挺有意思的&＃xff0c;可以深入再学习一下&＃xff09;

来源&＃xff1a;https://www.zhihu.com/question/41048032

END

精品资料&＃xff0c;超赞福利&＃xff0c;免费领

微信扫码/长按识别 添加【技术交流群】

群内每天分享精品学习资料

关注回复&＃xff1a;Java