redis实现分布式锁

分布式锁一般有三种实现方式：

• Zookeeper
• Redis
• 数据库排他锁

从可靠性和实现的复杂度讲，上面三种方式在可靠性上逐渐降低，在实现复杂度上也是逐渐降低的。在实际使用中，通过redis实现分布式锁是一种比较常见的方式，但是在使用redis实现分布式锁时，有些不正确的实现往往会导致死锁，错误等问题。本篇文章就来讲解一下redis实现分布式锁的常见方式，及redis分布式锁的正确打开方式。

1. 分布式锁

在之前讲Java并发编程的时候，提到了锁的概念，锁可以保证多线程同步访问共享资源，并且Java API也提供了一系列的方法来实现单机环境下多线程同步访问共享资源。但是在分布式环境下，Java API提供的一些列方法就不生效了，这时候为了保证多个实例的多个线程同步访问共享资源，就要使用到分布式锁（如果不使用分布式锁，很有可能导致分布式环境下一致性问题）。

参考Java API锁的概念，我们可以猜想，分布式锁必须有以下特性：

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

2. 分布式锁redis实现

2.1 组件依赖

使用redis实现分布式锁在组件选择上也可以有多种选择，最基本的就是redis客户端jedis，也可以使用Redisson，我们这里使用jedis，maven依赖如下：

<!-- https://mvnrepository.com/artifact/redis.clients/jedis -->
<dependency>
    <groupId>redis.clients</groupId>
    <artifactId>jedis</artifactId>
    <version>3.0.1</version>
</dependency>

2.2 实现示例

2.2.1 加锁

2.2.1.1 错误姿势1

通过jedis.setnx()和jedis.expire()组合实现加锁，如下：

public void wrongGetLock1(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()方法就是给锁加一个过期时间。乍一看好像没什么问题，但是由于这是两条Redis命令，不具有原子性，如果程序在执行完setnx()之后突然崩溃，导致锁没有设置过期时间。那么将会发生死锁。

2.2.1.2 错误姿势2

使用jedis.setnx()命令实现加锁，其中key是锁，value是锁的过期时间，如下:

public boolean wrongGetLock2(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. 通过setnx()方法尝试加锁，如果当前锁不存在，返回加锁成功
2. 如果锁已经存在则获取锁的过期时间，和当前时间比较，如果锁已经过期，则设置新的过期时间，返回加锁成功
3. 其他情况都视为竞争锁失败

但是这段分布式锁的代码依然是有问题的：

1. 当锁过期的时候，如果多个客户端同时执行jedis.getSet()方法，那么虽然最终只有一个客户端可以加锁，但是这个客户端的锁的过期时间可能被其他客户端覆盖
2. 锁不具备拥有者标识，任何客户端都可以解锁

2.2.1.3 正确姿势1

/**
 * 获取分布式锁
 * @param lockKey 锁
 * @param requestId 请求标识
 * @param expireTime 超时时间
 * @return 是否获取成功
 */
public static boolean correctGetLock(String lockKey, String requestId, int expireTime) {

    String result = jedis.set(lockKey, requestId, "NX", "PX", expireTime);

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

加锁逻辑就是通过下面这行代码实现的：

jedis.set(String key, String value, String nxxx, String expx, int time)

该方法共有五个参数：

• key：保证唯一，用来当锁（redis记录的key）
• value：redis记录的value，目的是为了标志锁的所有者（竞争锁的客户端），保证解锁时只能解自己加的锁。requestId可以使用UUID.randomUUID().toString()方法生成
• nxxx：”NX”意思是SET IF NOT EXIST，即当key不存在时，我们进行set操作，若key已经存在，则不做任何操作
• expx：”PX”意思是要给这个key加一个过期的设置（单位毫秒），过期时间由第五个参数决定
• time：expx设置为”PX”时，redis key的过期时间

set()方法就只会导致两种结果：

1. 当前没有锁（key不存在），那么就进行加锁操作，并对锁设置个有效期，竞争锁成功
2. 已有锁存在，不做任何操作，竞争锁失败

对比文章开头讲的分布式锁的特性，分析一下这种实现方式：

• set()加入了NX参数，保证如果已有key存在，竞争锁失败，也就是只有一个客户端能持有锁，满足互斥性
• 对锁设置了过期时间，即使锁的持有者后续发生崩溃而没有解锁，锁也会因为到了过期时间而自动解锁（即key被删除），不会发生死锁
• 将redis key的值设为requestId（全局唯一性Id），标志锁的所有者，并在解锁时作为解锁的依据，保证一个客户端只能解除自己客户端的锁

2.2.2 解锁

2.2.2.1 错误姿势1

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

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

2.2.2.2 错误姿势2

解锁时将加锁时的requestId也作为参数传入到方法中，先通过lockKey获取key对应的value值，如果value值跟requestId一致，说明是自己客户端上的锁，可以解锁，然后调用jedis.del方法，删除redis key解锁，如下：

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

看上去是没什么问题的，但是考虑到这种情况：客户端A加锁，一段时间之后客户端A解锁，在执行jedis.del()之前，锁突然过期了，此时客户端B尝试加锁成功，然后客户端A再执行del()方法，则将客户端B的锁给解除了。也会造成解锁时，将别人加的锁错误解除的情况。

2.2.2.3 正确姿势1

其实上面的解锁示例2已经很接近正确了，唯一的问题是检查和删除操作不是原子的。Redis从2.6之后开始支持lua，并保证lua脚本中的操作都是原子的。那么如果可以通过lua，将上述检查和删除操作实现，那么就是正确的解锁方式了，如下：

 /**
 * 释放分布式锁
 * @param lockKey 锁
 * @param requestId 请求标识
 * @return 是否释放成功
 */
public boolean correctReleaseLock(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;

}

eval命令执行Lua代码的时候，Lua代码将被当成一个命令去执行，并且直到eval命令执行完成，Redis才会执行其他命令，所以保证了检查和删除操作都是原子的。

上述就是通过redis实现分布式锁的正确姿势，但是存在一个问题，上述加锁时只作用在一个Redis节点上，即使Redis通过sentinel模式保证高可用，如果这个master节点由于某些原因发生了主从切换，那么就会出现锁丢失的情况：

1. 在Redis的master节点上拿到了锁
2. 但是这个加锁的key还没有同步到slave节点
3. master故障，发生故障转移，slave节点升级为master节点
4. 导致锁丢失

因此，Redis作者antirez基于分布式环境下提出了一种更高级的分布式锁的实现方式：Redlock。基于Redis的Redisson实现了Redlock，关于Redlock，下篇文章再详细介绍。

参考链接：

1. 80% 人不知道的 Redis 分布式锁的正确实现方式

2. Redis中文社区——Redis分布式锁