Redis分布式锁
介绍
随着微服务的兴起，比如Spring Cloud、Dubbo的等分布式解决方案地兴起，java的jvm锁某些场景下已经不在适用。特定的场景下，往往依靠分布式锁，常见的分布式锁实现方式有Redis分布式锁以及Zookeeper分布式锁。Redis分布式锁在项目编码中更为常见，比较成熟的框架有Redisson，就实现了分布式锁。虽然项目中我们可以使用比较成熟的Redisson，但是这篇文章侧重于自己实现一个分布式锁。
原理
Redis可以作为分布式锁的关键因素有2个：1.单线程模型；2.基于内存高性能。单线程模型意味着，在任意时刻，只有一个线程可以持有并操作一个key。如果我们实现以个分布式锁，当A线程持有锁时，其他任何一个线程不能再获取同样的锁。因此，加锁的操作必须是一个原子操作。
SETNX命令
SETNX是redis的一个命令，也是一个原子操作命令，当redis中key不存在时，使用SETNX命令给key设置一个value，设值成功时返回1，若key存在，则设值失败，返回0。完美契合了我们加锁的条件，原子操作、加锁成功返回true、加锁失败返回false。命令执行如下：


问题
java jvm锁中提供tryLock(long** **time, TimeUnit unit)方法，当程序试图加锁时，可以设置持有锁的时间，超过持锁时间后，即使没有手动释放锁，锁也可以被释放掉，可以有效防止死锁。redis分布式锁如何实现这个功能呢？我们想到了EXPIRE，当SETNX获取锁成功后，在使用EXPIRE设置锁的过期时间。但是，SETNX、EXPIRE两个命令顺序执行就不是原子操作了。redis提供了lua脚本的方式，可以在脚本中执行redis命令，执行lua脚本是原子操作，因此我们可以在lua脚本中SETNX，再EXPIRE。
代码
# SETNX_EXPIRE.lua
if (redis.call('setnx', KEYS[1], ARGV[1]) == 1)
then
    redis.call('expire', KEYS[1], ARGV[2])
    return true
else
    return false
end

# COMPARE_DELETE.lua
if (redis.call('get', KEYS[1]) == ARGV[1])
then
    return redis.call('del', KEYS[1]) == 1
end
return false

package com.github.rxyor.distributed.lock;

import com.github.rxyor.common.util.FileUtil;
import com.github.rxyor.common.util.RandomUtil;
import com.github.rxyor.redis.util.LettuceConnectionUtil;
import io.lettuce.core.RedisClient;
import io.lettuce.core.ScriptOutputType;
import io.lettuce.core.api.StatefulRedisConnection;
import io.lettuce.core.api.sync.RedisCommands;
import java.util.Objects;
import java.util.Optional;
import lombok.Getter;
import lombok.Setter;
import org.apache.commons.lang3.StringUtils;

/**
 *<p>
 *Redis 分布式锁
 *</p>
 *
 * @author liuyang
 * @date 2019-05-14 Tue 18:51:00
 * @since 1.0.0
 */
public class RedisDistributedLock implements DistributedLock {

    /**
     * taskId本地线程缓存
     */
    private static final ThreadLocal<String> LOCAL_TASK_IDS = new ThreadLocal<>();
    /**
     * redis key本地线程缓存
     */
    private static final ThreadLocal<String> LOCAL_KEYS = new ThreadLocal<>();
    /**
     * 默认锁失效时间
     */
    private static final long DEFAULT_TIMEOUT = 5L;
    /**
     * 加锁LUA脚本
     */
    private static final String LUA_LOCK_SCRIPT;
    /**
     * 释放锁LUA脚本
     */
    private static final String LUA_UNLOCK_SCRIPT;

    static {
        LUA_LOCK_SCRIPT = readLuaLockScript();
        LUA_UNLOCK_SCRIPT = readLuaUnlockScript();
    }

    /**
     * redis 客户端
     */
    private RedisClient redisClient;

    /**
     * redis key前缀
     */
    @Getter
    @Setter
    private String keyPrefix;

