Redis分布式锁的实现

分布式锁一般有三种实现方式：1. 数据库乐观锁；2. 基于Redis的分布式锁；3. 基于ZooKeeper的分布式锁。本文将基于Redis实现分布式锁。

可靠性

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

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

代码实现

组件依赖

引入Jedis开源组件

<dependency><groupId>redis.clients</groupId><artifactId>jedis</artifactId><version>2.9.0</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()方法一共有五个形参：

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

执行上面的set()方法就只会导致两种结果：1. 当前没有锁（key不存在），那么就进行加锁操作，并对锁设置个有效期，同时value表示加锁的用户端。2. 已有锁存在，不做任何操作。

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

解锁代码

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 = "if redis.call('get', KEYS[1]) == ARGV[1] then return redis.call('del', KEYS[1]) else return 0 end";Object result = jedis.eval(, 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语言来实现呢？由于要确保上述操作是原子性的。Redis eval()方法执行Lua代码的时候，Lua代码将被当成一个命令去执行，并且直到eval命令执行完成，Redis才会执行其余命令。

下面代码与正确代码差不多，唯一区别的是分成两条命令去执行，代码如下：

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的锁给解除了。