redis 不可重入分布式锁(setNx()和getset()方法实现)

一般若是在单机环境，使用synchronized或juc ReentrantLock 实现锁机制，但若是是分布式系统，则须要借助第三方工具实现，好比redis、zookeeper等。
redis为单进程单线程模式，操做都是原子过程，采用队列模式将并发访问变成串行访问，且多客户端对redis的链接并不存在竞争关系。
---------------------

1、redis 基本命令
setnx 命令（『SET if Not eXists』(若是不存在，则 SET)的简写）：
设置成功，返回 1 。
设置失败，返回 0 。
该命令是原子操做。

getset 命令：
自动将key对应到value而且返回原来key对应的value。若是key存在可是对应的value不是字符串，就返回错误。
* 返回值 *：
返回以前的旧值，若是以前Key不存在将返回null。
该命令是原子操做。

get 命令：
get <key> 获取key的值，若是存在，则返回；若是不存在，则返回null；

del 命令：
del <key> 删除key及key对应的值，若是key不存在，程序忽略

2、使用SETNX实现分布式锁
redis官网推荐的setnx实现分布式锁以下，多个进程执行如下Redis命令：
SETNX lock.foo {current Unix time + lock timeout + 1}

若是 SETNX 返回1，说明该进程得到锁，SETNX将键 lock.foo 的值设置为锁的超时时间（当前时间 + 锁的有效时间）。 
若是 SETNX 返回0，说明其余进程已经得到了锁，进程不能进入临界区。进程能够在一个循环中不断地尝试 SETNX 操做，以得到锁。

3、死锁问题
基于setnx、getset命令的分布式锁实现过程当中若是细节不反复测试，很容易出现死锁问题:
考虑一种状况，若是进程得到锁后，断开了与 Redis 的链接（多是进程挂掉，或者网络中断），若是没有有效的释放锁的机制，那么其余进程都会处于一直等待的状态，即出现“死锁”。上面在使用 SETNX 得到锁时，咱们将键 lock.foo 的值设置为锁的有效时间，进程得到锁后，其余进程还会不断的检测锁是否已超时，若是超时，那么等待的进程也将有机会得到锁。然而，锁超时时，咱们不能简单地使用 DEL 命令删除键 lock.foo 以释放锁。考虑如下状况，进程P1已经首先得到了锁 lock.foo，而后进程P1挂掉了。进程P2，P3正在不断地检测锁是否已释放或者已超时，执行流程以下：
P2和P3进程读取键 lock.foo 的值，检测锁是否已超时（经过比较当前时间和键 lock.foo 的值来判断是否超时）
P2和P3进程发现锁 lock.foo 已超时
P2执行 DEL lock.foo命令
P2执行 SETNX lock.foo命令，并返回1，即P2得到锁
P3执行 DEL lock.foo命令将P2刚刚设置的键 lock.foo 删除（这步是因为P3刚才已检测到锁已超时）
P3执行 SETNX lock.foo命令，并返回1，即P3得到锁
P2和P3同时得到了锁
从上面的状况能够得知，在检测到锁超时后，进程不能直接简单地执行 DEL 删除键的操做以得到锁。为了解决上述算法可能出现的多个进程同时得到锁的问题，咱们再来看如下的算法。 
咱们一样假设进程P1已经首先得到了锁 lock.foo，而后进程P1挂掉了。接下来的状况：
进程P4执行 SETNX lock.foo 以尝试获取锁
因为进程P1已得到了锁，因此P4执行 SETNX lock.foo 返回0，即获取锁失败
P4执行 GET lock.foo 来检测锁是否已超时，若是没超时，则等待一段时间，再次检测
若是P4检测到锁已超时，即当前的时间大于键 lock.foo 的值，P4会执行如下操做 
GETSET lock.foo {current Unix timestamp + lock timeout + 1}
因为 GETSET 操做在设置键的值的同时，还会返回键的旧值，经过比较键 lock.foo 的旧值是否小于当前时间，能够判断进程是否已得到锁。
假如另外一个进程P5也检测到锁已超时，并在P4以前执行了 GETSET 操做，那么P4的 GETSET 操做返回的是一个大于当前时间的时间戳，这样P4就不会得到锁而继续等待。注意到，即便P4接下来将键 lock.foo 的值设置了比P5设置的更大的值也没影响。
另外，值得注意的是，在进程释放锁，即执行 DEL lock.foo 操做前，须要先判断锁是否已超时。若是锁已超时，那么锁可能已由其余进程得到，这时直接执行 DEL lock.foo 操做会致使把其余进程已得到 的锁释放掉。

 

