[扩展] Hyperf-redis-lock 基于hyperf的分布式锁的实现

hyperf-redis-lock#

English | 中文
一个简单的 Redis 分布式锁的实现基于 Hyperf 框架。本扩展实现了基本的分布式锁，支持阻塞式分布式锁和非阻塞式分布式锁。

原理#

Redis 的命令为原子性使用 Redis 的 set 即可保证业务的串行执行。
2.8 之前版本的 Redis 不支持 set 的 ex 选项因此只能使用 setnx+expire 的方式。对应扩展 1.0 版本.
2.8 之后版本的 Redis 可以直接使用 set 的 nx+ex 选项。对应扩展 2.* 版本

因此 2. 版本只支持 2.8 版本以后的 Redis 1. 版本支持所有版本的 Redis.

确认你的 Redis 版本如果你的 Redis 低于 2.8 版本则 set 命令不支持 ex 选项因此你需要安装 1.x 版本。#

您可以执行下面命令查看 redis 的版本。
redis-server --version

安装#

注意：请根据你的 Redis 版本
执行 composer require lysice/hyperf-redis-lock

Redis 版本	set ex 支持	引入版本
<2.8	不支持	1.*
>=2.8	支持	2.* 1.* 均可

使用#

首先需要在程序内初始化你需要的 redis

/**
 * @var RedisLock 
 */ 
 protected $redis;
 public function __construct(RedisFactory $redisFactory) {
     $this->redis = $redisFactory->get('default'); 
 }

非阻塞式锁该方法在尝试获取锁之后直接返回结果。

若获取到锁则执行闭包后返回结果。

获取锁失败时默认返回 false。您也可以指定可选参数 $finally 该参数为一个闭包当获取锁失败时若指定该闭包则直接返回该闭包的结果。

public function testNonBlocking(ResponseInterface $response)
{ 
// 初始化RedisLock 参数:redis实例 锁名称 超时时间
$lock = new RedisLock($this->redis, 'lock', 20); // 非阻塞式获取锁
$res = $lock->get(function () { sleep(10); return [123]; }); return $response->json($res); 
}

阻塞式锁该方法首先尝试获取锁，若获取失败则每隔 250 毫秒获取一次直到超时 (等待时间超出本程序内锁的过期时间则判定为超时)。如果锁获取成功则执行闭包函数返回结果。
- 注意若超时则程序会抛出 LockTimeoutException 超时异常。应用程序内需要自己捕获该异常以便处理超时情况的返回结果。
- 例子:

/**
 * @return \Psr\Http\Message\ResponseInterface 
 */
public function testBlocking(ResponseInterface $response) {
    try { 
    // 初始化RedisLock 参数:redis实例 锁名称 超时时间
    $lock = new RedisLock($this->redis, 'lock', 4); 
    // 阻塞式
    $res = $lock->block(4, function () {
           return [456]; 
    }); 
    return $response->json(['res' => $res]); 
    // 捕获超时异常 超时处理
   } catch (LockTimeoutException $exception) { 
       var_dump('lockA lock check timeout');
       return $response->json(['res' => false, 'message' => '超时']);
   }
 }