    public RedisDistributedLock(RedisClient redisClient) {
        Objects.requireNonNull(redisClient, "redisClient can't be null");
        this.redisClient = redisClient;
    }

    /**
     * 获取锁
     *
     * @param redisKey
     * @param timeout 超时时间(秒)
     * @return 获取锁结果
     */
    @Override
    public boolean getLock(String redisKey, Long timeout) {
        long expire = (timeout == null || timeout <= 0L ? DEFAULT_TIMEOUT : timeout);
        String redisKeyWithPrefix = this.gainRedisKey(redisKey);
        LOCAL_KEYS.set(redisKeyWithPrefix);
        String taskId = this.generateTaskId();
        LOCAL_TASK_IDS.set(taskId);

        return evalRedisScript(LUA_LOCK_SCRIPT, new String[]{redisKeyWithPrefix},
            new String[]{taskId, String.valueOf(expire)});
    }

    /**
     * 释放锁
     *
     * @param redisKey
     * @return 释放结果
     */
    @Override
    public boolean releaseLock(String redisKey) {
        String redisKeyWithPrefix = this.gainRedisKey(redisKey);
        boolean success = evalRedisScript(LUA_UNLOCK_SCRIPT, new String[]{redisKeyWithPrefix},
            LOCAL_TASK_IDS.get());
        if (success) {
            this.clean();
        }
        return success;
    }


    @Override
    public boolean releaseLock() {
        String redisKeyWithPrefix = this.gainRedisKey(null);
        boolean success = evalRedisScript(LUA_UNLOCK_SCRIPT, new String[]{redisKeyWithPrefix},
            LOCAL_TASK_IDS.get());
        if (success) {
            this.clean();
        }
        return success;
    }

    /**
     * 执行lua脚本
     *
     * @param script 脚本
     * @param keys redis key
     * @param values redis参数
     * @return 执行结果
     */
    private boolean evalRedisScript(String script, String[] keys, String... values) {
        StatefulRedisConnection<String, String> conn = null;
        try {
            conn = LettuceConnectionUtil.getConnection(redisClient);
            RedisCommands<String, String> commands = conn.sync();
            return commands.<Boolean>eval(script, ScriptOutputType.BOOLEAN, keys, values);
        } finally {
            LettuceConnectionUtil.releaseConnection(conn);
        }
    }

    /**
     * 拼装或从缓存中取redis key
     *
     * @param key 原始redis key
     * @return String
     */
    private String gainRedisKey(String key) {
        if (StringUtils.isNotEmpty(key)) {
            String redisKeyPrefix = Optional.ofNullable(keyPrefix).orElse("");
            return redisKeyPrefix + key;
        }
        return Optional.ofNullable(LOCAL_KEYS.get()).filter(s -> StringUtils.isNotEmpty(s))
            .orElseThrow(() -> new IllegalArgumentException("redis key can't be empty"));
    }

    /**
     * 生成一个唯一的TaskId(UUID)
     * @return UUID
     */
    private String generateTaskId() {
        return RandomUtil.createUuid();
    }

    /**
     * 清空ThreadLocal缓存
     */
    private void clean() {
        LOCAL_KEYS.remove();
        LOCAL_TASK_IDS.remove();
    }

    /**
     * 读取加锁LUA脚本
     * @return String
     */
    private static String readLuaLockScript() {
        return FileUtil.readTextFromResource(RedisDistributedLock.class, "/lua/SETNX_EXPIRE.lua");
    }

    /**
     * 读取释放锁LUA脚本
     * @return String
     */
    private static String readLuaUnlockScript() {
        return FileUtil.readTextFromResource(RedisDistributedLock.class, "/lua/COMPARE_DELETE.lua");
    }
}

Redis 分布式锁
Redis 分布式锁
1. 是什么？
底层源码：

Redis 分布式锁
1. 是什么？

为了防止分布式系统中的多个进程之间相互干扰，我们需要一种分布式协调技术来对这些进程进行调度。而

