Java三种方式实现redis分布式锁

Posted 2023-03-30 了迹奇有没

tags:

篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了Java三种方式实现redis分布式锁相关的知识，希望对你有一定的参考价值。

一、引入原因

在分布式服务中，常常有如定时任务、库存更新这样的场景。

在定时任务中，如果不使用quartz这样的分布式定时工具，只是简单的使用定时器来进行定时任务，在服务分布式部署中，就有可能存在定时任务并发执行，造成一些问题。

在库存更新这样的场景中，我们服务对数据库同一条记录进行更新，并记录。对记录更新可以使用分布式锁，但对操作进行记录时，可能造成读未提交，造成记录错乱的情况。

在以上的场景中，我们引入了分布式事务锁。

二、分布式锁实现过程中的问题

问题一：异常导致锁没有释放

这个问题形成的原因就是程序在获取到锁之后，执行业务的过程中出现了异常，导致锁没有被释放。通俗的话说：上厕所的人死在了厕所里面，导致“坑位”资源死锁无法被释放。（当然这种情况出现的概率很小，但概率小不等于不存在。）

解决方案：为redis的key设置过期时间，程序异常导致的死锁，在到达过期时间之后锁自动释放。也就说厕所门是电子锁，锁定的最长时间是有限制的，超过时长锁就会自动打开释放"坑位"资源。

问题二：获取锁与设置过期时间操作不是原子性的

上文中我们虽然获取到锁，也设置了过期时间，看似完美。但是在高并发的场景下仍然会出问题，因为“获取锁”与“设置过期时间”是两个redis操作，两个redis操作不是原子性的。
可能出现这种情况：就在获取锁之后，设置过期时间之前程序宕机了。锁被获取到了但没有设置过期时间，最后又成为死锁。

解决方案：获取锁的同时设置过期时间

问题三：锁过期之后被别的线程重新获取与释放

这个问题出现的场景是：假如某个应用集群化部署存在多个进程实例，实例A、实例B。实例A获取到锁，但是执行过程超时了（数据库层面或其他层面导致操作执行超时）。超时之后锁被自动释放了，实例B获取到锁，并执行业务程序，执行完成之后把锁删除了。

解决方案：在释放锁之前判断一下，这把锁是不是自己的那一把，如果是别人的锁你就不要动。怎么判断这把锁是不是自己的？加锁时为value赋随机值，加锁的随机值等于解锁时的获取到的值，才能证明这把锁是你的。

问题四：锁的释放不是原子性的

大家仔细看代码，锁的释放时三个操作，这三个操作不是原子性的。也就是说在高并发的场景下，你刚get到的redis key有可能也被别的线程get了，你刚要删除别的线程可能已经把这个key删除了。

解决方案：我们可以使用redis lua脚本（lua脚本是在一个事务里面执行的，可以保证原子性）。在Java代码中可以以字符串的形式存在。如下：

String script = 
	"if redis.call('get', KEYS[1]) == ARGV[1] 
		then return redis.call('del', KEYS[1]) 
	else 
		return 0 
	end";

问题五：其他的问题？

上面我们分析了很多使用redis实现分布式锁可能出现的问题及解决方案，其实在实际的开发应用中还会有更多的问题。比如：

目前我们的程序获取不到锁，就无限的重试，是不是应该在重试一定的次数之后就抛出异常？在有限的时间内通过异常给用户一个友好的响应。比如：程序太忙，请您稍后再试！
程序A没有执行完成，锁定的key就过期了。虽然过期之后会自动释放锁，但是我的程序A的确没有执行完成啊，也没有异常抛出，就是执行的时间比较长，这个时候是不是应该对锁定的key进行续期？

这些问题在高并发场景下会出现，实际上分布式锁的细节实践有很多的现成的解决方案，不用我们去自己实现。比较完整优秀的分布式锁实现包括：

RedisLockRegistry是spring-integration-redis中提供redis分布式锁实现类
基于Redisson实现分布式锁原理（Redission是一个独立的redis客户端，是与Jedis、Lettuce同级别的存在）

三、具体实现

1. RedisTemplate

RedisTemplate<String, String> redisTemplate;

public void updateUserWithRedisLock(SysUser sysUser) throws InterruptedException 
  // 占分布式锁，去redis占坑
  // 1. 分布式锁占坑
