Redis系列四

前言

分布式锁一般有3中实现方式：

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

以下将详细介绍如何正确地实现Redis分布式锁。

---

可靠性

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

• 互斥性。在任意时刻，只有一个客户端持有锁。
• 不会发生死锁。即使一个客户端在持有锁的期间发生崩溃而没有主动释放锁，也能保证后续其他客户端能加锁。
• 具有容错性。只要大部分的 Redis 节点正常运行，客户端就可以加锁和解锁。
• 解铃还须系铃人。加锁和解锁必须是同一个客户端，客户端自己不能把别人加的锁给解了。

---

 代码实现

　组件依赖

　　首先我们通过 Maven 引入 Jedis 开源组件，在 pom.xml 文件加入以下代码：

Redis历史版本及特性，请参考：Sunny的《Redis版本历史介绍》

<dependency>
    <groupId>redis.clientsgroupId</groupId>
    <artifactId>jedisartifactId</artifactId>
    <version>3.0version</version>
</dependency>

　加锁代码

　　先放代码，后面再解释为什么这样实现：

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( ) 方法一共5个形参：

　　第一个是 key，我们使用 key来当锁，因为 key 是唯一的。

　　第二个是value，入参是 requestId，很多人不明白，有 key 作为锁不就够了吗，为何还要用到value？

　　因为我们上面讲到的可靠性里，分布式锁要满足第4个条件：解铃还须系铃人，通过给 value 赋值为 requestId，我们就知道这把锁是哪个请求加的，在解锁的时候可以有依据。

　　requestId 可以使用UUID.random().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 单机部署的场景，所以容错性暂不考虑。

　错误示例一

　　比较常见的错误示例就是使用 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() 方法。

　错误示例二

　　这种错误示例就是比较难发现问题，而且实现也比较复杂。实现思路：使用 jedis.setnx( key, value) 命令实现加锁，其中 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.setnx(k, v) 方法，那么虽然只有一个客户端可以加锁，但是这个客户端的锁过期时间可能会被其他客户端覆盖。
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 服务端执行。

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

　　很简单，首先获取锁对应的 value 值，检查是否与 requestId 相等，如果相等则删除锁（解锁）。

　　那么为什么要使用Lua语言来说实现呢？

　　因为要确保上述操作是原子性的。关于非原子性会带来的问题，可以阅读【解锁代码 - 错误示例二】。

　　那么为什么执行 eval() 方法可以确保原子性？

　　源于 Redis 的特性，下面是官网对 eval 命令的部分解释：简单来说，就是在 eval 命令执行Lua代码的时候，Lua代码将被当成一个命令去执行，并且直到 eval 命令执行完成，Redis 才会执行其他命令。

　错误示例一

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

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

　错误示例二

　　这种解锁代码咋一看也是没有问题的，与正确姿势差不多，唯一区别的是分成两条命令去执行。代码如下：

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再执行 jedis.del() 方法，则会将客户端B的锁给解除。

---

总结

　　想要通过 Redis实现分布式锁并不难，只要保证能满足可靠性里的四个条件。

　　如果项目中Redis是多机部署，那么可以尝试使用 Redisson 实现分布式锁。