Let’s talk about how to use Redis to implement distributed locks

This article brings you relevant knowledge about Redis, which mainly introduces issues related to distributed locks. What we usually call threads to call locks and release locks is actually Above, when a thread calls a locking operation, it actually checks whether the value of the lock variable is 0. I hope it will be helpful to everyone.

Recommended learning: Redis learning tutorial

The connection and difference between locks on a single machine and distributed locks

Let’s first look at the lock on a single machine.

For multi-threaded programs running on a single machine, the lock itself can be represented by a variable.

• When the variable value is 0, it means that no thread has acquired the lock;
• When the variable value is 1, it means that a thread has already acquired the lock.

We usually say that a thread calls a locking and releasing operation. In fact, when a thread calls a locking operation, it actually checks whether the lock variable value is 0. If it is 0, set the lock variable value to 1, indicating that the lock has been acquired. If it is not 0, an error message will be returned, indicating that the lock failed and another thread has acquired the lock. When a thread calls the lock release operation, it actually sets the value of the lock variable to 0 so that other threads can acquire the lock.
I use a piece of code to show the operations of locking and releasing locks, where lock is the lock variable.

acquire_lock(){
  if lock == 0
     lock = 1
     return 1
  else
     return 0
} 
release_lock(){
  lock = 0
  return 1
}

Similar to the lock on a single machine, the distributed lock can also be implemented using a variable. The operation logic of locking and releasing locks on the client is also consistent with the operation logic of locking and releasing locks on a single machine: It is also necessary to judge the value of the lock variable when locking, and judge whether the lock can be successful based on the value of the lock variable. ; When releasing the lock, the lock variable value needs to be set to 0, indicating that the client no longer holds the lock.
However, unlike threads operating locks on a single machine, in a distributed scenario, lock variables need to be maintained by a shared storage system. Only in this way can multiple clients Lock variables can be accessed by accessing the shared storage system. Correspondingly, The operations of locking and releasing locks become reading, judging and setting the lock variable value in the shared storage system.

In this way, we can derive two requirements for implementing distributed locks.

Requirement 1: The process of locking and releasing the distributed lock involves multiple operations. Therefore, when implementing distributed locks, we need to ensure the atomicity of these lock operations;
Requirement 2: The shared storage system saves the lock variables. If the shared storage system fails or goes down, the client will not be able to proceed. The lock is operated. When implementing distributed locks, we need to consider ensuring the reliability of the shared storage system and thus the reliability of the lock.

Okay, now that we know the specific requirements, let’s learn how Redis implements distributed locks.

In fact, we can implement it based on a single Redis node or use multiple Redis nodes. In these two cases, the reliability of the lock is not the same. Let’s first look at the implementation method based on a single Redis node.

Implementing distributed locks based on a single Redis node
As a shared storage system in the implementation of distributed locks, Redis can use key-value pairs to save lock variables, and then receive and process them Operation requests for locking and releasing locks sent by different clients. So, how are the key and value of the key-value pair determined?
We need to give the lock variable a variable name and use this variable name as the key of the key-value pair, and the value of the lock variable is the value of the key-value pair. In this way, Redis can save the lock variable. Client The end can also implement lock operations through Redis command operations.
To help you understand, I drew a picture that shows Redis using key-value pairs to save lock variables, and the operation process of two clients requesting locks at the same time.

As you can see, Redis can use a key-value pair lock_key:0 to save the lock variable, where the key is lock_key, which is also the name of the lock variable. The initial value of the lock variable is 0 .

Let’s analyze the locking operation again.

In the figure, clients A and C request locks at the same time. Because Redis uses a single thread to process requests, even if clients A and C send lock requests to Redis at the same time, Redis will process their requests serially.

We assume that Redis first processes the request of client A, reads the value of lock_key, and finds that lock_key is 0. Therefore, Redis sets the value of lock_key to 1, indicating that it has been locked. Immediately afterwards, Redis processes the request of client C. At this time, Redis will find that the value of lock_key is already 1, so it returns a lock failure message.

What I just talked about is the locking operation, so how to release the lock? In fact, releasing the lock means directly setting the lock variable value to 0.

我还是借助一张图片来解释一下。这张图片展示了客户端 A 请求释放锁的过程。当客户端 A 持有锁时，锁变量 lock_key 的值为 1。客户端 A 执行释放锁操作后，Redis 将 lock_key 的值置为 0，表明已经没有客户端持有锁了。

因为加锁包含了三个操作（读取锁变量、判断锁变量值以及把锁变量值设置为 1），而这三个操作在执行时需要保证原子性。那怎么保证原子性呢？

