在 Redis 上實現的分佈式鎖

時間 2019-11-24

原文原文鏈接

　　　　因爲近排很忙，忙各類事情，還有工做上的項目，已經超過一個月沒寫博客了，確實有點慚愧啊，沒能天天或者至少每週堅持寫一篇博客。這一個月裏面接觸到不少新知識，同時也遇到不少技術上的難點，在這我將對每個有用的技術點作一個小小的分析理解和總結。天天去學會總結，纔會有進步。php

　　本次對我在工做上的項目中用到的技術---在redis上實現分佈式鎖，進行一個分析和總結。redis

　　先了解下什麼時分佈式鎖，在百度上是這麼定義的：數組

　　　　分佈式鎖是控制分佈式系統之間同步訪問共享資源的一種方式。在分佈式系統中，經常須要協調他們的動做。若是不一樣的系統或是同一個系統的不一樣主機之間共享了一個或一組資源，那麼訪問這些資源的時候，每每須要互斥來防止彼此干擾來保證一致性，在這種狀況下，便須要使用到分佈式鎖。併發

　　簡單的理解就是：分佈式鎖是一個在不少環境中很是有用的原語，它是不一樣的系統或是同一個系統的不一樣主機之間互斥操做共享資源的有效方法。異步

　　背景：分佈式

　　　　在不少互聯網產品應用中，有些場景須要加鎖處理，好比：秒殺，全局遞增ID，樓層生成等等。大部分是解決方案基於DB實現的，Redis爲單進程單線程模式，採用隊列模式將併發訪問變成串行訪問，且多客戶端對Redis的鏈接並不存在競爭關係。ui

　　咱們的項目：this

　　咱們如今的項目中，任務隊列用到分佈式鎖的狀況比較多，在將業務邏輯中能夠異步處理的操做放入隊列，在其餘線程中處理後出隊，此時隊列中使用了分佈式鎖，保證入隊和出隊的一致性。關於redis隊列這塊的邏輯分析，我將在下一次對其進行總結，此處先略過。spa

　　接下來對redis實現的分佈式鎖的邏輯代碼進行詳細的分析和理解：操作系統

　　一、爲避免特殊緣由致使鎖沒法釋放, 在加鎖成功後, 鎖會被賦予一個生存時間(經過 lock 方法的參數設置或者使用默認值), 超出生存時間鎖將被自動釋放.
　　二、鎖的生存時間默認比較短(秒級, 具體見 lock 方法), 所以若須要長時間加鎖, 能夠經過 expire 方法延長鎖的生存時間爲適當的時間. 好比在循環內調用 expire
　　三、系統級的鎖當進程不管由於任何緣由出現crash，操做系統會本身回收鎖，因此不會出現資源丟失。
　　四、但分佈式鎖不一樣。若一次性設置很長的時間，一旦因爲各類緣由進程 crash 或其餘異常致使 unlock 未被調用，則該鎖在剩下的時間就變成了垃圾鎖，致使其餘進程或進程重啓後沒法進入加鎖區域。

  1 <?php
  2 
  3 require_once 'RedisFactory.php';
  4 
  5 /**
  6 * 在 Redis 上實現的分佈式鎖
  7 */
  8 class RedisLock {
  9     //單例模式
 10     private static $_instance = null;
 11     public static function instance() {
 12         if(self::$_instance == null) {
 13             self::$_instance = new RedisLock();
 14         }
 15         return self::$_instance;
 16     }
 17 
 18     //redis對象變量
 19     private $redis;
 20     //存放被鎖的標誌名的數組
 21     private $lockedNames = array();
 22 
 23     public function __construct() {
 24         //獲取一個 RedisString 實例
 25         $this->redis = RedisFactory::instance()->getString();
 26     }
 27 
 28     /** 
 29     * 加鎖
 30     *
 31     * @param string 鎖的標識名
 32     * @param int 獲取鎖失敗時的等待超時時間(秒), 在此時間以內會一直嘗試獲取鎖直到超時. 爲 0 表示失敗後直接返回不等待
 33     * @param int 當前鎖的最大生存時間(秒), 必須大於 0 . 若是超過生存時間後鎖仍未被釋放, 則系統會自動將其強制釋放
 34     * @param int 獲取鎖失敗後掛起再試的時間間隔(微秒)
 35     */
 36     public function lock($name, $timeout = 0, $expire = 15, $waitIntervalUs = 100000) {
 37         if(empty($name)) return false;
 38 
 39         $timeout = (int)$timeout;
 40         $expire = max((int)$expire, 5);
 41         $now = microtime(true);
 42         $timeoutAt = $now + $timeout;
 43         $expireAt = $now + $expire;
 44 
 45         $redisKey = "Lock:$name";
 46         while(true) {
 47             $result = $this->redis->setnx($redisKey, (string)$expireAt);
 48             if($result !== false) {
 49                 //對$redisKey設置生存時間
 50                 $this->redis->expire($redisKey, $expire);
 51                 //將最大生存時刻記錄在一個數組裏面
 52                 $this->lockedNames[$name] = $expireAt;
 53                 return true;
 54             }
 55 
 56             //以秒爲單位，返回$redisKey 的剩餘生存時間
 57             $ttl = $this->redis->ttl($redisKey);
 58             // TTL 小於 0 表示 key 上沒有設置生存時間(key 不會不存在, 由於前面 setnx 會自動建立)
 59             // 若是出現這種狀況, 那就是進程在某個實例 setnx 成功後 crash 致使緊跟着的 expire 沒有被調用. 這時能夠直接設置 expire 並把鎖納爲己用
 60             if($ttl < 0) {
 61                 $this->redis->set($redisKey, (string)$expireAt, $expire);
 62                 $this->lockedNames[$name] = $expireAt;
 63                 return true;
 64             }
 65 
 66             // 設置了不等待或者已超時
 67             if($timeout <= 0 || microtime(true) > $timeoutAt) break;
 68 
 69             // 掛起一段時間再試
 70             usleep($waitIntervalUs);
 71         }
 72 
 73         return false;
 74     }
 75 
 76     /**
 77     * 給當前鎖增長指定的生存時間(秒), 必須大於 0
 78     *
 79     * @param string 鎖的標識名
 80     * @param int 生存時間(秒), 必須大於 0
 81     */
 82     public function expire($name, $expire) {
 83         if($this->isLocking($name)) {
 84             if($this->redis->expire("Lock:$name", max($expire, 1))) {
 85                 return true;
 86             }
 87         }
 88         return false;
 89     }
 90 
 91     /**
 92     * 判斷當前是否擁有指定名稱的鎖
 93     *
 94     * @param mixed $name
 95     */
 96     public function isLocking($name) {
 97         if(isset($this->lockedNames[$name])) {
 98             return (string)$this->lockedNames[$name] == (string)$this->redis->get("Lock:$name");
 99         }
100         return false;
101     }
102 
103     /**
104     * 釋放鎖
105     *
106     * @param string 鎖的標識名
107     */
108     public function unlock($name) {
109         if($this->isLocking($name)) {
110             if($this->redis->deleteKey("Lock:$name")) {
111                 unset($this->lockedNames[$name]);
112                 return true;
113             }
114         }
115         return false;
116     }
117 
118     /** 釋放當前已經獲取到的全部鎖 */
119     public function unlockAll() {
120         $allSuccess = true;
121         foreach($this->lockedNames as $name => $item) {
122             if(false === $this->unlock($name)) {
123                 $allSuccess = false;
124             }
125         }
126         return $allSuccess;
127     }
128 }