<?php
 
require_once 'RedisFactory.php';
 
/**
* 在 Redis 上實(shí)現(xiàn)的分布式鎖
*/
class RedisLock {
  
//單例模式
  private static $_instance = null;
  public static function instance() {
    if(self::$_instance == null) {
      self::$_instance = new RedisLock();
    }
    return self::$_instance;
  }
 
  
//redis對(duì)象變量
  private $redis;
  
//存放被鎖的標(biāo)志名的數(shù)組
  private $lockedNames = array();
 
  public function __construct() {
    
//獲取一個(gè) RedisString 實(shí)例
    $this->redis = RedisFactory::instance()->getString();
  }
 
  
/** 
  
* 加鎖
  
*
  
* @param string 鎖的標(biāo)識(shí)名
  
* @param int 獲取鎖失敗時(shí)的等待超時(shí)時(shí)間(秒), 在此時(shí)間之內(nèi)會(huì)一直嘗試獲取鎖直到超時(shí). 為 0 表示失敗后直接返回不等待
  
* @param int 當(dāng)前鎖的最大生存時(shí)間(秒), 必須大于 0 . 如果超過(guò)生存時(shí)間后鎖仍未被釋放, 則系統(tǒng)會(huì)自動(dòng)將其強(qiáng)制釋放
  
* @param int 獲取鎖失敗后掛起再試的時(shí)間間隔(微秒)
  
*/
  public function lock($name, $timeout = 0, $expire = 15, $waitIntervalUs = 100000) {
    if(empty($name)) return false;
 
    $timeout = (int)$timeout;
    $expire = max((int)$expire, 5);
    $now = microtime(true);
    $timeoutAt = $now + $timeout;
    $expireAt = $now + $expire;
 
    $redisKey = "Lock:$name";
    while(true) {
      $result = $this->redis->setnx($redisKey, (string)$expireAt);
      if($result !== false) {
        
//對(duì)$redisKey設(shè)置生存時(shí)間
        $this->redis->expire($redisKey, $expire);
        
//將最大生存時(shí)刻記錄在一個(gè)數(shù)組里面
        $this->lockedNames[$name] = $expireAt;
        return true;
      }
 
      
//以秒為單位，返回$redisKey 的剩余生存時(shí)間
      $ttl = $this->redis->ttl($redisKey);
      
// TTL 小于 0 表示 key 上沒(méi)有設(shè)置生存時(shí)間(key 不會(huì)不存在, 因?yàn)榍懊?setnx 會(huì)自動(dòng)創(chuàng)建)
      
// 如果出現(xiàn)這種情況, 那就是進(jìn)程在某個(gè)實(shí)例 setnx 成功后 crash 導(dǎo)致緊跟著的 expire 沒(méi)有被調(diào)用. 這時(shí)可以直接設(shè)置 expire 并把鎖納為己用
      if($ttl < 0) {
        $this->redis->set($redisKey, (string)$expireAt, $expire);
        $this->lockedNames[$name] = $expireAt;
        return true;
      }
 
      
// 設(shè)置了不等待或者已超時(shí)
      if($timeout <= 0 || microtime(true) > $timeoutAt) break;
 
      
// 掛起一段時(shí)間再試
      usleep($waitIntervalUs);
    }
 
    return false;
  }
 
  
/**
  
* 給當(dāng)前鎖增加指定的生存時(shí)間(秒), 必須大于 0
  
*
  
* @param string 鎖的標(biāo)識(shí)名
  
* @param int 生存時(shí)間(秒), 必須大于 0
  
*/
  public function expire($name, $expire) {
    if($this->isLocking($name)) {
      if($this->redis->expire("Lock:$name", max($expire, 1))) {
        return true;
      }
    }
    return false;
  }
 
  
/**
  
* 判斷當(dāng)前是否擁有指定名稱的鎖
  
*
  
* @param mixed $name
  
*/
  public function isLocking($name) {
    if(isset($this->lockedNames[$name])) {
      return (string)$this->lockedNames[$name] == (string)$this->redis->get("Lock:$name");
    }
    return false;
  }
 
  
/**
  
* 釋放鎖
  
*
  
* @param string 鎖的標(biāo)識(shí)名
  
*/
  public function unlock($name) {
    if($this->isLocking($name)) {
      if($this->redis->deleteKey("Lock:$name")) {
        unset($this->lockedNames[$name]);
        return true;
      }
    }
    return false;
  }
 
  
/** 釋放當(dāng)前已經(jīng)獲取到的所有鎖 */
  public function unlockAll() {
    $allSuccess = true;
    foreach($this->lockedNames as $name => $item) {
      if(false === $this->unlock($name)) {
        $allSuccess = false;
      }
    }
    return $allSuccess;
  }
}