要想保证操作的原子性，有两种通用的方法，分别是使用 Redis 的单命令操作和使用 Lua 脚本。那么，在分布式加锁场景下，该怎么应用这两个方法呢？

我们先来看下，Redis 可以用哪些单命令操作实现加锁操作。

首先是 SETNX 命令，它用于设置键值对的值。具体来说，就是这个命令在执行时会判断键值对是否存在，如果不存在，就设置键值对的值，如果存在，就不做任何设置。

举个例子，如果执行下面的命令时，key 不存在，那么 key 会被创建，并且值会被设置为 value；如果 key 已经存在，SETNX 不做任何赋值操作。

SETNX key value

对于释放锁操作来说，我们可以在执行完业务逻辑后，使用 DEL 命令删除锁变量。不过，你不用担心锁变量被删除后，其他客户端无法请求加锁了。因为 SETNX 命令在执行时，如果要设置的键值对（也就是锁变量）不存在，SETNX 命令会先创建键值对，然后设置它的值。所以，释放锁之后，再有客户端请求加锁时，SETNX 命令会创建保存锁变量的键值对，并设置锁变量的值，完成加锁。
总结来说，我们就可以用 SETNX 和 DEL 命令组合来实现加锁和释放锁操作。下面的伪代码示例显示了锁操作的过程，你可以看下。

// 加锁
SETNX lock_key 1
// 业务逻辑
DO THINGS
// 释放锁
DEL lock_key

不过，使用 SETNX 和 DEL 命令组合实现分布锁，存在两个潜在的风险。

第一个风险是，假如某个客户端在执行了 SETNX 命令、加锁之后，紧接着却在操作共享数据时发生了异常，结果一直没有执行最后的 DEL 命令释放锁。因此，锁就一直被这个客户端持有，其它客户端无法拿到锁，也无法访问共享数据和执行后续操作，这会给业务应用带来影响。
针对这个问题，一个有效的解决方法是，给锁变量设置一个过期时间。这样一来，即使持有锁的客户端发生了异常，无法主动地释放锁，Redis 也会根据锁变量的过期时间，在锁变量过期后，把它删除。其它客户端在锁变量过期后，就可以重新请求加锁，这就不会出现无法加锁的问题了。

我们再来看第二个风险。如果客户端 A 执行了 SETNX 命令加锁后，假设客户端 B 执行了 DEL 命令释放锁，此时，客户端 A 的锁就被误释放了。如果客户端 C 正好也在申请加锁，就可以成功获得锁，进而开始操作共享数据。这样一来，客户端 A 和 C 同时在对共享数据进行操作，数据就会被修改错误，这也是业务层不能接受的。
为了应对这个问题，我们需要能区分来自不同客户端的锁操作，具体咋做呢？其实，我们可以在锁变量的值上想想办法。
在使用 SETNX 命令进行加锁的方法中，我们通过把锁变量值设置为 1 或 0，表示是否加锁成功。1 和 0 只有两种状态，无法表示究竟是哪个客户端进行的锁操作。所以，我们在加锁操作时，可以让每个客户端给锁变量设置一个唯一值，这里的唯一值就可以用来标识当前操作的客户端。在释放锁操作时，客户端需要判断，当前锁变量的值是否和自己的唯一标识相等，只有在相等的情况下，才能释放锁。这样一来，就不会出现误释放锁的问题了。

知道了解决方案，那么，在 Redis 中，具体是怎么实现的呢？我们再来了解下。
在查看具体的代码前，我要先带你学习下 Redis 的 SET 命令。

我们刚刚在说 SETNX 命令的时候提到，对于不存在的键值对，它会先创建再设置值（也就是“不存在即设置”），为了能达到和 SETNX 命令一样的效果，Redis 给 SET 命令提供了类似的选项 NX，用来实现“不存在即设置”。如果使用了 NX 选项，SET 命令只有在键值对不存在时，才会进行设置，否则不做赋值操作。此外，SET 命令在执行时还可以带上 EX 或 PX 选项，用来设置键值对的过期时间。

举个例子，执行下面的命令时，只有 key 不存在时，SET 才会创建 key，并对 key 进行赋值。另外，key 的存活时间由 seconds 或者 milliseconds 选项值来决定。

SET key value [EX seconds | PX milliseconds]  [NX]

有了 SET 命令的 NX 和 EX/PX 选项后，我们就可以用下面的命令来实现加锁操作了。
// 加锁, unique_value作为客户端唯一性的标识

SET lock_key unique_value NX PX 10000

其中，unique_value 是客户端的唯一标识，可以用一个随机生成的字符串来表示，PX 10000 则表示 lock_key 会在 10s 后过期，以免客户端在这期间发生异常而无法释放锁。

