reactphp redlock

Kunci Terdistribusi dengan Redis dan ReactPHP

Implementasi algoritma redlock asinkron untuk PHP

QuickStart

Setelah diinstal, Anda dapat memasukkan redlock dalam proyek Anda dengan instantiasi penjaganya ; Entitas ini bertanggung jawab untuk orkestrasi kunci dan memerlukan akses ke instance objek klien redis, misalnya

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

Memperoleh kunci

Untuk kasus penggunaan di mana hasil biner diinginkan, metode acquire() bekerja paling baik, misalnya:

 /**
 * @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

Metode spin() dirancang untuk situasi di mana suatu proses harus terus mencoba memperoleh kunci, misalnya

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

Terakhir, contoh yang disediakan adalah titik awal yang baik.

Persyaratan

Redlock kompatibel dengan PHP 7.2+ dan membutuhkan perpustakaan Petunjuk/ReactPHP-Redis.

Instalasi

Anda dapat menambahkan perpustakaan sebagai ketergantungan proyek menggunakan komposer:

composer require rtckit/react-redlock

Jika Anda hanya membutuhkan perpustakaan selama pengembangan, misalnya saat digunakan di suite test Anda, maka Anda harus menambahkannya sebagai ketergantungan hanya pengembangan:

composer require --dev rtckit/react-redlock

Tes

Untuk menjalankan test suite, klon repositori ini dan kemudian instal dependensi melalui komposer:

composer install

Kemudian, buka root proyek dan jalankan:

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

Analisis statis

Untuk memastikan kualitas kode tinggi, Redlock menggunakan Phpstan dan Mazmur:

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

Lisensi

MIT, lihat file lisensi.

Ucapan Terima Kasih

• Antirez - posting blog asli
• Proyek ReactPHP
• Petunjuk/ReactPHP -Redis - Async Redis Klien Implementasi

Berkontribusi

Laporan bug (dan tambalan kecil) dapat dikirimkan melalui pelacak masalah. Menghasilkan repositori dan mengirimkan permintaan tarik lebih disukai untuk tambalan yang substansial.