Redis分布式鎖的正确實作方式（基礎）

Redis分布式鎖的正确實作方式

前言

分布式鎖一般有三種實作方式：

1. 資料庫樂觀鎖；
2. 基于Redis的分布式鎖；

3. 基于ZooKeeper的分布式鎖。

   本篇部落格将介紹第二種方式，基于Redis實作分布式鎖。雖然網上已經有各種介紹Redis分布式鎖實作的部落格，然而他們的實作卻有着各種各樣的問題，為了避免誤人子弟，本篇部落格将詳細介紹如何正确地實作Redis分布式鎖。

可靠性

首先，為了確定分布式鎖可用，我們至少要確定鎖的實作同時滿足以下四個條件：

互斥性。

在任意時刻，隻有一個用戶端能持有鎖。

不會發生死鎖

即使有一個用戶端在持有鎖的期間崩潰而沒有主動解鎖，也能保證後續其他用戶端能加鎖。

具有容錯性

隻要大部分的Redis節點正常運作，用戶端就可以加鎖和解鎖。

解鈴還須系鈴人

加鎖和解鎖必須是同一個用戶端，用戶端自己不能把别人加的鎖給解了。

元件依賴

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

<dependency>
    <groupId>redis.clients</groupId>
    <artifactId>jedis</artifactId>
    <version>2.9.0</version>
</dependency>
           

加鎖代碼

正确姿勢

Talk is cheap, show me the code。先展示代碼，再帶大家慢慢解釋為什麼這樣實作：

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;

    }

}
           

可以看到，我們加鎖就一行代碼：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

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;

}
           

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

那麼這段代碼問題在哪裡？1. 由于是用戶端自己生成過期時間，是以需要強制要求分布式下每個用戶端的時間必須同步。 2. 當鎖過期的時候，如果多個用戶端同時執行jedis.getSet()方法，那麼雖然最終隻有一個用戶端可以加鎖，但是這個用戶端的鎖的過期時間可能被其他用戶端覆寫。3. 鎖不具備擁有者辨別，即任何用戶端都可以解鎖。

解鎖代碼

正确姿勢

還是先展示代碼，再帶大家慢慢解釋為什麼這樣實作：

public class RedisTool {

    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";
        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語言來實作呢？因為要確定上述操作是原子性的。關于非原子性會帶來什麼問題，可以閱讀【解鎖代碼-錯誤示例2】 。那麼為什麼執行eval()方法可以確定原子性，源于Redis的特性，下面是官網對eval指令的部分解釋：

簡單來說，就是在eval指令執行Lua代碼的時候，Lua代碼将被當成一個指令去執行，并且直到eval指令執行完成，Redis才會執行其他指令。

錯誤示例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，然而網上的答案一定是對的嗎？其實不然，是以我們更應該時刻保持着質疑精神，多想多驗證。

如果你的項目中Redis是多機部署的，那麼可以嘗試使用Redisson實作分布式鎖，這是Redis官方提供的Java元件，連結在參考閱讀章節已經給出。