这个分布式协调技术的核心就是来实现这个分布式锁。 redisson框架 @RedisLock 注解 加在业务接口上

底层源码：




KEYS[1]代表的是你加锁的那个key，比如说： RLock lock = redisson.getLock(“myLock”);

这里你自己设置了加锁的那个锁key就是“myLock”。
ARGV[1]代表的就是锁key的默认生存时间，默认30秒。   ARGV[2]代表的是加锁的客户端的ID，类似于下面这样：

8743c9c0-0795-4907-87fd-6c719a6b4586:1


第一段if判断语句，就是用“exists myLock”命令判断一下，如果你要加锁的那个锁key不存在的话，你就进行加锁。

如何加锁呢？很简单，用下面的命令： hset myLock

8743c9c0-0795-4907-87fd-6c719a6b4586:1 1 通过这个命令设置一个hash数据结构，这行命令执行后，会出现一个类似下面的数据结构：

上述就代表“8743c9c0-0795-4907-87fd-6c719a6b4586:1”这个客户端对“myLock”这个锁key完成了加锁。

接着会执行“pexpire myLock 30000”命令，设置myLock这个锁key的生存时间是30秒。

好了，到此为止，ok，加锁完成了。

2）锁互斥机制

那么在这个时候，如果客户端2来尝试加锁，执行了同样的一段lua脚本，会咋样呢？ 很简单，第一个if判断会执行“exists

myLock”，发现myLock这个锁key已经存在了。

接着第二个if判断，判断一下，myLock锁key的hash数据结构中，是否包含客户端2的ID，但是明显不是的，因为那里包含的是客户端1的ID。

所以，客户端2会获取到pttl

myLock返回的一个数字，这个数字代表了myLock这个锁key的剩余生存时间。比如还剩15000毫秒的生存时间。

此时客户端2会进入一个while循环，不停的尝试加锁。

（3）watch dog自动延期机制

客户端1加锁的锁key默认生存时间才30秒，如果超过了30秒，客户端1还想一直持有这把锁，怎么办呢？

简单！只要客户端1一旦加锁成功，就会启动一个watch

dog看门狗，他是一个后台线程，会每隔10秒检查一下，如果客户端1还持有锁key，那么就会不断的延长锁key的生存时间。

一、写在前面

 

现在面试，一般都会聊聊分布式系统这块的东西。通常面试官都会从服务框架（Spring Cloud、Dubbo）聊起，一路聊到分布式事务、分布式锁、ZooKeeper等知识。

 

所以咱们这篇文章就来聊聊分布式锁这块知识，具体的来看看Redis分布式锁的实现原理。

 

说实话，如果在公司里落地生产环境用分布式锁的时候，一定是会用开源类库的，比如Redis分布式锁，一般就是用Redisson框架就好了，非常的简便易用。

 

大家如果有兴趣，可以去看看Redisson的官网，看看如何在项目中引入Redisson的依赖，然后基于Redis实现分布式锁的加锁与释放锁。

 

下面给大家看一段简单的使用代码片段，先直观的感受一下：



 

怎么样，上面那段代码，是不是感觉简单的不行！

 

此外，人家还支持redis单实例、redis哨兵、redis cluster、redis master-slave等各种部署架构，都可以给你完美实现。

 

 

二、Redisson实现Redis分布式锁的底层原理

 

好的，接下来就通过一张手绘图，给大家说说Redisson这个开源框架对Redis分布式锁的实现原理。



 

 

（1）加锁机制

 

咱们来看上面那张图，现在某个客户端要加锁。如果该客户端面对的是一个redis cluster集群，他首先会根据hash节点选择一台机器。

 

这里注意，仅仅只是选择一台机器！这点很关键！

 

紧接着，就会发送一段lua脚本到redis上，那段lua脚本如下所示：



 

为啥要用lua脚本呢？

因为一大坨复杂的业务逻辑，可以通过封装在lua脚本中发送给redis，保证这段复杂业务逻辑执行的原子性。

 

那么，这段lua脚本是什么意思呢？

KEYS[1]代表的是你加锁的那个key，比如说：

