Redis分散式鎖加鎖案例

FH-Admin發表於2021-12-17
Redis分散式

1. 元件依賴

首先我們要透過Maven引入Jedis開源元件，在pom.xml檔案加入下面的程式碼：

<dependency>

    <groupId>redis.clients</groupId>

    <artifactId>jedis</artifactId>

    <version>2.9.0</version>

</dependency>

2. 加鎖程式碼

先展示程式碼，再帶大家慢慢解釋為什麼這樣實現：

//java專案 fhadmin.cn
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";

    /**java專案 fhadmin.cn
     * 嘗試獲取分散式鎖
     * @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;

    }

}

可以看到，我們加鎖就一行程式碼：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單機部署的場景，所以容錯性我們暫不考慮。

3. 錯誤示例1

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

//java專案 fhadmin.cn
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()方法。

4. 錯誤示例2

這一種錯誤示例就比較難以發現問題，而且實現也比較複雜。實現思路：使用jedis.setnx()命令實現加鎖，其中key是鎖，value是鎖的過期時間。

執行過程：1. 透過setnx()方法嘗試加鎖，如果當前鎖不存在，返回加鎖成功。2. 如果鎖已經存在則獲取鎖的過期時間，和當前時間比較，如果鎖已經過期，則設定新的過期時間，返回加鎖成功。

程式碼如下

//java專案 fhadmin.cn
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、鎖不具備擁有者標識，即任何客戶端都可以解鎖。

本作品採用《CC 協議》，轉載必須註明作者和本文連結

相關文章