README

使用

简单使用

    try {
        $lock = $this->container->get(RedLock::class)->setRedisPoolName()->setRetryCount(1)->lock('redlock-hyperf-test', 60000);
        if ($lock) {
            //do your code
            $this->container->get(RedLock::class)->unlock($lock);
        }
    } catch (\Throwable $throwable) {
        var_dump($throwable->getMessage());
    }

• setRedisPoolName 方法用于指定 Redlock 使用哪些 Redis 实例作为分布式独立节点，这里需要传入索引数组，默认['default']，数组的值应该是 /config/autoload/redis.php 下的连接池 name。关于为什么要使用独立的 Redis 节点：

• setRetryCount 方法用于设置获取锁的重试次数，默认2次
• setRetryDelay 用于一次获取锁失败后延迟时间后重试，默认200，单位毫秒
• lock 方法，获取锁
  • resource：锁的 key
  • ttl：锁过期时间，单位毫秒。
  • return：array|false
• unlock 方法，释放锁
  • 参数：lock 方法成功后的 return
• 如果担心请求保持锁阶段进程出现重启或退出情况，建议增加以下代码

  //参考 RedlockHyperf\Aspect\RedLockAspect
  if ($lock) {
  //to release lock when server receive exit sign
  Coroutine::create(function () use ($lock) {
  $exited = CoordinatorManager::until(Constants::WORKER_EXIT)->yield($lock['validity']);
  $exited && $this->redlock->unlock($lock);
  });
  //do your code
  $this->redlock->unlock($lock);
  return $result;
  }
  

注解使用

class IndexController extends AbstractController
{
    /**
     * @RedLockAnnotation(resource="redlock-hyperf-test", poolName={"default"})
     */
    public function index() {}
}

SDK 提供 RedlockHyperf\Annotation\RedLockAnnotation 注解，作用类于方法上，可以配置 resource（必填），poolName，poolName，poolName，clockDriftFactor，ttl 等参数