redis分布式锁-SETNX实现_setnux-优快云博客

原文地址：https://my.oschina.net/u/1995545/blog/366381

摘要: redis分布式锁-SETNX实现

Redis有一系列的命令，特点是以NX结尾，NX是Not eXists的缩写，如SETNX命令就应该理解为：SET if Not eXists。这系列的命令非常有用，这里讲使用SETNX来实现分布式锁。

用SETNX实现分布式锁
利用SETNX非常简单地实现分布式锁。例如：某客户端要获得一个名字foo的锁，客户端使用下面的命令进行获取：
SETNX lock.foo <current Unix time + lock timeout + 1>

如返回1，则该客户端获得锁，把lock.foo的键值设置为时间值表示该键已被锁定，该客户端最后可以通过DEL lock.foo来释放该锁。
如返回0，表明该锁已被其他客户端取得，这时我们可以先返回或进行重试等对方完成或等待锁超时。

解决死锁
上面的锁定逻辑有一个问题：如果一个持有锁的客户端失败或崩溃了不能释放锁，该怎么解决？我们可以通过锁的键对应的时间戳来判断这种情况是否发生了，如果当前的时间已经大于lock.foo的值，说明该锁已失效，可以被重新使用。

发生这种情况时，可不能简单的通过DEL来删除锁，然后再SETNX一次，当多个客户端检测到锁超时后都会尝试去释放它，这里就可能出现一个竞态条件,让我们模拟一下这个场景：

C0操作超时了，但它还持有着锁，C1和C2读取lock.foo检查时间戳，先后发现超时了。
C1 发送DEL lock.foo
C1 发送SETNX lock.foo 并且成功了。
C2 发送DEL lock.foo
C2 发送SETNX lock.foo 并且成功了。
这样一来，C1，C2都拿到了锁！问题大了！

幸好这种问题是可以避免的，让我们来看看C3这个客户端是怎样做的：

C3发送SETNX lock.foo 想要获得锁，由于C0还持有锁，所以Redis返回给C3一个0
C3发送GET lock.foo 以检查锁是否超时了，如果没超时，则等待或重试。
反之，如果已超时，C3通过下面的操作来尝试获得锁：
GETSET lock.foo <current Unix time + lock timeout + 1>
通过GETSET，C3拿到的时间戳如果仍然是超时的，那就说明，C3如愿以偿拿到锁了。
如果在C3之前，有个叫C4的客户端比C3快一步执行了上面的操作，那么C3拿到的时间戳是个未超时的值，这时，C3没有如期获得锁，需要再次等待或重试。留意一下，尽管C3没拿到锁，但它改写了C4设置的锁的超时值，不过这一点非常微小的误差带来的影响可以忽略不计。

注意：为了让分布式锁的算法更稳键些，持有锁的客户端在解锁之前应该再检查一次自己的锁是否已经超时，再去做DEL操作，因为可能客户端因为某个耗时的操作而挂起，操作完的时候锁因为超时已经被别人获得，这时就不必解锁了。

示例伪代码
根据上面的代码，我写了一小段Fake代码来描述使用分布式锁的全过程：
# get lock
lock = 0
while lock != 1:
    timestamp = current Unix time + lock timeout + 1
    lock = SETNX lock.foo timestamp
    if lock == 1 or (now() > (GET lock.foo) and now() > (GETSET lock.foo timestamp)):
        break;
    else:
        sleep(10ms)

# do your job
do_job()

# release
if now() < GET lock.foo:
    DEL lock.foo
是的，要想这段逻辑可以重用，使用python的你马上就想到了Decorator，而用Java的你是不是也想到了那谁？AOP + annotation？行，怎样舒服怎样用吧，别重复代码就行。

