Redis分布式锁的正确实现方式（Java版）

　1.常见项目都是springboot基于微项目搭建。本次环境基于，springboot+springcloud，搭建微服务项目，其中的分布式锁问题。

　　

一。什么事分布式锁：

　　在提到分布式锁的时候，我们应该能想到，线程锁和进程锁。

线程锁：主要用来给方法、代码块加锁。当某个方法或代码使用锁，在同一时刻仅有一个线程执行该方法或该代码段。线程锁只在同一JVM中有效果，因为线程锁的实现在根本上是依靠线程之间共享内存实现的，比如synchronized是共享对象头，显示锁Lock是共享某个变量（state）。

进程锁：为了控制同一操作系统中多个进程访问某个共享资源，因为进程具有独立性，各个进程无法访问其他进程的资源，因此无法通过synchronized等线程锁实现进程锁。

分布式锁：当多个进程不在同一个系统中（jvm），用分布式锁控制多个进程对资源的访问。

二。分布式锁的使用场景：

　线程间并发问题和进程间并发问题都可以通过分布式锁解决的。但是不建议这样做，为什么呢？

　　因为采用分布式锁解决这些小问题是非常消耗资源的，那么分布式锁应该在什么环境中使用才正确？

分布式锁应该用来解决分布式情况下的多进程并发的问题才最合适。

有这样一个情境，线程A和线程B都共享某个变量X。

如果是单机情况下（单JVM），线程之间共享内存，只要使用线程锁就可以解决并发问题。

如果是分布式情况下（多JVM），线程A和线程B很可能不是在同一JVM中，这样线程锁就无法起到作用了，这时候就要用到分布式锁来解决。

 

三。分布式锁的实现：

分布式锁实现的关键是分布式的应用服务器外，搭建一个存储服务器，存储锁的信息。这时候我们很容易就想到了Redis。首先我们要搭建一个refis服务器，用redis服务器来存储锁信息

 

实现要点：

　　　　1.锁信息会过期超时的，不能让一个线程长期占有一个锁而导致死锁

　　　　2.同一时刻只有一个线程可以获取到锁。

几个要用到的redis命令：

setnx(key, value)：“set if not exits”，若该key-value不存在，则成功加入缓存并且返回1，否则返回0。

get(key)：获得key对应的value值，若不存在则返回nil。

getset(key, value)：先获取key对应的value值，若不存在则返回nil，然后将旧的value更新为新的value。

expire(key, seconds)：设置key-value的有效期为seconds秒。

 

前言

分布式锁一般有三种实现方式：1. 数据库乐观锁；2. 基于Redis的分布式锁；3. 基于ZooKeeper的分布式锁。本篇博客将介绍第二种方式，基于Redis实现分布式锁。虽然网上已经有各种介绍Redis分布式锁实现的博客，然而他们的实现却有着各种各样的问题，为了避免误人子弟，本篇博客将详细介绍如何正确地实现Redis分布式锁。

 

可靠性

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

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

代码实现

组件依赖

首先我们要通过Maven引入Jedis开源组件，在pom.xml文件加入下面的代码：

  1.  
    <dependency>
  2.  
    <groupId>redis.clients</groupId>
  3.  
    <artifactId>jedis</artifactId>
  4.  
    <version>2.9.0</version>
  5.  
    </dependency>

加锁代码

正确姿势

Talk is cheap, show me the code。先展示代码，再带大家慢慢解释为什么这样实现：

  1.  
    public class RedisTool {
  2.  
     
  3.  
    private static final String LOCK_SUCCESS = "OK";
  4.  
    private static final String SET_IF_NOT_EXIST = "NX";
  5.  
    private static final String SET_WITH_EXPIRE_TIME = "PX";
  6.  
     
  7.  
    /**
  8.  
    * 尝试获取分布式锁
  9.  
    * @param jedis Redis客户端
  10.  
    * @param lockKey 锁
  11.  
    * @param requestId 请求标识
  12.  
    * @param expireTime 超期时间
  13.  
    * @return 是否获取成功
  14.  
    */
  15.  
    public static boolean tryGetDistributedLock(Jedis jedis, String lockKey, String requestId, int expireTime) {
  16.  
     
  17.  
    String result = jedis.set(lockKey, requestId, SET_IF_NOT_EXIST, SET_WITH_EXPIRE_TIME, expireTime);
  18.  
     
  19.  
    if (LOCK_SUCCESS.equals(result)) {
  20.  
    return true;
  21.  
    }
  22.  
    return false;
  23.  
     
  24.  
    }
  25.  
     
  26.  
    }

可以看到，我们加锁就一行代码：jedis.set(String key, String value, String nxxx, String expx, int time)，这个set()方法一共有五个形参：

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

  • 第二个为value，我们传的是requestId，很多童鞋可能不明白，有key作为锁不就够了吗，为什么还要用到value？原因就是我们在上面讲到可靠性时，分布式锁要满足第四个条件解铃还须系铃人，通过给value赋值为requestId，我们就知道这把锁是哪个请求加的了，在解锁的时候就可以有依据。requestId可以使用UUID.randomUUID().toString()方法生成。

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

  • 第四个为expx，这个参数我们传的是PX，意思是我们要给这个key加一个过期的设置，具体时间由第五个参数决定。

  • 第五个为time，与第四个参数相呼应，代表key的过期时间。

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

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