RLock lock = redisson.getLock("myLock");

这里你自己设置了加锁的那个锁key就是“myLock”。

 

ARGV[1]代表的就是锁key的默认生存时间，默认30秒。

 

ARGV[2]代表的是加锁的客户端的ID，类似于下面这样：

8743c9c0-0795-4907-87fd-6c719a6b4586:1

 

给大家解释一下，第一段if判断语句，就是用“exists myLock”命令判断一下，如果你要加锁的那个锁key不存在的话，你就进行加锁。

 

如何加锁呢？很简单，用下面的命令：

hset myLock 

    8743c9c0-0795-4907-87fd-6c719a6b4586:1 1

 

通过这个命令设置一个hash数据结构，这行命令执行后，会出现一个类似下面的数据结构：



 

上述就代表“8743c9c0-0795-4907-87fd-6c719a6b4586:1”这个客户端对“myLock”这个锁key完成了加锁。

 

接着会执行“pexpire myLock 30000”命令，设置myLock这个锁key的生存时间是30秒。

 

好了，到此为止，ok，加锁完成了。

 

 

（2）锁互斥机制

 

那么在这个时候，如果客户端2来尝试加锁，执行了同样的一段lua脚本，会咋样呢？

 

很简单，第一个if判断会执行“exists myLock”，发现myLock这个锁key已经存在了。

 

接着第二个if判断，判断一下，myLock锁key的hash数据结构中，是否包含客户端2的ID，但是明显不是的，因为那里包含的是客户端1的ID。

 

所以，客户端2会获取到pttl myLock返回的一个数字，这个数字代表了myLock这个锁key的剩余生存时间。比如还剩15000毫秒的生存时间。

 

此时客户端2会进入一个while循环，不停的尝试加锁。

 

 

（3）watch dog自动延期机制

 

客户端1加锁的锁key默认生存时间才30秒，如果超过了30秒，客户端1还想一直持有这把锁，怎么办呢？

 

简单！只要客户端1一旦加锁成功，就会启动一个watch dog看门狗，他是一个后台线程，会每隔10秒检查一下，如果客户端1还持有锁key，那么就会不断的延长锁key的生存时间。

 

 

（4）可重入加锁机制

 

那如果客户端1都已经持有了这把锁了，结果可重入的加锁会怎么样呢？

 

比如下面这种代码：



 

这时我们来分析一下上面那段lua脚本。

 

第一个if判断肯定不成立，“exists myLock”会显示锁key已经存在了。

 

第二个if判断会成立，因为myLock的hash数据结构中包含的那个ID，就是客户端1的那个ID，也就是“8743c9c0-0795-4907-87fd-6c719a6b4586:1”

 

此时就会执行可重入加锁的逻辑，他会用：

incrby myLock 

 8743c9c0-0795-4907-87fd-6c71a6b4586:1 1

通过这个命令，对客户端1的加锁次数，累加1。

 

此时myLock数据结构变为下面这样：



 

大家看到了吧，那个myLock的hash数据结构中的那个客户端ID，就对应着加锁的次数

 

 

（5）释放锁机制

 

如果执行lock.unlock()，就可以释放分布式锁，此时的业务逻辑也是非常简单的。

 

其实说白了，就是每次都对myLock数据结构中的那个加锁次数减1。

 

如果发现加锁次数是0了，说明这个客户端已经不再持有锁了，此时就会用：

“del myLock”命令，从redis里删除这个key。

 

然后呢，另外的客户端2就可以尝试完成加锁了。

 

这就是所谓的分布式锁的开源Redisson框架的实现机制。

 

一般我们在生产系统中，可以用Redisson框架提供的这个类库来基于redis进行分布式锁的加锁与释放锁。

 

 

（6）上述Redis分布式锁的缺点

 

其实上面那种方案最大的问题，就是如果你对某个redis master实例，写入了myLock这种锁key的value，此时会异步复制给对应的master slave实例。

 

但是这个过程中一旦发生redis master宕机，主备切换，redis slave变为了redis master。

 

