分佈式鎖一般有三種實現方式:
1. 數據庫樂觀鎖;
2. 基於Redis的分佈式鎖;
3. 基於ZooKeeper的分佈式鎖。
本篇博客將介紹第二種方式,基於Redis實現分佈式鎖。
爲確保分佈式鎖可用,必須滿足以下四個條件:
1.互斥性。
PS:在任意時刻,只有一個客戶端能持有鎖.
2.不會發生死鎖
PS:即使有一個客戶端在持有鎖的期間崩潰而沒有主動解鎖,也能保證後續其他客戶端能加鎖。
3.具有容錯性
PS:只要大部分的Redis節點正常運行,客戶端就可以加鎖和解鎖。
4.解鈴還須繫鈴人
PS:加鎖和解鎖必須是同一個客戶端,客戶端自己不能把別人加的鎖給解了。
接下來就是實操:
maven 引用 包
<dependency>
<groupId>redis.clients</groupId>
<artifactId>jedis</artifactId>
<version>2.9.0</version>
</dependency>
第一步加鎖
private static final String LOCK_SUCCESS = "OK";
private static final String SET_IF_NOT_EXIST = "NX";
private static final String SET_WITH_EXPIRE_TIME = "PX";
/**
* 嘗試獲取分佈式鎖
* @param jedis Redis客戶端
* @param lockKey 鎖
* @param requestId 請求標識
* @param expireTime 超期時間
* @return 是否獲取成功
*/
public static boolean tryGetDistributedLock(Jedis jedis, String lockKey, String requestId, int expireTime) {
String result = jedis.set(lockKey, requestId, SET_IF_NOT_EXIST, SET_WITH_EXPIRE_TIME, expireTime);
if (LOCK_SUCCESS.equals(result)) {
return true;
}
return false;
}
解讀下
-
第一個爲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. 已有鎖存在,不做任何操作。
以上加鎖代碼滿足我們可靠性裏描述的三個條件。
首先,set()加入了NX參數,可以保證如果已有key存在,則函數不會調用成功,也就是隻有一個客戶端能持有鎖,滿足互斥性。其次,由於我們對鎖設置了過期時間,即使鎖的持有者後續發生崩潰而沒有解鎖,鎖也會因爲到了過期時間而自動解鎖(即key被刪除),不會發生死鎖。
最後,因爲我們將value賦值爲requestId,代表加鎖的客戶端請求標識,那麼在客戶端在解鎖的時候就可以進行校驗是否是同一個客戶端。由於我們只考慮Redis單機部署的場景,所以容錯性我們暫不考慮。
舉例下常見的錯誤加鎖方式
public static void wrongGetLock1(Jedis jedis, String lockKey, String requestId, int expireTime) {
Long result = jedis.setnx(lockKey, requestId);
if (result == 1) {
// 若在這裏程序突然崩潰,則無法設置過期時間,將發生死鎖
jedis.expire(lockKey, expireTime);
}
}
原因:這是兩條Redis命令,不具有原子性,如果程序在執行完setnx()之後突然崩潰,導致鎖沒有設置過期時間。那麼將會發生死鎖。網上之所以有人這樣實現,是因爲低版本的jedis並不支持多參數的set()方法。
第二步解鎖
private static final Long RELEASE_SUCCESS = 1L;
/**
* 釋放分佈式鎖
* @param jedis Redis客戶端
* @param lockKey 鎖
* @param requestId 請求標識
* @return 是否釋放成功
*/
public static boolean releaseDistributedLock(Jedis jedis, String lockKey, String requestId) {
String script = "if redis.call('get', KEYS[1]) == ARGV[1] then return redis.call('del', KEYS[1]) else return 0 end";
//eval()方法可以確保原子性
//官網解讀 在eval命令執行Lua代碼的時候,Lua代碼將被當成一個命令去執行,並且直到eval命令執行完成,Redis纔會執行其他命令
Object result = jedis.eval(script, Collections.singletonList(lockKey), Collections.singletonList(requestId));
if (RELEASE_SUCCESS.equals(result)) {
return true;
}
return false;
}
以上代碼我們寫了一個簡單的Lua腳本代碼,我們將Lua代碼傳到jedis.eval()
方法裏,並使參數KEYS[1]賦值爲lockKey,ARGV[1]賦值爲requestId。eval()方法是將Lua代碼交給Redis服務端執行。
那麼這段Lua代碼的功能是什麼呢?其實很簡單,首先獲取鎖對應的value值,檢查是否與requestId相等,如果相等則刪除鎖(解鎖)。那麼爲什麼要使用Lua語言來實現呢?因爲要確保上述操作是原子性的。
其他:儘量減少 jedis.del() 解鎖
比較常見錯誤的解鎖方式:
public static void wrongReleaseLock1(Jedis jedis, String lockKey) {
jedis.del(lockKey);
}
這種不先判斷鎖的擁有者而直接解鎖的方式,會導致任何客戶端都可以隨時進行解鎖,即使這把鎖不是它的。
public static void wrongReleaseLock2(Jedis jedis, String lockKey, String requestId) {
// 判斷加鎖與解鎖是不是同一個客戶端
if (requestId.equals(jedis.get(lockKey))) {
// 若在此時,這把鎖突然不是這個客戶端的,則會誤解鎖
jedis.del(lockKey);
}
}
這種方式問題在於如果調用jedis.del()
方法的時候,這把鎖已經不屬於當前客戶端的時候會解除他人加的鎖。那麼是否真的有這種場景?答案是肯定的,比如客戶端A加鎖,一段時間之後客戶端A解鎖,在執行jedis.del()
之前,鎖突然過期了,此時客戶端B嘗試加鎖成功,然後客戶端A再執行del()方法,則將客戶端B的鎖給解除了。
總結:
Redis實現分佈式鎖並不難,只要保證能滿足可靠性裏的四個條件。
如果你的項目中Redis是多機部署的,那麼可以嘗試使用Redisson
實現分佈式鎖,這是Redis官方提供的Java組件
參考閱讀章節
-
Distributed locks with Redis
-
EVAL command
-
Redisson
。