README

Hyperf 的锁组件。 中文说明

安装

• 需求

composer require friendsofhyperf/lock

• 发布

php bin/hyperf.php vendor:publish friendsofhyperf/lock -i config

用法

您可以使用 lock() 方法创建和管理锁。

$lock = lock($name = 'foo', $seconds = 10, $owner = null);

if ($lock->get()) {
    // Lock acquired for 10 seconds...

    $lock->release();
}

get 方法也接受一个闭包。闭包执行后，将自动释放锁。

lock('foo')->get(function () {
    // Lock acquired indefinitely and automatically released...
});

如果请求锁时锁不可用，您可以指示锁等待指定数量的秒数。如果在指定时间内无法获取锁，将抛出 FriendsOfHyperf\Lock\Exception\LockTimeoutException 异常。

use FriendsOfHyperf\Lock\Exception\LockTimeoutException;

$lock = lock('foo', 10);

try {
    $lock->block(5);

    // Lock acquired after waiting maximum of 5 seconds...
} catch (LockTimeoutException $e) {
    // Unable to acquire lock...
} finally {
    optional($lock)->release();
}

lock('foo', 10)->block(5, function () {
    // Lock acquired after waiting maximum of 5 seconds...
});

通过注解使用

use FriendsOfHyperf\Lock\Annotation\Lock;
use FriendsOfHyperf\Lock\Driver\LockInterface;

class Foo
{
    #[Lock(name:"foo", seconds:10)]
    protected LockInterface $lock;

    public function bar()
    {
        $this->lock->get(function () {
            // Lock acquired indefinitely and automatically released...
        });
    }
}

联系方式

• Twitter
• Gmail

许可证

MIT