reactphp redlock

Locos distribuidos con Redis y Reactphp

Implementación de algoritmo de Redlock asincrónico para PHP

Inicio rápido

Una vez instalado, puede incorporar Redlock en sus proyectos instanciando a su custodio ; Esta entidad es responsable de la orquestación de bloqueo y requiere acceso a una instancia de objeto de cliente Redis, por ejemplo,

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

Adquiriendo cerraduras

Para los casos de uso en los que es deseable un resultado binario, el método acquire() funciona mejor, por ejemplo:

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

Hilvanes

El método spin() está diseñado para situaciones en las que un proceso debe seguir intentando adquirir un bloqueo, por ejemplo,

 /**
 * @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 último, los ejemplos proporcionados son un buen punto de partida.

Requisitos

Redlock es compatible con PHP 7.2+ y requiere la biblioteca de pista/reactphp-Redis.

Instalación

Puede agregar la biblioteca como dependencia del proyecto usando el compositor:

composer require rtckit/react-redlock

Si solo necesita la biblioteca durante el desarrollo, por ejemplo, cuando se usa en su conjunto de pruebas, debe agregarla como una dependencia de solo desarrollo:

composer require --dev rtckit/react-redlock

Pruebas

Para ejecutar la suite de prueba, clone este repositorio y luego instale dependencias a través del compositor:

composer install

Luego, vaya a la raíz del proyecto y ejecute:

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

Análisis estático

Para garantizar una alta calidad de código, Redlock usa Phpstan y 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

Licencia

MIT, ver archivo de licencia.

Expresiones de gratitud

• Antirez - Publicación de blog original
• Proyecto ReactphP
• Clue/Reactphp -Redis - Implementación del cliente Async Redis

Que contribuye

Los informes de errores (y los parches pequeños) se pueden enviar a través del rastreador de problemas. Se prefiere la bifurcación del repositorio y enviar una solicitud de extracción para parches sustanciales.