Boolean lock = redisTemplate.opsForValue().setIfAbsent("SysUserLock" + sysUser.getId(), "value", 30, TimeUnit.SECONDS);
  if(lock) 
    //加锁成功... 
		// todo business
    
    
    redisTemplate.delete("SysUserLock" + sysUser.getId());   //删除key，释放锁
   else 
    Thread.sleep(100);   // 加锁失败，重试
    updateUserWithRedisLock(sysUser);

setIfAbsent方法的作用是在某一个lock key不存在的时候，才能返回true；如果这个key已经存在了就返回false，返回false就是获取锁失败。setIfAbsent函数功能类似于redis命令行setnx。

2. RedisLockRegistry

集成spring-integration-redis

<dependency>
     <groupId>org.springframework.boot</groupId>
     <artifactId>spring-boot-starter-integration</artifactId>
</dependency>
<dependency>
     <groupId>org.springframework.integration</groupId>
     <artifactId>spring-integration-redis</artifactId>
</dependency>

注册RedisLockRegistry

@Configuration
public class RedisLockConfig 

     @Bean
     public RedisLockRegistry redisLockRegistry(RedisConnectionFactory redisConnectionFactory) 
         //第一个参数redisConnectionFactory
         //第二个参数registryKey，分布式锁前缀，设置为项目名称会好些
         //该构造方法对应的分布式锁，默认有效期是60秒.可以自定义
         return new RedisLockRegistry(redisConnectionFactory, "boot-launch");
         //return new RedisLockRegistry(redisConnectionFactory, "boot-launch",60);

使用RedisLockRegistry

代码中实现

@Resource
private RedisLockRegistry redisLockRegistry;

public void updateUser(String userId) 
  String lockKey = "config" + userId;
  Lock lock = redisLockRegistry.obtain(lockKey);  //获取锁资源
  try 
    lock.lock();   //加锁
        
    //这里写需要处理业务的业务代码
   finally 
    lock.unlock();   //释放锁

注解实现

@RedisLock("lock-key")
public void save()

3. 使用redisson实现分布式锁

集成redisson

<dependency>
  <groupId>org.redisson</groupId>
  <artifactId>redisson-spring-boot-starter</artifactId>
  <version>3.15.0</version>
  <exclusions>
    <exclusion>
      <groupId>org.redisson</groupId>
      <!-- 默认是 Spring Data Redis v.2.3.x ,所以排除掉-->
      <artifactId>redisson-spring-data-23</artifactId>
    </exclusion>
  </exclusions>
</dependency>

配置

在配置文件中加

spring:
  redis:
    redisson:
      file: classpath:redisson.yaml

然后新建一个redisson.yaml文件，也放在resouce目录下

singleServerConfig:
  idleConnectionTimeout: 10000
  connectTimeout: 10000
  timeout: 3000
  retryAttempts: 3
  retryInterval: 1500
  password: 123456
  subscriptionsPerConnection: 5
  clientName: null
  address: "redis://192.168.161.3:6379"
  subscriptionConnectionMinimumIdleSize: 1
  subscriptionConnectionPoolSize: 50
  connectionMinimumIdleSize: 32
  connectionPoolSize: 64
  database: 0
  dnsMonitoringInterval: 5000
threads: 0
nettyThreads: 0
codec: !<org.redisson.codec.JsonJacksonCodec> 
transportMode: "NIO"

实现

@Resource
private RedissonClient redissonClient;

public void updateUser(String userId) 
  String lockKey = "config" + userId;
  RLock lock = redissonClient.getLock(lockKey);  //获取锁资源
  try 
    lock.lock(10, TimeUnit.SECONDS);   //加锁,可以指定锁定时间

    //这里写需要处理业务的业务代码
   finally 
    lock.unlock();   //释放锁

相对于RedisLockRegistry另一个小优点是：我们可以为每一个锁指定锁定的超时时间。RedisLockRegistry目前只能针对所有的锁设定统一的超时时间
如果业务执行超时之后，再去unlock会抛出java.lang.IllegalMonitorStateException

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

前言

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

可靠性

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

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

代码实现

组件依赖

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

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

加锁代码

正确姿势

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

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()方法一共有五个形参：

第一个为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()组合实现加锁，代码如下：

public static void wrongGetLock1(Jedis jedis, String lockKey, String requestId, int expireTime) 

    Long result = jedis.setnx(lockKey, requestId);
    if (result == 1) 
        // 若在这里程序突然崩溃，则无法设置过期时间，将发生死锁
        jedis.expire(lockKey, expireTime);
    

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