错误示例1

比较常见的错误示例就是使用jedis.setnx()和jedis.expire()组合实现加锁，代码如下：

  1.  
    public static void wrongGetLock1(Jedis jedis, String lockKey, String requestId, int expireTime) {
  2.  
     
  3.  
    Long result = jedis.setnx(lockKey, requestId);
  4.  
    if (result == 1) {
  5.  
    // 若在这里程序突然崩溃，则无法设置过期时间，将发生死锁
  6.  
    jedis.expire(lockKey, expireTime);
  7.  
    }
  8.  
     
  9.  
    }

setnx()方法作用就是SET IF NOT EXIST，expire()方法就是给锁加一个过期时间。乍一看好像和前面的set()方法结果一样，然而由于这是两条Redis命令，不具有原子性，如果程序在执行完setnx()之后突然崩溃，导致锁没有设置过期时间。那么将会发生死锁。网上之所以有人这样实现，是因为低版本的jedis并不支持多参数的set()方法。

错误示例2

这一种错误示例就比较难以发现问题，而且实现也比较复杂。实现思路：使用jedis.setnx()命令实现加锁，其中key是锁，value是锁的过期时间。执行过程：1. 通过setnx()方法尝试加锁，如果当前锁不存在，返回加锁成功。2. 如果锁已经存在则获取锁的过期时间，和当前时间比较，如果锁已经过期，则设置新的过期时间，返回加锁成功。代码如下：

  1.  
    public static boolean wrongGetLock2(Jedis jedis, String lockKey, int expireTime) {
  2.  
     
  3.  
    long expires = System.currentTimeMillis() + expireTime;
  4.  
    String expiresStr = String.valueOf(expires);
  5.  
     
  6.  
    // 如果当前锁不存在，返回加锁成功
  7.  
    if (jedis.setnx(lockKey, expiresStr) == 1) {
  8.  
    return true;
  9.  
    }
  10.  
     
  11.  
    // 如果锁存在，获取锁的过期时间
  12.  
    String currentValueStr = jedis.get(lockKey);
  13.  
    if (currentValueStr != null && Long.parseLong(currentValueStr) < System.currentTimeMillis()) {
  14.  
    // 锁已过期，获取上一个锁的过期时间，并设置现在锁的过期时间
  15.  
    String oldValueStr = jedis.getSet(lockKey, expiresStr);
  16.  
    if (oldValueStr != null && oldValueStr.equals(currentValueStr)) {
  17.  
    // 考虑多线程并发的情况，只有一个线程的设置值和当前值相同，它才有权利加锁
  18.  
    return true;
  19.  
    }
  20.  
    }
  21.  
     
  22.  
    // 其他情况，一律返回加锁失败
  23.  
    return false;
  24.  
     
  25.  
    }

那么这段代码问题在哪里？1. 由于是客户端自己生成过期时间，所以需要强制要求分布式下每个客户端的时间必须同步。 2. 当锁过期的时候，如果多个客户端同时执行jedis.getSet()方法，那么虽然最终只有一个客户端可以加锁，但是这个客户端的锁的过期时间可能被其他客户端覆盖。3. 锁不具备拥有者标识，即任何客户端都可以解锁。

解锁代码

正确姿势

还是先展示代码，再带大家慢慢解释为什么这样实现：

  1.  
    public class RedisTool {
  2.  
     
  3.  
    private static final Long RELEASE_SUCCESS = 1L;
  4.  
     
  5.  
    /**
  6.  
    * 释放分布式锁
  7.  
    * @param jedis Redis客户端
  8.  
    * @param lockKey 锁
  9.  
    * @param requestId 请求标识
  10.  
    * @return 是否释放成功
  11.  
    */
  12.  
    public static boolean releaseDistributedLock(Jedis jedis, String lockKey, String requestId) {
  13.  
     
  14.  
    String script = "if redis.call('get', KEYS[1]) == ARGV[1] then return redis.call('del', KEYS[1]) else return 0 end";
  15.  
    Object result = jedis.eval(script, Collections.singletonList(lockKey), Collections.singletonList(requestId));
  16.  
     
  17.  
    if (RELEASE_SUCCESS.equals(result)) {
  18.  
    return true;
  19.  
    }
  20.  
    return false;
  21.  
     
  22.  
    }
  23.  
     
  24.  
    }

可以看到，我们解锁只需要两行代码就搞定了！第一行代码，我们写了一个简单的Lua脚本代码，上一次见到这个编程语言还是在《黑客与画家》里，没想到这次居然用上了。第二行代码，我们将Lua代码传到jedis.eval()方法里，并使参数KEYS[1]赋值为lockKey，ARGV[1]赋值为requestId。eval()方法是将Lua代码交给Redis服务端执行。

