README-zh.md

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.0版本。

redis-server --version

安装

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

使用

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

/**
     * @var RedisLock
     */
    protected $redis;

    public function __construct(RedisFactory $redisFactory)
    {
        $this->redis = $redisFactory->get('default');
    }

• 非阻塞式锁 该方法在尝试获取锁之后直接返回结果。若获取到锁则执行闭包后返回结果。否则返回false

public function lock(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 lockA(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' => '超时']);
        }
    }

最后

代码贡献

如果存在任何好的想法请提交pull request Feel free to create a fork and submit a pull request if you would like to contribute.

代码问题

如果存在任何问题请提交issue.