Redis 分布式锁的正确实现方式

转载： https://wudashan.cn/2017/10/2...

前言

分布式锁通常有三种实现方式：

1. 数据库乐观锁；
2. 基于 Redis 的分布式锁；
3. 基于 ZooKeeper 的分布式锁。

本篇博客将介绍第二种方式，基于 Redis 实现分布式锁。虽然网上已经有各类介绍 Redis 分布式锁实现的博客，然而他们的实现却有着各类各样的问题，为了不误人子弟，本篇博客将详细介绍如何正确地实现 Redis 分布式锁。

可靠性

首先，为了确保分布式锁可用，咱们至少要确保锁的实现同时知足如下四个条件：

1. 互斥性。在任意时刻，只有一个客户端能持有锁。
2. 不会发生死锁。即便有一个客户端在持有锁的期间崩溃而没有主动解锁，也能保证后续其余客户端能加锁。
3. 具备容错性。只要大部分的 Redis 节点正常运行，客户端就能够加锁和解锁。
4. 解铃还须系铃人。加锁和解锁必须是同一个客户端，客户端本身不能把别人加的锁给解了。

代码实现

组件依赖

首先咱们要经过 Maven 引入 Jedis 开源组件，在 pom.xml 文件加入下面的代码：

<dependency>
    <groupId>redis.clients</groupId>
    <artifactId>jedis</artifactId>
    <version>2.9.0</version>
</dependency>

加锁代码

正确姿式

Talk is cheap, show me the code。先展现代码，再带你们慢慢解释为何这样实现：

public class RedisTool {

    private static final String LOCK_SUCCESS = "OK";
    private static final String SET_IF_NOT_EXIST = "NX";
    private static final String SET_WITH_EXPIRE_TIME = "PX";

    /**
     * 尝试获取分布式锁
     * @param jedis Redis客户端
     * @param lockKey 锁
     * @param requestId 请求标识
     * @param expireTime 超期时间
     * @return 是否获取成功
     */
    public static boolean tryGetDistributedLock(Jedis jedis, String lockKey, String requestId, int expireTime) {

        String result = jedis.set(lockKey, requestId, SET_IF_NOT_EXIST, SET_WITH_EXPIRE_TIME, expireTime);

        if (LOCK_SUCCESS.equals(result)) {
            return true;
        }
        return false;
    }
}

能够看到，咱们加锁就一行代码：jedis.set(String key, String value, String nxxx, String expx, int time)，这个 set()方法一共有五个形参：

• 第一个为 key，咱们使用 key 来当锁，由于 key 是惟一的。
• 第二个为 value，咱们传的是 requestId，不少童鞋可能不明白，有 key 做为锁不就够了吗，为何还要用到 value？缘由就是咱们在上面讲到可靠性时，分布式锁要知足第四个条件解铃还须系铃人，经过给 value 赋值为 requestId，咱们就知道这把锁是哪一个请求加的了，在解锁的时候就能够有依据。requestId 可使用 UUID.randomUUID().toString()方法生成。
• 第三个为 nxxx，这个参数咱们填的是 NX，意思是 SET IF NOT EXIST，即当 key 不存在时，咱们进行 set 操做；若 key 已经存在，则不作任何操做；
• 第四个为 expx，这个参数咱们传的是 PX，意思是咱们要给这个 key 加一个过时的设置，具体时间由第五个参数决定。
• 第五个为 time，与第四个参数相呼应，表明 key 的过时时间。

总的来讲，执行上面的 set()方法就只会致使两种结果：

1. 当前没有锁（key 不存在），那么就进行加锁操做，并对锁设置个有效期，同时 value 表示加锁的客户端。
2. 已有锁存在，不作任何操做。

心细的童鞋就会发现了，咱们的加锁代码知足咱们可靠性里描述的三个条件。首先，set()加入了 NX 参数，能够保证若是已有 key 存在，则函数不会调用成功，也就是只有一个客户端能持有锁，知足互斥性。其次，因为咱们对锁设置了过时时间，即便锁的持有者后续发生崩溃而没有解锁，锁也会由于到了过时时间而自动解锁（即 key 被删除），不会发生死锁。最后，由于咱们将 value 赋值为 requestId，表明加锁的客户端请求标识，那么在客户端在解锁的时候就能够进行校验是不是同一个客户端。因为咱们只考虑 Redis 单机部署的场景，因此容错性咱们暂不考虑。

错误示例 1

比较常见的错误示例就是使用 jedis.setnx()和 jedis.expire()组合实现加锁，代码以下：

public static void wrongGetLock1(Jedis jedis, String lockKey, String requestId, int expireTime) {

    Long result = jedis.setnx(lockKey, requestId);
    if (result == 1) {
        // 若在这里程序忽然崩溃，则没法设置过时时间，将发生死锁
        jedis.expire(lockKey, expireTime);
    }

}

setnx()方法做用就是 SET IF NOT EXIST，expire()方法就是给锁加一个过时时间。乍一看好像和前面的 set()方法结果同样，然而因为这是两条 Redis 命令，不具备原子性，若是程序在执行完 setnx()以后忽然崩溃，致使锁没有设置过时时间。那么将会发生死锁。网上之因此有人这样实现，是由于低版本的 jedis 并不支持多参数的 set()方法。

错误示例 2

这一种错误示例就比较难以发现问题，并且实现也比较复杂。

实现思路：使用 jedis.setnx()命令实现加锁，其中 key 是锁，value 是锁的过时时间。

执行过程:

1. 经过 setnx()方法尝试加锁，若是当前锁不存在，返回加锁成功。
2. 若是锁已经存在则获取锁的过时时间，和当前时间比较，若是锁已通过期，则设置新的过时时间，返回加锁成功。

代码以下：

public static boolean wrongGetLock2(Jedis jedis, String lockKey, int expireTime) {

    long expires = System.currentTimeMillis() + expireTime;
    String expiresStr = String.valueOf(expires);

    // 若是当前锁不存在，返回加锁成功
    if (jedis.setnx(lockKey, expiresStr) == 1) {
        return true;
    }

    // 若是锁存在，获取锁的过时时间
    String currentValueStr = jedis.get(lockKey);
    if (currentValueStr != null && Long.parseLong(currentValueStr) < System.currentTimeMillis()) {
        // 锁已过时，获取上一个锁的过时时间，并设置如今锁的过时时间
        String oldValueStr = jedis.getSet(lockKey, expiresStr);
        if (oldValueStr != null && oldValueStr.equals(currentValueStr)) {
            // 考虑多线程并发的状况，只有一个线程的设置值和当前值相同，它才有权利加锁
            return true;
        }
    }
        
    // 其余状况，一概返回加锁失败
    return false;
}

那么这段代码问题在哪里？

1. 因为是客户端本身生成过时时间，因此须要强制要求分布式下每一个客户端的时间必须同步。
2. 当锁过时的时候，若是多个客户端同时执行 jedis.getSet()方法，那么虽然最终只有一个客户端能够加锁，可是这个客户端的锁的过时时间可能被其余客户端覆盖。
3. 锁不具有拥有者标识，即任何客户端均可以解锁。

解锁代码

正确姿式

仍是先展现代码，再带你们慢慢解释为何这样实现：

public class RedisTool {

    private static final Long RELEASE_SUCCESS = 1L;

    /**
     * 释放分布式锁
     * @param jedis Redis客户端
     * @param lockKey 锁
     * @param requestId 请求标识
     * @return 是否释放成功
     */
    public static boolean releaseDistributedLock(Jedis jedis, String lockKey, String requestId) {

        String script = "if redis.call('get', KEYS[1]) == ARGV[1] then return redis.call('del', KEYS[1]) else return 0 end";
        Object result = jedis.eval(script, Collections.singletonList(lockKey), Collections.singletonList(requestId));

        if (RELEASE_SUCCESS.equals(result)) {
            return true;
        }
        return false;
    }
}

能够看到，咱们解锁只须要两行代码就搞定了！第一行代码，咱们写了一个简单的 Lua 脚本代码，上一次见到这个编程语言仍是在《黑客与画家》里，没想到此次竟然用上了。第二行代码，咱们将 Lua 代码传到 jedis.eval()方法里，并使参数 KEYS[1]赋值为 lockKey，ARGV[1]赋值为 requestId。

eval()方法是将 Lua 代码交给 Redis 服务端执行。

那么这段 Lua 代码的功能是什么呢？

其实很简单，首先获取锁对应的 value 值，检查是否与 requestId 相等，若是相等则删除锁（解锁）。那么为何要使用 Lua 语言来实现呢？由于要确保上述操做是原子性的。关于非原子性会带来什么问题，能够阅读【解锁代码-错误示例 2】 。那么为何执行 eval()方法能够确保原子性，源于 Redis 的特性，下面是官网对 eval 命令的部分解释：

简单来讲，就是在 eval 命令执行 Lua 代码的时候，Lua 代码将被当成一个命令去执行，而且直到 eval 命令执行完成，Redis 才会执行其余命令。

错误示例 1

最多见的解锁代码就是直接使用 jedis.del()方法删除锁，这种不先判断锁的拥有者而直接解锁的方式，会致使任何客户端均可以随时进行解锁，即便这把锁不是它的。

public static void wrongReleaseLock1(Jedis jedis, String lockKey) {
    jedis.del(lockKey);
}

<span id="wrongDemo2">错误示例 2</span>

这种解锁代码乍一看也是没问题，甚至我以前也差点这样实现，与正确姿式差很少，惟一区别的是分红两条命令去执行，代码以下：

public static void wrongReleaseLock2(Jedis jedis, String lockKey, String requestId) {
        
    // 判断加锁与解锁是否是同一个客户端
    if (requestId.equals(jedis.get(lockKey))) {
        // 若在此时，这把锁忽然不是这个客户端的，则会误解锁
        jedis.del(lockKey);
    }
}

如代码注释，问题在于若是调用 jedis.del()方法的时候，这把锁已经不属于当前客户端的时候会解除他人加的锁。那么是否真的有这种场景？答案是确定的，好比客户端 A 加锁，一段时间以后客户端 A 解锁，在执行 jedis.del()以前，锁忽然过时了，此时客户端 B 尝试加锁成功，而后客户端 A 再执行 del()方法，则将客户端 B 的锁给解除了。

总结

本文主要介绍了如何使用 Java 代码正确实现 Redis 分布式锁，对于加锁和解锁也分别给出了两个比较经典的错误示例。其实想要经过 Redis 实现分布式锁并不难，只要保证能知足可靠性里的四个条件。互联网虽然给咱们带来了方便，只要有问题就能够 google，然而网上的答案必定是对的吗？其实否则，因此咱们更应该时刻保持着质疑精神，多想多验证。

若是你的项目中 Redis 是多机部署的，那么能够尝试使用 Redisson 实现分布式锁，这是 Redis 官方提供的 Java 组件，连接在参考阅读章节已经给出。

参考阅读

[1] Distributed locks with Redis

[2] EVAL command

[3] Redisson