影者东升 发表于 2021-7-8 16:50:22

分布式锁之redis分布式锁的实现



一.前言
  目前分布式锁一般有三种实现方式:

[*]数据库乐观锁;
[*]基于Redis的分布式锁;
[*]基于ZooKeeper的分布式锁。
  本篇博客将介绍第二种方式,基于Redis实现分布式锁。虽然网上已经有各种介绍Redis分布式锁实现的博客,然而他们的实现却有着各种各样的问题,为了避免误人子弟,本篇博客将详细介绍如何正确地实现Redis分布式锁。

二.可靠性
  首先,为了确保分布式锁可用,我们至少要确保锁的实现同时满足以下四个条件:

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

三.代码实现
3.1组件依赖
  首先我们要通过Maven引入Jedis开源组件,在pom.xml文件加入下面的代码:
<dependency>
    <groupId>redis.clients</groupId>
    <artifactId>jedis</artifactId>
    <version>2.9.0</version>
</dependency>
3.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()方法一共有五个形参:

[*]  第一个为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()方法就只会导致两种结果:

[*]当前没有锁(key不存在),那么就进行加锁操作,并对锁设置个有效期,同时value表示加锁的客户端。
[*]已有锁存在,不做任何操作。
  心细的童鞋就会发现了,我们的加锁代码满足我们可靠性里描述的三个条件:

[*]首先,set()加入了NX参数,可以保证如果已有key存在,则函数不会调用成功,也就是只有一个客户端能持有锁,满足互斥性。
[*]其次,由于我们对锁设置了过期时间,即使锁的持有者后续发生崩溃而没有解锁,锁也会因为到了过期时间而自动解锁(即key被删除),不会发生死锁。
[*]最后,因为我们将value赋值为requestId,代表加锁的客户端请求标识,那么在客户端在解锁的时候就可以进行校验是否是同一个客户端。
[*]由于我们只考虑Redis单机部署的场景,所以容错性我们暂不考虑。
3.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) == ARGV then return redis.call('del', KEYS) 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赋值为lockKey,ARGV赋值为requestId。eval()方法是将Lua代码交给Redis服务端执行。
  那么这段Lua代码的功能是什么呢?其实很简单,首先获取锁对应的value值,检查是否与requestId相等,如果相等则删除锁(解锁)。那么为什么要使用Lua语言来实现呢?因为要确保上述操作是原子性的。
  简单来说,就是在eval命令执行Lua代码的时候,Lua代码将被当成一个命令去执行,并且直到eval命令执行完成,Redis才会执行其他命令。

四.总结
  本文主要介绍了如何使用Java代码正确实现Redis分布式锁,其实想要通过Redis实现分布式锁并不难,只要保证能满足可靠性里的四个条件。
如果你的项目中Redis是多机部署的,那么可以尝试使用Redisson实现分布式锁,这是Redis官方提供的Java组件。
  参考文献
1.Redis分布式锁的正确实现方式
2.Redis分布式锁的正确实现方式(Java版)
3.redisson

  
文档来源:51CTO技术博客https://blog.51cto.com/u_15296180/3012832
页: [1]
查看完整版本: 分布式锁之redis分布式锁的实现