前言

分散式鎖一般有三種實現方式：1. 資料庫樂觀鎖；2. 基於Redis的分散式鎖；3. 基於ZooKeeper的分散式鎖。本篇部落格將介紹第二種方式，基於Redis實現分散式鎖。雖然網上已經有各種介紹Redis分散式鎖實現的部落格，然而他們的實現卻有著各種各樣的問題，為了避免誤人子弟，本篇部落格將詳細介紹如何正確地實現Redis分散式鎖。

可靠性

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

1. 互斥性。在任意時刻，只有一個客戶端能持有鎖。
2. 不會發生死鎖。即使有一個客戶端在持有鎖的期間崩潰而沒有主動解鎖，也能保證後續其他客戶端能加鎖。
3. 具有容錯性。只要大部分的Redis節點正常執行，客戶端就可以加鎖和解鎖。
4. 解鈴還須繫鈴人。加鎖和解鎖必須是同一個客戶端，客戶端自己不能把別人加的鎖給解了。

程式碼實現

元件依賴

首先我們要通過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語言來實現呢？因為要確保上述操作是原子性的。 。那麼為什麼執行eval()方法可以確保原子性，源於Redis的特性

簡單來說，就是在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元件。