锁

锁（Lock），在并发处理，防止冲突的场景非常常用。

在 imi 中，你可以使用注解，或者自己实例化Lock类来实现加锁处理。

目前 imi 中仅内置支持 RedisLock，它支持分布式，当然你也可以实现Imi\Lock\Handler\ILockHandler接口，来实现其他方式的锁。

实例化使用

顺序用法

  1. $redisLock = new \Imi\Lock\Handler\Redis('锁ID', [
  2.     'poolName'  => 'redis', // Redis 连接池名称，默认取redis.default配置
  3.     'db'        =>  1, // Redis 几号库，默认0
  4.     'waitSleepTime' =>  20, // 获得锁每次尝试间隔，单位：毫秒
  5.     'keyPrefix' =>  'imi:lock:', // Redis key 前置
  6. ]);
  8. if($redisLock->lock())
  9. {
  10.     // 加锁后的处理
  12.     // 解锁
  13.     $redisLock->unlock();
  14. }
  15. else
  16. {
  17.     // 加锁失败的处理
  18. }

回调用法

  1. $redisLock = new \Imi\Lock\Handler\Redis('锁ID', [
  2.     'poolName'  => 'redis', // Redis 连接池名称，默认取redis.default配置
  3.     'db'        =>  1, // Redis 几号库，默认0
  4.     'waitSleepTime' =>  20, // 获得锁每次尝试间隔，单位：毫秒
  5.     'keyPrefix' =>  'imi:lock:', // Redis key 前置
  6. ]);
  8. // 执行后自动解锁
  9. $result = $redisLock->lock(function(){
  10.     // 执行任务
  11. }, function(){
  12.     // return 非null则不执行任务
  13.     // 一般用于防止缓存击穿
  14. });
  16. if($result)
  17. {
  18.     // 加锁并执行成功
  19. }
  20. else
  21. {
  22.     // 加锁失败
  23. }

注解使用

@Lockable

支持参数：

  1. /**
  2.  * 锁ID
  3.  * 支持{id}、{data.name}形式，代入参数
  4.  * 如果为null，则使用类名+方法名+全部参数，序列化后hash
  5.  *
  6.  * @var string|null
  7.  */
  8. public $id;
  10. /**
  11.  * 锁类型，如：RedisLock
  12.  * 为null则使用默认锁类型（@currentServer.lock.defaultType）
  13.  *
  14.  * @var string|null
  15.  */
  16. public $type;
  18. /**
  19.  * 等待锁超时时间，单位：毫秒，0为不限制
  20.  * 
  21.  * @var int
  22.  */
  23. public $waitTimeout = 3000;
  25. /**
  26.  * 锁超时时间，单位：毫秒
  27.  * 
  28.  * @var int
  29.  */
  30. public $lockExpire = 3000;
  32. /**
  33.  * 锁初始化参数
  34.  *
  35.  * @var array
  36.  */
  37. public $options = [];
  39. /**
  40.  * 当获得锁后执行的回调。该回调返回非 null 则不执行加锁后的方法，本回调的返回值将作为返回值
  41.  * 一般用于防止缓存击穿，获得锁后再做一次检测
  42.  * 如果为{"$this", "methodName"}格式，$this将会被替换为当前类，方法必须为 public 或 protected
  43.  * 
  44.  * @var callable
  45.  */
  46. public $afterLock;

用法示例

最简单的锁：

只指定id，其它全部默认值

  1. @Lockable(id="锁ID")

定义执行任务前的操作：

  1. class Test
  2. {
  3.     /**
  4.      * @Lockable(id="锁ID", afterLock={"$this", "check"})
  5.      */
  6.     public function index()
  7.     {
  8.         return 1;
  9.     }
  11.     protected function check()
  12.     {
  13.         return 2;
  14.     }
  16.     /**
  17.      * @Lockable(id="锁ID", afterLock={"$this", "check"})
  18.      */
  19.     public function index2()
  20.     {
  21.         return 3;
  22.     }
  24.     protected function check2()
  25.     {
  27.     }
  28. }
  30. $result = App::getBean('Test')->index();
  31. echo $result, PHP_EOL; // 2
  33. $result = App::getBean('Test')->index2();
  34. echo $result, PHP_EOL; // 3