reactphp redlock

Bloqueios distribuídos com Redis e Reactphp

Implementação de algoritmo Redlock assíncrono para PHP

Investir rápido

Depois de instalado, você pode incorporar o Redlock em seus projetos instanciando seu custodiante ; Essa entidade é responsável pela orquestração de bloqueio e requer acesso a uma instância do objeto Redis Client, por exemplo

 /* 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 );

Adquirir bloqueios

Para casos de uso em que um resultado binário é desejável, o método acquire() funciona melhor, por exemplo:

 /**
 * @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 );
        }
    });

Spinlocks

O método spin() é projetado para situações em que um processo deve continuar tentando adquirir uma trava, por exemplo

 /**
 * @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 );
        }
    })

Por fim, os exemplos fornecidos são um bom ponto de partida.

Requisitos

O Redlock é compatível com o PHP 7.2+ e requer a biblioteca Clue/Reactphp-Redis.

Instalação

Você pode adicionar a biblioteca como dependência do projeto usando o Composer:

composer require rtckit/react-redlock

Se você precisar apenas da biblioteca durante o desenvolvimento, por exemplo, quando usado no seu conjunto de testes, adicione-o como uma dependência somente para o desenvolvimento:

composer require --dev rtckit/react-redlock

Testes

Para executar o conjunto de testes, clone este repositório e instale dependências via compositor:

composer install

Em seguida, vá para a raiz do projeto e corra:

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

Análise estática

Para garantir alta qualidade de código, o Redlock usa o Phpstan e o Salmo:

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

Licença

MIT, consulte o arquivo de licença.

Agradecimentos

• Antirez - Postagem original do blog
• Projeto Reactphp
• Clue/Reactphp -Redis - ASYNC Redis Client Implementation

Contribuindo

Relatórios de bug (e pequenos patches) podem ser enviados através do rastreador de problemas. Burcando o repositório e o envio de uma solicitação de tração é preferido para patches substanciais.