Redis分佈式鎖和任務隊列代碼

/*
在redis上實現分佈式鎖
*/
class RedisLock {
private $redisString;
private $lockedNames = [];

public function __construct($param = NULL) {
    $this->redisString = RedisFactory::get($param)->string;
}

/**
 * 加鎖
 * @param  [type]  $name           鎖的標識名
 * @param  integer $timeout        循環獲取鎖的等待超時時間,在此時間內會一直嘗試獲取鎖直到超時,爲0表示失敗後直接返回不等待
 * @param  integer $expire         當前鎖的最大生存時間(秒),必須大於0,如果超過生存時間鎖仍未被釋放,則系統會自動強制釋放
 * @param  integer $waitIntervalUs 獲取鎖失敗後掛起再試的時間間隔(微秒)
 * @return [type]                  [description]
 */
public function lock($name, $timeout = 0, $expire = 15, $waitIntervalUs = 100000) {
    if ($name == null) return false;

    //取得當前時間
    $now = time();
    //獲取鎖失敗時的等待超時時刻
    $timeoutAt = $now + $timeout;
    //鎖的最大生存時刻
    $expireAt = $now + $expire;

    $redisKey = "Lock:{$name}";
    while (true) {
        //將rediskey的最大生存時刻存到redis裏,過了這個時刻該鎖會被自動釋放
        $result = $this->redisString->setnx($redisKey, $expireAt);

        if ($result != false) {
            //設置key的失效時間
            $this->redisString->expire($redisKey, $expireAt);
            //將鎖標誌放到lockedNames數組裏
            $this->lockedNames[$name] = $expireAt;
            return true;
        }

        //以秒爲單位,返回給定key的剩餘生存時間
        $ttl = $this->redisString->ttl($redisKey);

        //ttl小於0 表示key上沒有設置生存時間(key是不會不存在的,因爲前面setnx會自動創建)
        //如果出現這種狀況,那就是進程的某個實例setnx成功後 crash 導致緊跟着的expire沒有被調用
        //這時可以直接設置expire並把鎖納爲己用
        if ($ttl < 0) {
            $this->redisString->set($redisKey, $expireAt);
            $this->lockedNames[$name] = $expireAt;
            return true;
        }

        /*****循環請求鎖部分*****/
        //如果沒設置鎖失敗的等待時間 或者 已超過最大等待時間了,那就退出
        if ($timeout <= 0 || $timeoutAt < microtime(true)) break;

        //隔 $waitIntervalUs 後繼續 請求
        usleep($waitIntervalUs);

    }

    return false;
}

/**
 * 解鎖
 * @param  [type] $name [description]
 * @return [type]       [description]
 */
public function unlock($name) {
    //先判斷是否存在此鎖
    if ($this->isLocking($name)) {
        //刪除鎖
        if ($this->redisString->deleteKey("Lock:$name")) {
            //清掉lockedNames裏的鎖標誌
            unset($this->lockedNames[$name]);
            return true;
        }
    }
    return false;
}

/**
 * 釋放當前所有獲得的鎖
 * @return [type] [description]
 */
public function unlockAll() {
    //此標誌是用來標誌是否釋放所有鎖成功
    $allSuccess = true;
    foreach ($this->lockedNames as $name => $expireAt) {
        if (false === $this->unlock($name)) {
            $allSuccess = false;    
        }
    }
    return $allSuccess;
}

/**
 * 給當前所增加指定生存時間,必須大於0
 * @param  [type] $name [description]
 * @return [type]       [description]
 */
public function expire($name, $expire) {
    //先判斷是否存在該鎖
    if ($this->isLocking($name)) {
        //所指定的生存時間必須大於0
        $expire = max($expire, 1);
        //增加鎖生存時間
        if ($this->redisString->expire("Lock:$name", $expire)) {
            return true;
        }
    }
    return false;
}

/**
 * 判斷當前是否擁有指定名字的所
 * @param  [type]  $name [description]
 * @return boolean       [description]
 */
public function isLocking($name) {
    //先看lonkedName[$name]是否存在該鎖標誌名
    if (isset($this->lockedNames[$name])) {
        //從redis返回該鎖的生存時間
        return (string)$this->lockedNames[$name] = (string)$this->redisString->get("Lock:$name");
    }

    return false;
}

}