错误示例2

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

public static boolean wrongGetLock2(Jedis jedis, String lockKey, int expireTime) 

    long expires = System.currentTimeMillis() + expireTime;
    String expiresStr = String.valueOf(expires);

    // 如果当前锁不存在，返回加锁成功
    if (jedis.setnx(lockKey, expiresStr) == 1) 
        return true;
    

    // 如果锁存在，获取锁的过期时间
    String currentValueStr = jedis.get(lockKey);
    if (currentValueStr != null && Long.parseLong(currentValueStr) < System.currentTimeMillis()) 
        // 锁已过期，获取上一个锁的过期时间，并设置现在锁的过期时间
        String oldValueStr = jedis.getSet(lockKey, expiresStr);
        if (oldValueStr != null && oldValueStr.equals(currentValueStr)) 
            // 考虑多线程并发的情况，只有一个线程的设置值和当前值相同，它才有权利加锁
            return true;
        
    
        
    // 其他情况，一律返回加锁失败
    return false;

那么这段代码问题在哪里？1. 由于是客户端自己生成过期时间，所以需要强制要求分布式下每个客户端的时间必须同步。 2. 当锁过期的时候，如果多个客户端同时执行jedis.getSet()方法，那么虽然最终只有一个客户端可以加锁，但是这个客户端的锁的过期时间可能被其他客户端覆盖。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语言来实现呢？因为要确保上述操作是原子性的。关于非原子性会带来什么问题，可以阅读【解锁代码-错误示例2】。那么为什么执行eval()方法可以确保原子性，源于Redis的特性，下面是官网对eval命令的部分解释：

技术图片

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

错误示例1

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

public static void wrongReleaseLock1(Jedis jedis, String lockKey) 
    jedis.del(lockKey);

错误示例2

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

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

以上是关于Java三种方式实现redis分布式锁的主要内容，如果未能解决你的问题，请参考以下文章

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

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

80% 人不知道的 Redis 分布式锁的正确实现方式（Java 版）

分布式锁三种实现方式介绍：基于缓存（Redis等）实现分布式锁

Java三种方式实现redis分布式锁

一、引入原因

二、分布式锁实现过程中的问题

问题一：异常导致锁没有释放

解决方案： 为redis的key设置过期时间，程序异常导致的死锁，在到达过期时间之后锁自动释放。也就说厕所门是电子锁，锁定的最长时间是有限制的，超过时长锁就会自动打开释放"坑位"资源。

问题二：获取锁与设置过期时间操作不是原子性的

解决方案： 获取锁的同时设置过期时间

问题三：锁过期之后被别的线程重新获取与释放

解决方案： 在释放锁之前判断一下，这把锁是不是自己的那一把，如果是别人的锁你就不要动。怎么判断这把锁是不是自己的？加锁时为value赋随机值，加锁的随机值等于解锁时的获取到的值，才能证明这把锁是你的。

问题四：锁的释放不是原子性的

解决方案： 我们可以使用redis lua脚本（lua脚本是在一个事务里面执行的，可以保证原子性）。在Java代码中可以以字符串的形式存在。如下：

问题五：其他的问题？

三、具体实现

1. RedisTemplate

2. RedisLockRegistry

集成spring-integration-redis

注册RedisLockRegistry

使用RedisLockRegistry

3. 使用redisson实现分布式锁

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

前言

可靠性

代码实现

组件依赖

加锁代码

正确姿势

错误示例1

错误示例2

解锁代码

正确姿势

错误示例1

错误示例2

解决方案：为redis的key设置过期时间，程序异常导致的死锁，在到达过期时间之后锁自动释放。也就说厕所门是电子锁，锁定的最长时间是有限制的，超过时长锁就会自动打开释放"坑位"资源。

解决方案：获取锁的同时设置过期时间

解决方案：在释放锁之前判断一下，这把锁是不是自己的那一把，如果是别人的锁你就不要动。怎么判断这把锁是不是自己的？加锁时为value赋随机值，加锁的随机值等于解锁时的获取到的值，才能证明这把锁是你的。

解决方案：我们可以使用redis lua脚本（lua脚本是在一个事务里面执行的，可以保证原子性）。在Java代码中可以以字符串的形式存在。如下：