4、代码实现
本文基于jedis2.9, 以java语言代码实现，以下:

测试代码入口：
private static final String lockKey = "lock:user_13";  
    public static void main(String[] args) {  
        Jedis jedis = new Jedis("127.0.0.1", 6379);  
          
        DistributedLockHandler distributedLockHandler = new DistributedLockHandler().setJedis(jedis);  
        try{  
            boolean getLock = distributedLockHandler.tryLock(lockKey, Long.valueOf(5));  
  
            if(getLock){  
                // Do your job  
                System.out.println("Do your job........");  
            }  
  
        }catch(Exception e){  
            System.out.println(e);  
        }finally {  
            distributedLockHandler.realseLock(lockKey);  
        }  
          
    }       

分布式锁实现代码:
public class DistributedLockHandler {  
  
    private static final Integer Lock_Timeout = 3;  
    private Jedis jedis;  
  
    /** 
     * 外部调用加锁的方法 
     * @param lockKey 锁的key 
     * @param timeout 超时时间（放置时间长度，如：5L） 
     * @return 
     */  
    public boolean tryLock(String lockKey, Long timeout) {  
        try {  
            Long currentTime = System.currentTimeMillis();//开始加锁的时间  
            boolean result = false;  
              
            while (true) {  
                if ((System.currentTimeMillis() - currentTime) / 1000 > timeout) {//当前时间超过了设定的超时时间  
                    System.out.println("Execute DistributedLockHandler.tryLock method, Time out.");  
                    break;  
                } else {  
                    result = innerTryLock(lockKey);  
                    if (result) {  
                        break;  
                    } else {  
                        System.out.println("Try to get the Lock,and wait 100 millisecond....");  
                        Thread.sleep(100);  
                    }  
                }  
            }  
            return result;  
        } catch (Exception e) {  
            System.out.println("Failed to run DistributedLockHandler.getLock method."+ e);  
            return false;  
        }  
    }  
      
    /** 
     * 释放锁 
     * @param lockKey 锁的名字 
     */  
    public void realseLock(String lockKey) {  
        if(!checkIfLockTimeout(System.currentTimeMillis(), lockKey)){  
            jedis.del(lockKey);  
        }  
    }  
      
    /** 
     * 内部获取锁的实现方法 
     * @param lockKey 锁的名字 
     * @return 
     */  
    private boolean innerTryLock(String lockKey) {  
          
        long currentTime = System.currentTimeMillis();//当前时间  
        String lockTimeDuration = String.valueOf(currentTime + Lock_Timeout + 1);//锁的持续时间  
        Long result = jedis.setnx(lockKey, lockTimeDuration);  
          
        if (result == 1) {  
            return true;  
        } else {  
            if (checkIfLockTimeout(currentTime, lockKey)) {  
                String preLockTimeDuration = jedis.getSet(lockKey, lockTimeDuration);  
                if (currentTime > Long.valueOf(preLockTimeDuration)) {  
                    return true;  
                }  
            }  
            return false;  
        }  
          
    }  
  
    /** 
     * 判断加锁是否超时 
     * @param currentTime 当前时间 
     * @param lockKey 锁的名字 
     * @return 
     */  
    private boolean checkIfLockTimeout(Long currentTime, String lockKey) {  
        if (currentTime > Long.valueOf(jedis.get(lockKey))) {//当前时间超过锁的持续时间  
            return true;  
        } else {  
            return false;  
        }  
    }  
  
    public DistributedLockHandler setJedis(Jedis jedis) {  
        this.jedis = jedis;  
        return this;  
    }  
}  

上述代码已完整实现基于redis setnx的分布式锁，不过该锁机制是不可重入的，与juc中ReentrantLock 可重入锁仍存在距离，以后再分章节实现基于setnx的可重入锁。

参考:1. http://redis.io/commands/setnx2. http://redis.io/topics/distlock---------------------