因为在加锁操作中，每个客户端都使用了一个唯一标识，所以在释放锁操作时，我们需要判断锁变量的值，是否等于执行释放锁操作的客户端的唯一标识，如下所示：
//释放锁 比较unique_value是否相等，避免误释放

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

这是使用 Lua 脚本（unlock.script）实现的释放锁操作的伪代码，其中，KEYS[1]表示 lock_key，ARGV[1]是当前客户端的唯一标识，这两个值都是我们在执行 Lua 脚本时作为参数传入的。

最后，我们执行下面的命令，就可以完成锁释放操作了。

redis-cli  --eval  unlock.script lock_key , unique_value

你可能也注意到了，在释放锁操作中，我们使用了 Lua 脚本，这是因为，释放锁操作的逻辑也包含了读取锁变量、判断值、删除锁变量的多个操作，而 Redis 在执行 Lua 脚本时，可以以原子性的方式执行，从而保证了锁释放操作的原子性。

好了，到这里，你了解了如何使用 SET 命令和 Lua 脚本在 Redis 单节点上实现分布式锁。但是，我们现在只用了一个 Redis 实例来保存锁变量，如果这个 Redis 实例发生故障宕机了，那么锁变量就没有了。此时，客户端也无法进行锁操作了，这就会影响到业务的正常执行。所以，我们在实现分布式锁时，还需要保证锁的可靠性。那怎么提高呢？这就要提到基于多个 Redis 节点实现分布式锁的方式了。

基于多个 Redis 节点实现高可靠的分布式锁
当我们要实现高可靠的分布式锁时，就不能只依赖单个的命令操作了，我们需要按照一定的步骤和规则进行加解锁操作，否则，就可能会出现锁无法工作的情况。“一定的步骤和规则”是指啥呢？其实就是分布式锁的算法。

为了避免 Redis 实例故障而导致的锁无法工作的问题，Redis 的开发者 Antirez 提出了分布式锁算法 Redlock。

Redlock 算法的基本思路，是让客户端和多个独立的 Redis 实例依次请求加锁，如果客户端能够和半数以上的实例成功地完成加锁操作，那么我们就认为，客户端成功地获得分布式锁了，否则加锁失败。这样一来，即使有单个 Redis 实例发生故障，因为锁变量在其它实例上也有保存，所以，客户端仍然可以正常地进行锁操作，锁变量并不会丢失。

我们来具体看下 Redlock 算法的执行步骤。Redlock 算法的实现需要有 N 个独立的 Redis 实例。接下来，我们可以分成 3 步来完成加锁操作。

第一步是，客户端获取当前时间。
第二步是，客户端按顺序依次向 N 个 Redis 实例执行加锁操作。

这里的加锁操作和在单实例上执行的加锁操作一样，使用 SET 命令，带上 NX，EX/PX 选项，以及带上客户端的唯一标识。当然，如果某个 Redis 实例发生故障了，为了保证在这种情况下，Redlock 算法能够继续运行，我们需要给加锁操作设置一个超时时间。

如果客户端在和一个 Redis 实例请求加锁时，一直到超时都没有成功，那么此时，客户端会和下一个 Redis 实例继续请求加锁。加锁操作的超时时间需要远远地小于锁的有效时间，一般也就是设置为几十毫秒。

第三步是，一旦客户端完成了和所有 Redis 实例的加锁操作，客户端就要计算整个加锁过程的总耗时。

客户端只有在满足下面的这两个条件时，才能认为是加锁成功。

• 条件一：客户端从超过半数（大于等于 N/2+1）的 Redis 实例上成功获取到了锁；
• 条件二：客户端获取锁的总耗时没有超过锁的有效时间。

在满足了这两个条件后，我们需要重新计算这把锁的有效时间，计算的结果是锁的最初有效时间减去客户端为获取锁的总耗时。如果锁的有效时间已经来不及完成共享数据的操作了，我们可以释放锁，以免出现还没完成数据操作，锁就过期了的情况。

当然，如果客户端在和所有实例执行完加锁操作后，没能同时满足这两个条件，那么，客户端向所有 Redis 节点发起释放锁的操作。

In the Redlock algorithm, the operation of releasing the lock is the same as the operation of releasing the lock on a single instance. Just execute the Lua script that releases the lock. In this way, as long as more than half of the N Redis instances can work normally, the normal operation of the distributed lock can be guaranteed.

So, in actual business applications, if you want to improve the reliability of distributed locks, you can achieve it through the Redlock algorithm.

Recommended learning: Redis learning tutorial

The above is the detailed content of Let’s talk about how to use Redis to implement distributed locks. For more information, please follow other related articles on the PHP Chinese website!