關於Redis分佈式鎖的一些研究和思考

前言

在微服務的架構設計之下，不少場景都會使用到Redis的分佈式鎖來實現服務可靠性

目的

爲了保證服務的可用咱們要知足最少如下4個條件：

1.互斥性，任何一個時刻只能有一個客戶端持有鎖 2.杜絕死鎖，當一個客戶端在持有鎖的期間崩潰而沒有主動解鎖，也能保證後續其餘客戶端能加鎖。 3.容錯性，只要有一個redis節點是正常的就不會存在不能加解鎖的狀況 4.加鎖解鎖要是同一個客戶端，不能有其餘人把鎖解了

代碼實現

常見代碼實現

錯誤代碼1

public class RedisTool { 
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; 
    }
    
    /** * 釋放分佈式鎖 
    ** @param jedis     Redis客戶端 
    * @param lockKey   鎖 
    * @param requestId 請求標識 
    * @return 是否釋放成功
    */
public static boolean releaseDistributedLock(JedisProxy jedisProxy, 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"; 
    Object result = jedisProxy.eval(script,  Collections.singletonList(lockKey), 
    Collections.singletonList(requestId)); 
    if (RELEASE_SUCCESS.equals(result)) {  
            return true; 
         }   
return false;
    }
}
複製代碼

咱們加鎖就一行代碼：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. 已有鎖存在，不作任何操做。

心細的童鞋就會發現了，咱們的加鎖代碼知足咱們可靠性裏描述的三個條件。首先，set()加入了NX參數，能夠保證若是已有key存在，則函數不會調用成功，也就是隻有一個客戶端能持有鎖，知足互斥性。其次，因爲咱們對鎖設置了過時時間，即便鎖的持有者後續發生崩潰而沒有解鎖，鎖也會由於到了過時時間而自動解鎖（即key被刪除），不會發生死鎖。最後，由於咱們將value賦值爲requestId，表明加鎖的客戶端請求標識，那麼在客戶端在解鎖的時候就能夠進行校驗是不是同一個客戶端。因爲咱們只考慮Redis單機部署的場景，因此容錯性咱們暫不考慮。

加鎖

常見錯誤1

比較常見的錯誤示例就是使用jedis.setnx()和jedis.expire()組合實現加鎖，代碼以下：

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); 
} 
}
複製代碼

setnx()方法做用就是SET IF NOT EXIST，expire()方法就是給鎖加一個過時時間。乍一看好像和前面的set()方法結果同樣，然而因爲這是兩條Redis命令，不具備原子性，若是程序在執行完setnx()以後忽然崩潰，致使鎖沒有設置過時時間。那麼將會發生死鎖。網上之因此有人這樣實現，是由於低版本的jedis並不支持多參數的set()方法。

常見錯誤2

這一種錯誤示例就比較難以發現問題，並且實現也比較複雜。實現思路：使用jedis.setnx()命令實現加鎖，其中key是鎖，value是鎖的過時時間。執行過程：1. 經過setnx()方法嘗試加鎖，若是當前鎖不存在，返回加鎖成功。2. 若是鎖已經存在則獲取鎖的過時時間，和當前時間比較，若是鎖已通過期，則設置新的過時時間，返回加鎖成功。代碼以下：

public static boolean wrongGetLock2(Jedis jedis, String lockKey, int expireTime) {
 long expires = System.currentTimeMillis() + expireTime; 
 String expiresStr = String.valueOf(expires);
 // 若是當前鎖不存在，返回加鎖成功
 
 if (jedis.setnx(lockKey, expiresStr) == 1) {
 return true;
 }
 // 若是鎖存在，獲取鎖的過時時間
 String currentValueStr = jedis.get(lockKey);
 
 if (currentValueStr != null && Long.parseLong(currentValueStr) < System.currentTimeMillis()) {
 
 // 鎖已過時，獲取上一個鎖的過時時間，並設置如今鎖的過時時間
 
 String oldValueStr = jedis.getSet(lockKey, expiresStr);
 
 if (oldValueStr != null && oldValueStr.equals(currentValueStr)) {
 // 考慮多線程併發的狀況，只有一個線程的設置值和當前值相同，它纔有權利加鎖
 return true;
 }
 }
 // 其餘狀況，一概返回加鎖失敗
 return false;
}
複製代碼

那麼這段代碼問題在哪裏？1. 因爲是客戶端本身生成過時時間，因此須要強制要求分佈式下每一個客戶端的時間必須同步。 2. 當鎖過時的時候，若是多個客戶端同時執行jedis.getSet()方法，那麼雖然最終只有一個客戶端能夠加鎖，可是這個客戶端的鎖的過時時間可能被其餘客戶端覆蓋。3. 鎖不具有擁有者標識，即任何客戶端均可以解鎖。

解鎖

常見錯誤1

最多見的解鎖代碼就是直接使用jedis.del()方法刪除鎖，這種不先判斷鎖的擁有者而直接解鎖的方式，會致使任何客戶端均可以隨時進行解鎖，即便這把鎖不是它的。

public static void wrongReleaseLock1(Jedis jedis, String lockKey) {
    jedis.del(lockKey);
}
複製代碼

常見錯誤2

這種解鎖代碼乍一看也是沒問題，甚至我以前也差點這樣實現，與正確姿式差很少，惟一區別的是分紅兩條命令去執行，代碼以下：

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的鎖給解除了。

總結

本文主要介紹瞭如何使用Java代碼正確實現Redis分佈式鎖，對於加鎖和解鎖也分別給出了兩個比較經典的錯誤示例。其實想要經過Redis實現分佈式鎖並不難，只要保證能知足可靠性裏的四個條件。互聯網雖然給咱們帶來了方便，只要有問題就能夠google，然而網上的答案必定是對的嗎？其實否則，因此咱們更應該時刻保持着質疑精神，多想多驗證。