Java 实现基于Redis的分布式可重入锁

Java 实现基于Redis的分布式可重入锁

之前在 Java实现基于的Redis的分布式锁 这篇文章中，已经实现了加锁的逻辑，但是有个缺点，就是不可重入，任何重入锁的尝试都会导致死锁的发生，想了一下，这个问题可以解决。

 

 

Thinking

 

如何实现可重入？

 

首先锁信息(指redis中lockKey关联的value值) 必须得设计的能负载更多信息，之前non-reentrant时value直接就是一个超时时间，但是要实现可重入单超时时间是不够的，必须要标识锁是被谁持有的，也就是说要标识分布式环境中的线程，还要记录锁被入了多少次。

 

 

如何在分布式线程中标识唯一线程？

 

MAC地址 + jvm进程ID + 线程ID（或者线程地址都行）,三者结合即可唯一分布式环境中的线程。

 

 

实现

 

 代码框架还是和之前实现的非重入的差不多，重点是lock方法，代码已有非常详细的注释

 

Java代码 

1. package cc.lixiaohui.lock.redis;  
2.   
3. import java.io.IOException;  
4. import java.net.SocketAddress;  
5. import java.util.concurrent.TimeUnit;  
6.   
7. import org.slf4j.Logger;  
8. import org.slf4j.LoggerFactory;  
9.   
10. import redis.clients.jedis.Jedis;  
11. import cc.lixiaohui.lock.AbstractLock;  
12. import cc.lixiaohui.lock.Lock;  
13. import cc.lixiaohui.lock.time.nio.client.TimeClient;  
14. import cc.lixiaohui.lock.util.LockInfo;  
15.   
16. /** 
17.  * 基于Redis的SETNX操作实现的分布式锁, 获取锁时最好用tryLock(long time, TimeUnit unit), 以免网路问题而导致线程一直阻塞. 
18.  * <a href="http://redis.io/commands/setnx">SETNC操作参考资料.</a> 
19.  *  
20.  * <p><b>可重入实现关键:</b> 
21.  * <ul> 
22.  * <li>在分布式环境中如何确定一个线程? <i><b>mac地址 + jvm pid + threadId</b></i> (mac地址唯一, jvm 
23.  * pid在单机内唯一, threadId在单jvm内唯一)</li> 
24.  * <li>任何一个线程从redis拿到value值后都需要能确定 该锁是否被自己持有, 因此value值要有以下特性: 保存持有锁的主机(mac), jvm 
25.  * pid, 持有锁的线程ID, 重复持有锁的次数</li> 
26.  * </ul></p> 
27.  * <p> 
28.  * redis中value设计如下(in json): 
29.  * <pre> 
30.  * {  
31.  *  expires : expire time in long 
32.  *  mac : mac address of lock holder's machine 
33.  *  pid : jvm process id 
34.  *  threadId : lock holder thread id 
35.  *  count : hold count(for use of reentrancy) 
36.  * } 
37.  * 由{@link LockInfo LockInfo}表示. 
38.  * </pre> 
39.  *  
40.  * <b>Usage Example:</b> 
41.  * <pre> 
42.  *  {@link Lock} lock = new {@link ReentrantLock}(jedis, "lockKey", lockExpires, timeServerAddr); 
43.  *  if (lock.tryLock(3, TimeUnit.SECONDS)) {  
44.  *      try {  
45.  *          // do something 
46.  *      } catch (Exception e) {  
47.  *          lock.unlock(); 
48.  *      } 
49.  *  } 
50.  * </pre> 
51.  * </p> 
52.  *  
53.  * @author lixiaohui 
54.  * @date 2016年9月15日 下午2:52:38 
55.  * 
56.  */  
57. public class ReentrantLock extends AbstractLock {  
58.   
59.     private Jedis jedis;  
60.   
61.     private TimeClient timeClient;  
62.   
63.     // 锁的名字  
64.     protected String lockKey;  
65.   
66.     // 锁的有效时长(毫秒)  
67.     protected long lockExpires;  
68.   
69.     private static final Logger logger = LoggerFactory.getLogger(ReentrantLock.class);  
70.   
71.     public ReentrantLock(Jedis jedis, String lockKey, long lockExpires, SocketAddress timeServerAddr) throws IOException {  
72.         this.jedis = jedis;  
73.         this.lockKey = lockKey;  
74.         this.lockExpires = lockExpires;  
75.         timeClient = new TimeClient(timeServerAddr);  
76.     }  
77.   
78.     // 阻塞式获取锁的实现  
79.     protected boolean lock(boolean useTimeout, long time, TimeUnit unit, boolean interrupt) throws InterruptedException {  
80.         if (interrupt) {  
81.             checkInterruption();  
82.         }  
83.   
84.         // 超时控制 的时间可以从本地获取, 因为这个和锁超时没有关系, 只是一段时间区间的控制  
85.         long start = localTimeMillis();  
86.         long timeout = unit.toMillis(time); // if !useTimeout, then it's useless  
87.   
88.         // walkthrough  
89.         // 1. lockKey未关联value, 直接设置lockKey, 成功获取到锁, return true  
90.         // 2. lock 已过期, 用getset设置lockKey, 判断返回的旧的LockInfo  
91.         // 2.1 若仍是超时的, 则成功获取到锁, return true  
92.         // 2.2 若不是超时的, 则进入下一次循环重新开始 步骤1  
93.         // 3. lock没过期, 判断是否是当前线程持有  
94.         // 3.1 是, 则计数加 1, return true  
95.         // 3.2 否, 则进入下一次循环重新开始 步骤1  
96.         // note: 每次进入循环都检查 : 1.是否超时, 若是则return false; 2.是否检查中断(interrupt)被中断,  
97.         // 若需检查中断且被中断, 则抛InterruptedException  
98.         while (useTimeout ? !isTimeout(start, timeout) : true) {  
99.             if (interrupt) {  
100.                 checkInterruption();  
101.             }  
102.   
103.             long lockExpireTime = serverTimeMillis() + lockExpires + 1;// 锁超时时间  
104.             String newLockInfoJson = LockInfo.newForCurrThread(lockExpireTime).toString();  
105.             if (jedis.setnx(lockKey, newLockInfoJson) == 1) { // 条件能成立的唯一情况就是redis中lockKey还未关联value  
106.                 // TODO 成功获取到锁, 设置相关标识  
107.                 logger.debug("{} get lock(new), lockInfo: {}", Thread.currentThread().getName(), newLockInfoJson);  
108.                 locked = true;  
109.                 return true;  
110.             }