那么这段Lua代码的功能是什么呢？其实很简单，首先获取锁对应的value值，检查是否与requestId相等，如果相等则删除锁（解锁）。那么为什么要使用Lua语言来实现呢？因为要确保上述操作是原子性的。关于非原子性会带来什么问题，可以阅读【解锁代码-错误示例2】 。那么为什么执行eval()方法可以确保原子性，源于Redis的特性，下面是官网对eval命令的部分解释：

简单来说，就是在eval命令执行Lua代码的时候，Lua代码将被当成一个命令去执行，并且直到eval命令执行完成，Redis才会执行其他命令。

错误示例1

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

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

 

错误示例2

这种解锁代码乍一看也是没问题，甚至我之前也差点这样实现，与正确姿势差不多，唯一区别的是分成两条命令去执行，代码如下：

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

如代码注释，问题在于如果调用jedis.del()方法的时候，这把锁已经不属于当前客户端的时候会解除他人加的锁。那么是否真的有这种场景？答案是肯定的，比如客户端A加锁，一段时间之后客户端A解锁，在执行jedis.del()之前，锁突然过期了，此时客户端B尝试加锁成功，然后客户端A再执行del()方法，则将客户端B的锁给解除了。

总结

本文主要介绍了如何使用Java代码正确实现Redis分布式锁，对于加锁和解锁也分别给出了两个比较经典的错误示例。其实想要通过Redis实现分布式锁并不难，只要保证能满足可靠性里的四个条件。互联网虽然给我们带来了方便，只要有问题就可以google，然而网上的答案一定是对的吗？其实不然，所以我们更应该时刻保持着质疑精神，多想多验证。

如果你的项目中Redis是多机部署的，那么可以尝试使用Redisson实现分布式锁，

参考文献：https://blog.csdn.net/yb223731/article/details/90349502

 

四。基于缓存redis，使用开源 redisson 实现分布式锁

新建SpringBoot项目，引入依赖：redisson依赖 netty 、jackson-core、jackson-databind

　　

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-data-redis</artifactId>
</dependency>
<!--start redis distributed lock-->
<!-- https://mvnrepository.com/artifact/org.redisson/redisson -->
<dependency>
    <groupId>org.redisson</groupId>
    <artifactId>redisson</artifactId>
    <version>3.6.5</version>
</dependency>
<dependency>
    <groupId>io.netty</groupId>
    <artifactId>netty-all</artifactId>
    <version>4.1.25.Final</version>
</dependency>
<dependency>
    <groupId>com.fasterxml.jackson.core</groupId>
    <artifactId>jackson-core</artifactId>
    <version>2.9.0</version>
</dependency>
<dependency>
    <groupId>com.fasterxml.jackson.core</groupId>
    <artifactId>jackson-databind</artifactId>
    <version>2.9.0</version>
</dependency>
<!--end redis distributed lock-->

 

在启动类中注入 redisson 的bean，可以在配置文件中添加redis的连接地址、参数，然后在代码中引入配置文件

@SpringBootApplication
public class RedissonApplication {
    public static void main(String[] args) {
        SpringApplication.run(RedissonApplication.class, args);
    }
    @Bean
    Redisson redissonSentinel() {
        //支持单机，主从，哨兵，集群等模式
        //此为哨兵模式
        Config config = new Config();
        config.useSentinelServers()
                .setMasterName("mymaster")
                .addSentinelAddress("redis://192.168.1.1:26379")
                .setPassword("123456");
        return (Redisson)Redisson.create(config);
    }
}

 

到此，就完成了，只要测试了，是不是很简单。模拟秒杀场景，有一个商品aaa，库存100个，2个并发请求110次，每请求一次库存减1，看最后商品数有没有变为负数，

在redis中，设置一个库存数量为100

@Test
public void test() throws Exception {
    //设置一个key，aaa商品的库存数量为100
    stringRedisTemplate.opsForValue().set("aaa","100");
    Assert.assertEquals("100", stringRedisTemplate.opsForValue().get("aaa"));
}

 

把项目复制一份，2个项目，分别使用下面的测试方法，同时启动，因库存为100，每次请求库存减1，启动2个测试方法各循环55次，总计110次请求，看库存打印结果会不会变负数

String lockKey = "testRedisson";//分布式锁的key
@Test
public void testDistributed(){
    //执行的业务代码
    for(int i=0; i < 55; i++){
        RLock lock = redisson.getLock(lockKey);
        lock.lock(60, TimeUnit.SECONDS); //设置60秒自动释放锁  （默认是30秒自动过期）
        int stock = Integer.parseInt(stringRedisTemplate.opsForValue().get("aaa").toString());
        if(stock > 0){
            stringRedisTemplate.opsForValue().set("aaa",(stock-1)+"");
            System.out.println("test2_:lockkey:"+lockKey+",stock:"+(stock-1)+"");
        }
        lock.unlock(); //释放锁
    }
}

测试结果：正确，redis的值没有变负数，说明被锁住了

再看看第一个项目打印的数据，可以看到第70，39被第二个项目的锁获得了

测试成功

分布式锁改进篇，使用 jmeter 测试工具更精准测试并发

 

参考文献：https://blog.csdn.net/zhuyu19911016520/article/details/80418161

 

posted @ 2019-12-09 15:04  技术专家  阅读(1662)  评论(0)    收藏  举报