tajmahal86 / ninja-mutex
简单易用的互斥锁实现,可以使用 flock、memcache、memcached、mysql 或 redis 进行锁定
0.7.0
2024-02-08 19:51 UTC
Requires
- php: >=8.0.0
Requires (Dev)
- ext-memcache: *
- ext-memcached: *
- ext-pdo: *
- ext-pdo_mysql: *
- ext-redis: *
- mikey179/vfsstream: ^1.4 || ^1.5 || ^1.6
- phpunit/phpunit: ^4.8 || ^5.5 || ^5.6 || ^5.7 || ^9
- predis/predis: ^1.0 || ^1.1
- scrutinizer/ocular: ^1.1 || ^1.3 || ^1.4 || ^1.8
Suggests
- ext-memcache: Create mutex using memcache extension
- ext-memcached: Create mutex using memcached extension
- ext-pdo_mysql: Create mutex using MySQL PDO
- predis/predis: Create mutex using Predis (client library for Redis)
README
关于
ninja-mutex 是一个简单易用的 PHP 互斥锁实现。它支持不同的适配器(flock、memcache、mysql、redis、...),因此你可以按照自己的意愿进行配置。所有适配器(如果配置正确)都可以在多服务器环境中使用 - 换句话说,锁是在 web 服务器之间共享的。
使用方法
互斥锁
首先,你需要选择一个适配器并正确设置它。例如,如果你选择 flock 实现,首先需要设置 NFS 文件系统并将其挂载到 web 服务器上。在这个例子中,我们将选择 memcache 适配器
<?php require 'vendor/autoload.php'; use NinjaMutex\Lock\MemcacheLock; use NinjaMutex\Mutex; $memcache = new Memcache(); $memcache->connect('127.0.0.1', 11211); $lock = new MemcacheLock($memcache); $mutex = new Mutex('very-critical-stuff', $lock); if ($mutex->acquireLock(1000)) { // Do some very critical stuff // and release lock after you finish $mutex->releaseLock(); } else { throw new Exception('Unable to gain lock!'); }
互斥锁工厂
如果你想在项目中使用多个互斥锁,那么 MutexFabric 是正确的解决方案。只需设置一次锁实现者,你就可以使用任意数量的互斥锁!
<?php require 'vendor/autoload.php'; use NinjaMutex\Lock\MemcacheLock; use NinjaMutex\MutexFabric; $memcache = new Memcache(); $memcache->connect('127.0.0.1', 11211); $lock = new MemcacheLock($memcache); $mutexFabric = new MutexFabric('memcache', $lock); if ($mutexFabric->get('very-critical-stuff')->acquireLock(1000)) { // Do some very critical stuff // and release lock after you finish $mutexFabric->get('very-critical-stuff')->releaseLock(); } else { throw new Exception('Unable to gain lock for very critical stuff!'); } if ($mutexFabric->get('also-very-critical-stuff')->acquireLock(0)) { // Do some also very critical stuff // and release lock after you finish $mutexFabric->get('also-very-critical-stuff')->releaseLock(); } else { throw new Exception('Unable to gain lock for also very critical stuff!'); }
安装
Composer
下载 composer
wget -nc https://getcomposer.org.cn/composer.phar
将依赖项添加到你的项目中
php composer.phar require arvenil/ninja-mutex:*
运行测试
测试需要 vfsStream 运行。要安装它,只需在项目目录中运行
wget -nc https://getcomposer.org.cn/composer.phar && php composer.phar install --dev
在控制台中输入运行测试
vendor/bin/phpunit
某些东西不起作用
欢迎 fork 项目,修复错误,并最终请求 pull