java之jedis实现
expireMsecs 锁持有超时，防止线程在入锁以后，无限的执行下去，让锁无法释放
timeoutMsecs 锁等待超时，防止线程饥饿，永远没有入锁执行代码的机会

    /**
     * Acquire lock.
     * 
     * @param jedis
     * @return true if lock is acquired, false acquire timeouted
     * @throws InterruptedException
     *             in case of thread interruption
     */
	public synchronized boolean acquire(Jedis jedis) throws InterruptedException {
		int timeout = timeoutMsecs;
		while (timeout >= 0) {
			long expires = System.currentTimeMillis() + expireMsecs + 1;
			// 锁到期时间
			String expiresStr = String.valueOf(expires);
			// setnx命令就是如果key没有value则给key设置值value并返回1否则返回0
			// 全称：SET if Not eXists
			if (jedis.setnx(lockKey, expiresStr) == 1) {
				// lock acquired
				locked = true;
				return true;
			}
			// 获取redis中这个key的值即设置的过期时间戳
			String currentValueStr = jedis.get(lockKey); 
			//判断是否为空，不为空的情况下，如果被其他线程设置了值，则第二个条件判断是过不去的
			//在不为空的条件下，判断之前线程设置的加锁时间是否过期，如果没有过期则表示该线程还没有释放该锁，所以该线程获取不到这个锁
			if (currentValueStr != null && Long.parseLong(currentValueStr) < System.currentTimeMillis()) {
				// lock is expired
				// 获取上一个锁到期时间，并设置现在的锁到期时间
				// 只有一个线程才能获得上一个线程设置的时间，因为jedis.getSet是同步的
				String oldValueStr = jedis.getSet(lockKey, expiresStr);
				// 如果这个时候多个线程恰好都到了这里，但是只有一个线程获得了之前锁的时间戳，所以只有这个线程才能获得本次的锁
				if (oldValueStr != null && oldValueStr.equals(currentValueStr)) {
					// lock acquired
					locked = true;
					return true;
				}
			}
			timeout -= 100;
			Thread.sleep(100);
		}
		return false;
	}

一般用法
其中很多繁琐的边缘代码
包括：异常处理，释放资源等等

	JedisPool pool;
	JedisLock jedisLock = new JedisLock(pool.getResource(), lockKey, timeoutMsecs, expireMsecs);
	try{
		if (jedisLock.acquire()) { // 启用锁
			// 执行业务逻辑
		} else {
			logger.info("The time wait for lock more than [{}] ms ", timeoutMsecs);
		}
	}catch(Throwable t){
		// 分布式锁异常
		logger.warn(t.getMessage(), t);
	}finally{
		if (jedisLock != null) {
			try {
				jedisLock.release();// 则解锁
			} catch (Exception e) {
			}
		}
		if (jedis != null) {
			try {
				pool.returnResource(jedis);// 还到连接池里
			} catch (Exception e) {
			}
		}
	}

redis分布式锁算法说明：

1、Setnx 命令，设置key的值来获取锁，如果key的值存在了获取不到，如果不存在则该线程设置值获取了锁。

2、getSet命令，看那个线程先获得之前线程设置的值：

	  String currentValueStr = jedis.get(lockKey); //redis里的时间
      if (currentValueStr != null && Long.parseLong(currentValueStr) < System.currentTimeMillis()) {
          String oldValueStr = jedis.getSet(lockKey, expiresStr);
          //获取上一个锁到期时间，并设置现在的锁到期时间，
          //只有一个线程才能获取上一个线上的设置时间，因为jedis.getSet是同步的
          if (oldValueStr != null && oldValueStr.equals(currentValueStr)) {
              //如过这个时候，多个线程恰好都到了这里，但是只有一个线程的设置值和当前值相同，他才有权利获取锁
              // lock acquired
              locked = true;
              return true;
          }
      }

其实这里的if条件能走的条件就是之前线程获得锁后出现异常没有释放锁的情况下才会走，或者说获得锁后执行的业务代码很耗时，到了锁过期时间还没执行完这样的情况下才会执行。正常释放的情况下setnx就能获得锁。