Redis分布式鎖的正確實現方式(Java版)__Java

                           Redis分布式鎖的正確實現方式(Java版)

分布式鎖一般有三種實現方式：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

這一種錯誤樣本就比較難以發現問題，而且實現也比較複雜。實現思路：使用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;  

        }  

    }