接着就会导致，客户端2来尝试加锁的时候，在新的redis master上完成了加锁，而客户端1也以为自己成功加了锁。

 

此时就会导致多个客户端对一个分布式锁完成了加锁。

 

这时系统在业务语义上一定会出现问题，导致各种脏数据的产生。

 

所以这个就是redis cluster，或者是redis master-slave架构的主从异步复制导致的redis分布式锁的最大缺陷：在redis master实例宕机的时候，可能导致多个客户端同时完成加锁。

 

文章转载自

https://mp.weixin.qq.com/s?__biz=MzU0OTk3ODQ3Ng==&mid=2247483893&idx=1&sn=32e7051116ab60e41f72e6c6e29876d9&chksm=fba6e9f6ccd160e0c9fa2ce4ea1051891482a95b1483a63d89d71b15b33afcdc1f2bec17c03c&mpshare=1&scene=1&srcid=0416Kx8ryElbpy4xfrPkSSdB&key=1eff032c36dd9b3716bab5844171cca99a4ea696da85eed0e4b2b7ea5c39a665110b82b4c975d2fd65c396e91f4c7b3e8590c2573c6b8925de0df7daa886be53d793e7f06b2c146270f7c0a5963dd26a&ascene=1&uin=MTg2ODMyMTYxNQ%3D%3D&devicetype=Windows+10&version=62060739&lang=zh_CN&pass_ticket=y1D2AijXbuJ8HCPhyIi0qPdkT0TXqKFYo%2FmW07fgvW%2FXxWFJiJjhjTsnInShv0ap

 

手动实现redis分布式锁的正确姿势

package com.shuangyueliao.shuangcloud.redislock;

import redis.clients.jedis.Jedis;

import java.util.Collections;

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;

    }

    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;
    }


}


分析了一下网上的不少手写实现redis分式锁，都有不少相同的错误，下面分析一下错误的姿势

先来看一下redis加锁

/**
     *
     * @param acquireTimeout 获取锁的超时时间
     * @param timeOut 锁的过期时间
     * @return
     */
    public String getRedisLock(Long acquireTimeout, Long timeOut) {
        Jedis conn = null;
        try {
            conn = jedisPool.getResource();
            String identifierValue = UUID.randomUUID().toString();
            int expireLock = (int) (timeOut / 1000);
            Long endTime = System.currentTimeMillis() + acquireTimeout;
            while (System.currentTimeMillis() < endTime) {
                if (conn.setnx(redislockKey, identifierValue) == 1) {
                    conn.expire(redislockKey, expireLock);
                    return identifierValue;
                }
            }
        } catch (Exception e) {
            e.printStackTrace();
            if (conn != null) {
                conn.close();
            }
        }
        return null;
    }

注意问题：

1、要为锁的value设置一个唯一的值，这样就避免了任意线程都能释放锁，因为如果业务时间小于锁的过期时间，锁被释放而业务没有执行完，另一线程获得锁，但会因第一个线程最后的释放锁而受到影响

2、conn.setnx和con.expire应该用lua脚本，保证其原子操作，上述代码就明显错误了，如果conn.setnx执行完后，redis服务器宕机了那么会导致锁永远无法释放

 

接着看一下释放锁

/**
     * 
     * @param identifierValue 锁的value
     */
    public void unRedisLock(String identifierValue) {
        Jedis conn = null;
        conn = jedisPool.getResource();
        try {
            if (conn.get(redislockKey).equals(identifierValue)) {
                System.out.println("释放锁" + Thread.currentThread().getName() + ",identifierValue: " + identifierValue);
                conn.del(redislockKey);
            }
        } catch (Exception e) {
            e.printStackTrace();
        } finally {
            if (conn != null) {
                conn.close();
            }
        }
    }

此处同样要用lua脚本来保证conn.get和conn.del的原子性操作，如果执行到conn.get后刚好锁过期了，而另一线程获得锁，但conn.del会把锁删掉，虽然判断了锁的value后再删除仍会出现一个线程删除了另一线程获得的锁