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

Posted 2020-11-27 那些年的代码

一、前言

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

        

    1、数据库乐观锁；

    2、基于Redis的分布式锁；

    3、基于zookeeper的分布式锁

 

 

 

二、可靠性

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

        

    1、互斥性。在任意时刻，只有一个客户端持有锁；

    2、不会发生死锁。即使有一个客户端在持有锁的期间崩溃而没有主动释放锁，也能保证后续其他客户端能加锁；

    3、具有容错性。只要大部分的Redis节点正常运行，客户端就可以加锁。

    4、加锁和解锁必须是同一客户端。

 

 

 

三、代码实现

    1、组件依赖

            通过Maven引入Jedis组件，在pom.xml文件引入jar包：

<dependency>

    <groupId>redis.clients</groupId>

    <artifactId>jedis</artifactId>

    <version>2.9.0</version>

</dependency>

    

    2、加锁代码

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单机部署的场景，所以容错性我们暂不考虑。

    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语言来实            现呢？因为要确保上述操作是原子性的。那么为什么执行eval()方法可以确保原子性，简单来说，就是在eval命令执行Lua代码的时候，Lua代码将被当成一个命令去执            行，并且直到eval命令执行完成，Redis才会执行其他命令。