基于Redis实现的分布式锁

一、写在前面

分布式锁的实现方式：

  1. 数据库乐观锁；

  2. 基于Redis的分布式锁；

  3. 基于ZooKeeper的分布式锁。

本文将详细介绍如何正确简单地实现Redis分布式锁。

 

二、分布式锁之可靠性

 1. 互斥：在任意时刻，只有一个客户端能持有锁

 2. 容错：只要大部分的Redis节点正常运行，客户端就可以加锁和解锁

 3. 客户标记：加锁和解锁必须是同一个客户端，客户端自己不能把别人加的锁给解了

 4. 不存在死锁：即使有一个客户端在持有锁的期间崩溃而没有主动解锁，也能保证后续其他客户端能加锁

 

三、实现

1、pom.xml依赖

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

 

2、Redis加锁

public class RedisLockUtil {

    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 锁key值
     * @param requestId 请求标识（标记客户端）
     * @param expireTime 超期时间
     * @return boolean true 成功 false 失败
     */
    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;

    }
}

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

     对应的接口如下：jedis.set(String key, String value, String nxxx, String expx, int time)

    参数值详细说明：

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

      第二个为value，我们传的是requestId，分布式锁要满足客户标记，通过给value赋值为requestId，我们就知道这把锁是哪个请求的，当做解锁时的依据;

      第三个为nxxx，这个参数我们填的是NX，即SET IF NOT EXIST，若key已经存在，则不做任何操作，若key不存在，我们进行set操作；

      第四个为expx，这个参数我们传的是PX，即需要给给这个key加一个过期时间，由第五个参数决定;

      第五个为time，与第四个参数相对应，即key的过期时间。

 

3、Redis解锁

public class RedisLockUtil {

    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代码的功能：首先获取锁对应的value值，检查是否与requestId相等，如果相等则删除锁，从而实现解锁。

 

四、写在最后

    网上很多基于Redis实现分布式锁的代码，大家需要多多验证其正确性，本文实现分布式锁的方法已经经历过项目的考验，非常稳定，代码以及逻辑也非常简单。

    另外，redis集群可以用Redisson实现，推荐大家看一篇博客：https://www.cnblogs.com/zhongkaiuu/p/redisson.html