reactphp redlock

Распределенные замки с Redis и ReactPhp

Асинхронная реализация алгоритма Redlock для PHP

QuickStart

После установки вы можете включить Redlock в свои проекты, создав его хранителя ; Эта сущность отвечает за оркестровку блокировки и требует доступа к экземпляру объекта клиента Redis, например,

 /* Instantiate prerequisites */
$ factory = new  Clue  React  Redis  Factory ();
$ client = $ factory -> createLazyClient ( ' 127.0.0.1 ' );

/* Instantiate our lock custodian */
$ custodian = new  RTCKit  React  Redlock  Custodian ( $ client );

Приобретение замков

Для вариантов использования, когда бинарный результат желателен, метод acquire() работает лучше всего, например:

 /**
 * @param string $resource Redis key name
 * @param float $ttl Lock's time to live (in seconds)
 * @param ?string $token Unique identifier for lock in question
 * @return PromiseInterface
 */
$ custodian -> acquire ( ' MyResource ' , 60 , ' r4nd0m_token ' )
    -> then ( function (? Lock $ lock ) {
        if ( is_null ( $ lock )) {
            // Ooops, lock could not be acquired for MyResource
        } else {
            // Awesome, MyResource is locked for a minute
            // ...

            // Be nice and release the lock when done
            $ custodian -> release ( $ lock );
        }
    });

Спинлоки

Метод spin() предназначен для ситуаций, когда процесс должен продолжать пытаться приобрести блокировку, например,

 /**
 * @param int $attempts Maximum spin/tries
 * @param float $interval Spin/try interval (in seconds)
 * @param string $resource Redis key name
 * @param float $ttl Lock's time to live (in seconds)
 * @param ?string $token Unique identifier for lock in question
 * @return PromiseInterface
 */
$ custodian -> spin ( 100 , 0.5 , ' HotResource ' , 10 , ' r4nd0m_token ' )
    -> then ( function (? Lock $ lock ): void {
        if ( is_null ( $ lock )) {
            // Wow, after 100 tries (with a gap of 0.5 seconds) I've
            // given up acquiring a lock on HotResource
        } else {
            // Awesome, HotResource is locked for 10 seconds
            // ...

            // Again, be nice and release the lock when done
            $ custodian -> release ( $ lock );
        }
    })

Наконец, приведенные примеры являются хорошей отправной точкой.

Требования

Redlock совместим с PHP 7.2+ и требует библиотеки Clue/ReactPHP-REDIS.

Установка

Вы можете добавить библиотеку в качестве зависимости проекта с помощью композитора:

composer require rtckit/react-redlock

Если вам нужна библиотека только во время разработки, например, при использовании в вашем тестовом наборе, то вы должны добавить ее в качестве зависимости только для разработки:

composer require --dev rtckit/react-redlock

Тесты

Чтобы запустить тестовый набор, клонируйте этот репозиторий, а затем установите зависимости через композитор:

composer install

Затем перейдите в корень проекта и запустите:

php -d memory_limit=-1 ./vendor/bin/phpunit -c ./etc/phpunit.xml.dist

Статический анализ

Чтобы обеспечить высокое качество кода, Redlock использует Phpstan и Psalm:

php -d memory_limit=-1 ./vendor/bin/phpstan analyse -c ./etc/phpstan.neon -n -vvv --ansi --level=max src
php -d memory_limit=-1 ./vendor/bin/psalm --config=./etc/psalm.xml --show-info=true

Лицензия

MIT, см. Файл лицензии.

Благодарности

• Антирес - оригинальный пост в блоге
• ReactPhp Project
• Clue/Reactphp -Redis - Async Redis реализация клиента

Внося

Отчеты об ошибках (и небольшие патчи) могут быть отправлены через трекер выпуска. Выполнение репозитория и подача запроса на привлечение является предпочтительным для существенных исправлений.