實現思路
1.Redis實現分散式鎖思路
思路很簡單,主要用到的redis函式是setnx(),這個應該是實現分散式鎖最主要的函式。首先是將某一任務標識名(這裡用Lock:order作為標識名的例子)作為鍵存到redis裡,併為其設個過期時間,如果是還有Lock:order請求過來,先是通過setnx()看看是否能將Lock:order插入到redis裡,可以的話就返回true,不可以就返回false。當然,在我的程式碼裡會比這個思路複雜一些,我會在分析程式碼時進一步說明。
2.Redis實現任務佇列
這裡的實現會用到上面的Redis分散式的鎖機制,主要是用到了Redis裡的有序集合這一資料結構。例如入隊時,通過zset的add()函式進行入隊,而出隊時,可以用到zset的getScore()函式。另外還可以彈出頂部的幾個任務。
以上就是實現 分散式鎖 和 任務佇列 的簡單思路,如果你看完有點模稜兩可,那請看接下來的程式碼實現。
程式碼分析
(一)先來分析Redis分散式鎖的程式碼實現
(1)為避免特殊原因導致鎖無法釋放,在加鎖成功後,鎖會被賦予一個生存時間(通過lock方法的引數設定或者使用預設值),超出生存時間鎖會被自動釋放鎖的生存時間預設比較短(秒級),因此,若需要長時間加鎖,可以通過expire方法延長鎖的生存時間為適當時間,比如在迴圈內。
(2)系統級的鎖當程式無論何種原因時出現crash時,作業系統會自己回收鎖,所以不會出現資源丟失,但分散式鎖不用,若一次性設定很長時間,一旦由於各種原因出現程式crash 或者其他異常導致unlock未被呼叫時,則該鎖在剩下的時間就會變成垃圾鎖,導致其他程式或者程式重啟後無法進入加鎖區域。
先看加鎖的實現程式碼:這裡需要主要兩個引數,一個是$timeout,這個是迴圈獲取鎖的等待時間,在這個時間內會一直嘗試獲取鎖知道超時,如果為0,則表示獲取鎖失敗後直接返回而不再等待;另一個重要引數的$expire,這個引數指當前鎖的最大生存時間,以秒為單位的,它必須大於0,如果超過生存時間鎖仍未被釋放,則系統會自動強制釋放。這個引數的最要作用請看上面的(1)裡的解釋。
這裡先取得當前時間,然後再獲取到鎖失敗時的等待超時的時刻(是個時間戳),再獲取到鎖的最大生存時刻是多少。這裡redis的key用這種格式:”Lock:鎖的標識名”,這裡就開始進入迴圈了,先是插入資料到redis裡,使用setnx()函式,這函式的意思是,如果該鍵不存在則插入資料,將最大生存時刻作為值儲存,假如插入成功,則對該鍵進行失效時間的設定,並將該鍵放在$lockedName陣列裡,返回true,也就是上鎖成功;如果該鍵存在,則不會插入操作了,這裡有一步嚴謹的操作,那就是取得當前鍵的剩餘時間,假如這個時間小於0,表示key上沒有設定生存時間(key是不會不存在的,因為前面setnx會自動建立)如果出現這種狀況,那就是程式的某個例項setnx成功後 crash 導致緊跟著的expire沒有被呼叫,這時可以直接設定expire並把鎖納為己用。如果沒設定鎖失敗的等待時間 或者 已超過最大等待時間了,那就退出迴圈,反之則 隔 $waitIntervalUs 後繼續 請求。 這就是加鎖的整一個程式碼分析。
/**
* 加鎖
* @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;
}
接著看解鎖的程式碼分析:解鎖就簡單多了,傳入引數就是鎖標識,先是判斷是否存在該鎖,存在的話,就從redis裡面通過deleteKey()函式刪除掉鎖標識即可。
/**
* 解鎖
* @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;
}
以上就是用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;
}
}