java并发（二十二）分布式锁

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); //锁到期时间

            if (jedis.setnx(lockKey, expiresStr) == 1) {
                // lock acquired
                locked = true;
                return true;
            }

            String currentValueStr = jedis.get(lockKey); //redis里的时间
            if (currentValueStr != null && Long.parseLong(currentValueStr) < System.currentTimeMillis()) {
                //判断是否为空，不为空的情况下，如果被其他线程设置了值，则第二个条件判断是过不去的
                // lock is expired

                String oldValueStr = jedis.getSet(lockKey, expiresStr);
                //获取上一个锁到期时间，并设置现在的锁到期时间，
                //只有一个线程才能获取上一个线上的设置时间，因为jedis.getSet是同步的
                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) {
                }
            }
        }

犀利用法
用匿名类来实现，代码非常简洁
至于SimpleLock的实现，请在我附件中下载查看

        SimpleLock lock = new SimpleLock(key);
        lock.wrap(new Runnable() {
            @Override
            public void run() {
                //此处代码是锁上的
            }
        });

20180330
和同事一起吃饭，聊到释放锁的时候，要是同一个线程。所以这一部分在获取锁的时候，要增加token，如果不是同一个线程，不允许释放锁。

附件是分布式锁的完整实现和用法，有需要交流的朋友，可以随时留言。

评论

10 楼 85977328 2014-03-20  

引用

JAVA实现的失效的情况是，两台完全同步的机器，每步代码执行的速度都一样，有可能让多个节点同时拿到锁。

精辟，如果完全相同，完全同步，不会有问题
第21行 String currentValueStr = jedis.get(lockKey); //redis里的时间
获取的值完全相同

但是第26行 String oldValueStr = jedis.getSet(lockKey, expiresStr); 
只有一个客户端能获取到超时很大的时间
然后进行下一步的相等判断，进而取得锁

9 楼 gaddma 2014-03-20  

学习了很不错

因为JAVA的实现和伪代码的实现有所不同，所以仔细对比了一下
伪代码是通过  当前时间  和  getset返回的库里面的时间对比  判断谁应该拿到锁。
JAVA实现是通过 对比两次get 和 getset的返回值的不同，来判断谁应该拿到锁。

两种实现在大多数情况都不会出问题，但是也有失败的情况
1，伪代码失效的情况是 设置超时时间和get的网络开销不相上下的时候。这样容易让一行三次获取数据最后导致成功，很容易让锁失效，替代前一个锁，不过这不算问题，因为设置过小的锁超时时间本身就是程序bug，而且就算这种情况也可以保证每个获取锁的节点依次的进入锁。

2，JAVA实现的失效的情况是，两台完全同步的机器，每步代码执行的速度都一样，有可能让多个节点同时拿到锁。

个人比较赞同伪代码中的实现。
原因是伪代码 如果超时时间设置合理的话，后续的节点最多会把超时时间延迟个几个毫秒，但是后续的节点都不会拿到锁。

建议修改~

8 楼 85977328 2014-03-13  

xugangqiang 写道

85977328 写道

xugangqiang 写道

牛人们，在写这么NB的代码前，
能不能简单的说下使用的场景？
即为什么需要使用分布式锁？

现在的应用，都是无状态应用
多台服务器，想建立同步块的时候
就得分布式锁

为什么多台服务器需要建立同步块？
有没有不需要分布式锁的实现？

有啊
只有及个别案例，需要分布式锁
根据CAP理论
强一致性这种
执行一种操作，要求阻塞全部服务器集群的应用
比如缓的失效中心等等

7 楼 xugangqiang 2014-03-13  

85977328 写道

xugangqiang 写道

牛人们，在写这么NB的代码前，
能不能简单的说下使用的场景？
即为什么需要使用分布式锁？

现在的应用，都是无状态应用
多台服务器，想建立同步块的时候
就得分布式锁

为什么多台服务器需要建立同步块？
有没有不需要分布式锁的实现？

6 楼 85977328 2014-03-13  

xugangqiang 写道

牛人们，在写这么NB的代码前，
能不能简单的说下使用的场景？
即为什么需要使用分布式锁？

现在的应用，都是无状态应用
多台服务器，想建立同步块的时候
就得分布式锁

5 楼 xugangqiang 2014-03-13  

牛人们，在写这么NB的代码前，
能不能简单的说下使用的场景？
即为什么需要使用分布式锁？

4 楼 85977328 2014-03-13  

gaddma 写道

nice , 学习了

是慕童吗？

3 楼 gaddma 2014-03-13  

nice , 学习了

2 楼 85977328 2014-03-13  

jianfeihit 写道

写的不错，学习了

杨总没事多来逛逛～

1 楼 jianfeihit 2014-03-13  

写的不错，学习了