分佈式鎖一般有三種實現方式:
1、數據庫樂觀鎖;
2、基於Redis的分佈式鎖;
3、基於ZooKeeper的分佈式鎖。
本文將介紹第二種方式,基於Redis實現分佈式鎖。雖然網上已經有各種介紹Redis分佈式鎖實現的博客,然而他們的實現卻有着各種各樣的問題,爲了避免誤人子弟,本篇博客將詳細介紹如何正確地實現Redis分佈式鎖。
可靠性
首先,爲了確保分佈式鎖可用,我們至少要確保鎖的實現同時滿足以下四個條件:
1、互斥性。在任意時刻,只有一個客戶端能持有鎖。
2、不會發生死鎖。即使有一個客戶端在持有鎖的期間崩潰而沒有主動解鎖,也能保證後續其他客戶端能加鎖。
3、具有容錯性。只要大部分的Redis節點正常運行,客戶端就可以加鎖和解鎖。
4、解鈴還須繫鈴人。加鎖和解鎖必須是同一個客戶端,客戶端自己不能把別人加的鎖給解了。
代碼實現
組件依賴
首先我們要通過Maven引入Jedis開源組件,在pom.xml文件加入下面的代碼:
1 2 3 4 5 |
|
加鎖代碼
正確姿勢
Talk is cheap, show me the code。先展示代碼,再帶大家慢慢解釋爲什麼這樣實現:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 |
|
可以看到,我們加鎖就一行代碼:jedis.set(String key, String value, String nxxx, String expx, int time),這個set()方法一共有五個形參:
第一個爲key,我們使用key來當鎖,因爲key是唯一的。
第二個爲value,我們傳的是requestId,很多童鞋可能不明白,有key作爲鎖不就夠了嗎,爲什麼還要用到value?原因就是我們在上面講到可靠性時,分佈式鎖要滿足第四個條件解鈴還須繫鈴人,通過給value賦值爲requestId,我們就知道這把鎖是哪個請求加的了,在解鎖的時候就可以有依據。requestId可以使用UUID.randomUUID().toString()方法生成。
第三個爲nxxx,這個參數我們填的是NX,意思是SET IF NOT EXIST,即當key不存在時,我們進行set操作;若key已經存在,則不做任何操作;
第四個爲expx,這個參數我們傳的是PX,意思是我們要給這個key加一個過期的設置,具體時間由第五個參數決定。
第五個爲time,與第四個參數相呼應,代表key的過期時間。
總的來說,執行上面的set()方法就只會導致兩種結果:1. 當前沒有鎖(key不存在),那麼就進行加鎖操作,並對鎖設置個有效期,同時value表示加鎖的客戶端。2. 已有鎖存在,不做任何操作。
心細的童鞋就會發現了,我們的加鎖代碼滿足我們可靠性裏描述的三個條件:
1、首先,set()加入了NX參數,可以保證如果已有key存在,則函數不會調用成功,也就是隻有一個客戶端能持有鎖,滿足互斥性。
2、其次,由於我們對鎖設置了過期時間,即使鎖的持有者後續發生崩潰而沒有解鎖,鎖也會因爲到了過期時間而自動解鎖(即key被刪除),不會發生死鎖。
3、最後,因爲我們將value賦值爲requestId,代表加鎖的客戶端請求標識,那麼在客戶端在解鎖的時候就可以進行校驗是否是同一個客戶端。由於我們只考慮Redis單機部署的場景,所以容錯性我們暫不考慮。
錯誤示例1
比較常見的錯誤示例就是使用jedis.setnx()和jedis.expire()組合實現加鎖,代碼如下:
1 2 3 4 5 6 7 8 9 |
|
setnx()方法作用就是SET IF NOT EXIST,expire()方法就是給鎖加一個過期時間。乍一看好像和前面的set()方法結果一樣,然而由於這是兩條Redis命令,不具有原子性,如果程序在執行完setnx()之後突然崩潰,導致鎖沒有設置過期時間。那麼將會發生死鎖。網上之所以有人這樣實現,是因爲低版本的jedis並不支持多參數的set()方法。
錯誤示例2
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 |
|
這一種錯誤示例就比較難以發現問題,而且實現也比較複雜。實現思路:使用jedis.setnx()命令實現加鎖,其中key是鎖,value是鎖的過期時間。
執行過程:
1、通過setnx()方法嘗試加鎖,如果當前鎖不存在,返回加鎖成功。
2、如果鎖已經存在則獲取鎖的過期時間,和當前時間比較,如果鎖已經過期,則設置新的過期時間,返回加鎖成功。代碼如下:
那麼這段代碼問題在哪裏?
1、由於是客戶端自己生成過期時間,所以需要強制要求分佈式下每個客戶端的時間必須同步。
2、當鎖過期的時候,如果多個客戶端同時執行jedis.getSet()方法,那麼雖然最終只有一個客戶端可以加鎖,但是這個客戶端的鎖的過期時間可能被其他客戶端覆蓋。
3、鎖不具備擁有者標識,即任何客戶端都可以解鎖。
解鎖代碼
正確姿勢
還是先展示代碼,再帶大家慢慢解釋爲什麼這樣實現:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 |
|
可以看到,我們解鎖只需要兩行代碼就搞定了!第一行代碼,我們寫了一個簡單的Lua腳本代碼,上一次見到這個編程語言還是在《黑客與畫家》裏,沒想到這次居然用上了。第二行代碼,我們將Lua代碼傳到jedis.eval()方法裏,並使參數KEYS[1]賦值爲lockKey,ARGV[1]賦值爲requestId。eval()方法是將Lua代碼交給Redis服務端執行。
那麼這段Lua代碼的功能是什麼呢?其實很簡單,首先獲取鎖對應的value值,檢查是否與requestId相等,如果相等則刪除鎖(解鎖)。那麼爲什麼要使用Lua語言來實現呢?因爲要確保上述操作是原子性的。關於非原子性會帶來什麼問題,可以閱讀【解鎖代碼-錯誤示例2】 。
那麼爲什麼執行eval()方法可以確保原子性,源於Redis的特性,下面是官網對eval命令的部分解釋:
簡單來說,就是在eval命令執行Lua代碼的時候,Lua代碼將被當成一個命令去執行,並且直到eval命令執行完成,Redis纔會執行其他命令。
錯誤示例1
最常見的解鎖代碼就是直接使用jedis.del()方法刪除鎖,這種不先判斷鎖的擁有者而直接解鎖的方式,會導致任何客戶端都可以隨時進行解鎖,即使這把鎖不是它的。
1 2 3 |
|
錯誤示例2
這種解鎖代碼乍一看也是沒問題,甚至我之前也差點這樣實現,與正確姿勢差不多,唯一區別的是分成兩條命令去執行,代碼如下:
1 2 3 4 5 6 7 8 9 |
|
如代碼註釋,問題在於如果調用jedis.del()方法的時候,這把鎖已經不屬於當前客戶端的時候會解除他人加的鎖。那麼是否真的有這種場景?答案是肯定的,比如客戶端A加鎖,一段時間之後客戶端A解鎖,在執行jedis.del()之前,鎖突然過期了,此時客戶端B嘗試加鎖成功,然後客戶端A再執行del()方法,則將客戶端B的鎖給解除了。