/**

  • 任務隊列
    */
    class RedisQueue {
    private $_redis;

    public function __construct($param = null) {
    $this->_redis = RedisFactory::get($param);
    }

    /**

    • 入隊一個 Task
    • @param [type] $name 隊列名稱
    • @param [type] $id 任務id(或者其數組)
    • @param integer $timeout 入隊超時時間(秒)
    • @param integer $afterInterval [description]
    • @return [type] [description]
      */
      public function enqueue($name, $id, $timeout = 10, $afterInterval = 0) {
      //合法性檢測
      if (empty($name) || empty($id) || $timeout <= 0) return false;

      //加鎖
      if (!$this->_redis->lock->lock("Queue:{$name}", $timeout)) {
      Logger::get('queue')->error("enqueue faild becouse of lock failure: name = $name, id = $id");
      return false;
      }

      //入隊時以當前時間戳作爲 score
      $score = microtime(true) + $afterInterval;
      //入隊
      foreach ((array)$id as $item) {
      //先判斷下是否已經存在該id了
      if (false === $this->_redis->zset->getScore("Queue:$name", $item)) {
      $this->_redis->zset->add("Queue:$name", $score, $item);
      }
      }

      //解鎖
      $this->_redis->lock->unlock("Queue:$name");

      return true;

    }

    /**

    • 出隊一個Task,需要指定$id 和 $score
    • 如果$score 與隊列中的匹配則出隊,否則認爲該Task已被重新入隊過,當前操作按失敗處理
    • @param [type] $name 隊列名稱
    • @param [type] $id 任務標識
    • @param [type] $score 任務對應score,從隊列中獲取任務時會返回一個score,只有$score和隊列中的值匹配時Task纔會被出隊
    • @param integer $timeout 超時時間(秒)
    • @return [type] Task是否成功,返回false可能是redis操作失敗,也有可能是$score與隊列中的值不匹配(這表示該Task自從獲取到本地之後被其他線程入隊過)
      */
      public function dequeue($name, $id, $score, $timeout = 10) {
      //合法性檢測
      if (empty($name) || empty($id) || empty($score)) return false;

      //加鎖
      if (!$this->_redis->lock->lock("Queue:$name", $timeout)) {
      Logger:get('queue')->error("dequeue faild becouse of lock lailure:name=$name, id = $id");
      return false;
      }

      //出隊
      //先取出redis的score
      $serverScore = $this->_redis->zset->getScore("Queue:$name", $id);
      $result = false;
      //先判斷傳進來的score和redis的score是否是一樣
      if ($serverScore == $score) {
      //刪掉該$id
      $result = (float)$this->_redis->zset->delete("Queue:$name", $id);
      if ($result == false) {
      Logger::get('queue')->error("dequeue faild because of redis delete failure: name =$name, id = $id");
      }
      }
      //解鎖
      $this->_redis->lock->unlock("Queue:$name");

      return $result;
      }

    /**

    • 獲取隊列頂部若干個Task 並將其出隊
    • @param [type] $name 隊列名稱
    • @param integer $count 數量
    • @param integer $timeout 超時時間
    • @return [type] 返回數組[0=>['id'=> , 'score'=> ], 1=>['id'=> , 'score'=> ], 2=>['id'=> , 'score'=> ]]
      */
      public function pop($name, $count = 1, $timeout = 10) {
      //合法性檢測
      if (empty($name) || $count <= 0) return [];

      //加鎖
      if (!$this->_redis->lock->lock("Queue:$name")) {
      Logger::get('queue')->error("pop faild because of pop failure: name = $name, count = $count");
      return false;
      }

      //取出若干的Task
      $result = [];
      $array = $this->_redis->zset->getByScore("Queue:$name", false, microtime(true), true, false, [0, $count]);

      //將其放在$result數組裏 並 刪除掉redis對應的id
      foreach ($array as $id => $score) {
      $result[] = ['id'=>$id, 'score'=>$score];
      $this->_redis->zset->delete("Queue:$name", $id);
      }

      //解鎖
      $this->_redis->lock->unlock("Queue:$name");

      return $count == 1 ? (empty($result) ? false : $result[0]) : $result;
      }

    /**

    • 獲取隊列頂部的若干個Task
    • @param [type] $name 隊列名稱
    • @param integer $count 數量
    • @return [type] 返回數組[0=>['id'=> , 'score'=> ], 1=>['id'=> , 'score'=> ], 2=>['id'=> , 'score'=> ]]
      */
      public function top($name, $count = 1) {
      //合法性檢測
      if (empty($name) || $count < 1) return [];

      //取錯若干個Task
      $result = [];
      $array = $this->_redis->zset->getByScore("Queue:$name", false, microtime(true), true, false, [0, $count]);

      //將Task存放在數組裏
      foreach ($array as $id => $score) {
      $result[] = ['id'=>$id, 'score'=>$score];
      }

      //返回數組
      return $count == 1 ? (empty($result) ? false : $result[0]) : $result;
      }
      }

Redis分佈式鎖和任務隊列代碼

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章