轉(zhuǎn)載：https://wudashan.cn/2017/10/23/Redis-Distributed-Lock-Implement/

前言

分布式鎖一般有三種實(shí)現(xiàn)方式：

1. 數(shù)據(jù)庫樂觀鎖；
2. 基于 Redis 的分布式鎖；
3. 基于 ZooKeeper 的分布式鎖。

本篇博客將介紹第二種方式，基于 Redis 實(shí)現(xiàn)分布式鎖。雖然網(wǎng)上已經(jīng)有各種介紹 Redis 分布式鎖實(shí)現(xiàn)的博客，然而他們的實(shí)現(xiàn)卻有著各種各樣的問題，為了避免誤人子弟，本篇博客將詳細(xì)介紹如何正確地實(shí)現(xiàn) Redis 分布式鎖。

可靠性

首先，為了確保分布式鎖可用，我們至少要確保鎖的實(shí)現(xiàn)同時(shí)滿足以下四個(gè)條件：

1. 互斥性。在任意時(shí)刻，只有一個(gè)客戶端能持有鎖。
2. 不會(huì)發(fā)生死鎖。即使有一個(gè)客戶端在持有鎖的期間崩潰而沒有主動(dòng)解鎖，也能保證后續(xù)其他客戶端能加鎖。
3. 具有容錯(cuò)性。只要大部分的 Redis 節(jié)點(diǎn)正常運(yùn)行，客戶端就可以加鎖和解鎖。
4. 解鈴還須系鈴人。加鎖和解鎖必須是同一個(gè)客戶端，客戶端自己不能把別人加的鎖給解了。

代碼實(shí)現(xiàn)

組件依賴

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

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

加鎖代碼

正確姿勢(shì)

Talk is cheap, show me the code。先展示代碼，再帶大家慢慢解釋為什么這樣實(shí)現(xiàn)：

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 請(qǐng)求標(biāo)識(shí)
     * @param expireTime 超期時(shí)間
     * @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)，這個(gè) set()方法一共有五個(gè)形參：

• 第一個(gè)為 key，我們使用 key 來當(dāng)鎖，因?yàn)?key 是唯一的。

• 第二個(gè)為 value，我們傳的是 requestId，很多童鞋可能不明白，有 key 作為鎖不就夠了嗎，為什么還要用到 value？原因就是我們?cè)谏厦嬷v到可靠性時(shí)，分布式鎖要滿足第四個(gè)條件解鈴還須系鈴人，通過給 value 賦值為 requestId，我們就知道這把鎖是哪個(gè)請(qǐng)求加的了，在解鎖的時(shí)候就可以有依據(jù)。requestId 可以使用 UUID.randomUUID().toString()方法生成。

• 第三個(gè)為 nxxx，這個(gè)參數(shù)我們填的是 NX，意思是 SET IF NOT EXIST，即當(dāng) key 不存在時(shí)，我們進(jìn)行 set 操作；若 key 已經(jīng)存在，則不做任何操作；

• 第四個(gè)為 expx，這個(gè)參數(shù)我們傳的是 PX，意思是我們要給這個(gè) key 加一個(gè)過期的設(shè)置，具體時(shí)間由第五個(gè)參數(shù)決定。

• 第五個(gè)為 time，與第四個(gè)參數(shù)相呼應(yīng)，代表 key 的過期時(shí)間。

總的來說，執(zhí)行上面的 set()方法就只會(huì)導(dǎo)致兩種結(jié)果：

1. 當(dāng)前沒有鎖（key 不存在），那么就進(jìn)行加鎖操作，并對(duì)鎖設(shè)置個(gè)有效期，同時(shí) value 表示加鎖的客戶端。
2. 已有鎖存在，不做任何操作。

心細(xì)的童鞋就會(huì)發(fā)現(xiàn)了，我們的加鎖代碼滿足我們可靠性里描述的三個(gè)條件。首先，set()加入了 NX 參數(shù)，可以保證如果已有 key 存在，則函數(shù)不會(huì)調(diào)用成功，也就是只有一個(gè)客戶端能持有鎖，滿足互斥性。其次，由于我們對(duì)鎖設(shè)置了過期時(shí)間，即使鎖的持有者后續(xù)發(fā)生崩潰而沒有解鎖，鎖也會(huì)因?yàn)榈搅诉^期時(shí)間而自動(dòng)解鎖（即 key 被刪除），不會(huì)發(fā)生死鎖。最后，因?yàn)槲覀儗?value 賦值為 requestId，代表加鎖的客戶端請(qǐng)求標(biāo)識(shí)，那么在客戶端在解鎖的時(shí)候就可以進(jìn)行校驗(yàn)是否是同一個(gè)客戶端。由于我們只考慮 Redis 單機(jī)部署的場(chǎng)景，所以容錯(cuò)性我們暫不考慮。

錯(cuò)誤示例 1

比較常見的錯(cuò)誤示例就是使用 jedis.setnx()和 jedis.expire()組合實(shí)現(xiàn)加鎖，代碼如下：

public static void wrongGetLock1(Jedis jedis, String lockKey, String requestId, int expireTime) {

    Long result = jedis.setnx(lockKey, requestId);
    if (result == 1) {
        // 若在這里程序突然崩潰，則無法設(shè)置過期時(shí)間，將發(fā)生死鎖
        jedis.expire(lockKey, expireTime);
    }

}

setnx()方法作用就是 SET IF NOT EXIST，expire()方法就是給鎖加一個(gè)過期時(shí)間。乍一看好像和前面的 set()方法結(jié)果一樣，然而由于這是兩條 Redis 命令，不具有原子性，如果程序在執(zhí)行完 setnx()之后突然崩潰，導(dǎo)致鎖沒有設(shè)置過期時(shí)間。那么將會(huì)發(fā)生死鎖。網(wǎng)上之所以有人這樣實(shí)現(xiàn)，是因?yàn)榈桶姹镜?jedis 并不支持多參數(shù)的 set()方法。

錯(cuò)誤示例 2

這一種錯(cuò)誤示例就比較難以發(fā)現(xiàn)問題，而且實(shí)現(xiàn)也比較復(fù)雜。

實(shí)現(xiàn)思路：使用 jedis.setnx()命令實(shí)現(xiàn)加鎖，其中 key 是鎖，value 是鎖的過期時(shí)間。

執(zhí)行過程:

1. 通過 setnx()方法嘗試加鎖，如果當(dāng)前鎖不存在，返回加鎖成功。
2. 如果鎖已經(jīng)存在則獲取鎖的過期時(shí)間，和當(dāng)前時(shí)間比較，如果鎖已經(jīng)過期，則設(shè)置新的過期時(shí)間，返回加鎖成功。

代碼如下：

public static boolean wrongGetLock2(Jedis jedis, String lockKey, int expireTime) {

    long expires = System.currentTimeMillis() + expireTime;
    String expiresStr = String.valueOf(expires);

    // 如果當(dāng)前鎖不存在，返回加鎖成功
    if (jedis.setnx(lockKey, expiresStr) == 1) {
        return true;
    }

    // 如果鎖存在，獲取鎖的過期時(shí)間
    String currentValueStr = jedis.get(lockKey);
    if (currentValueStr != null && Long.parseLong(currentValueStr) < System.currentTimeMillis()) {
        // 鎖已過期，獲取上一個(gè)鎖的過期時(shí)間，并設(shè)置現(xiàn)在鎖的過期時(shí)間
        String oldValueStr = jedis.getSet(lockKey, expiresStr);
        if (oldValueStr != null && oldValueStr.equals(currentValueStr)) {
            // 考慮多線程并發(fā)的情況，只有一個(gè)線程的設(shè)置值和當(dāng)前值相同，它才有權(quán)利加鎖
            return true;
        }
    }
        
    // 其他情況，一律返回加鎖失敗
    return false;
}

那么這段代碼問題在哪里？

1. 由于是客戶端自己生成過期時(shí)間，所以需要強(qiáng)制要求分布式下每個(gè)客戶端的時(shí)間必須同步。
2. 當(dāng)鎖過期的時(shí)候，如果多個(gè)客戶端同時(shí)執(zhí)行 jedis.getSet()方法，那么雖然最終只有一個(gè)客戶端可以加鎖，但是這個(gè)客戶端的鎖的過期時(shí)間可能被其他客戶端覆蓋。
3. 鎖不具備擁有者標(biāo)識(shí)，即任何客戶端都可以解鎖。

解鎖代碼

正確姿勢(shì)

還是先展示代碼，再帶大家慢慢解釋為什么這樣實(shí)現(xiàn)：

public class RedisTool {

    private static final Long RELEASE_SUCCESS = 1L;

    /**
     * 釋放分布式鎖
     * @param jedis Redis客戶端
     * @param lockKey 鎖
     * @param requestId 請(qǐng)求標(biāo)識(shí)
     * @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;
    }
}

可以看到，我們解鎖只需要兩行代碼就搞定了！第一行代碼，我們寫了一個(gè)簡(jiǎn)單的 Lua 腳本代碼，上一次見到這個(gè)編程語言還是在《黑客與畫家》里，沒想到這次居然用上了。第二行代碼，我們將 Lua 代碼傳到 jedis.eval()方法里，并使參數(shù) KEYS[1]賦值為 lockKey，ARGV[1]賦值為 requestId。

eval()方法是將 Lua 代碼交給 Redis 服務(wù)端執(zhí)行。

那么這段 Lua 代碼的功能是什么呢？

其實(shí)很簡(jiǎn)單，首先獲取鎖對(duì)應(yīng)的 value 值，檢查是否與 requestId 相等，如果相等則刪除鎖（解鎖）。那么為什么要使用 Lua 語言來實(shí)現(xiàn)呢？因?yàn)橐_保上述操作是原子性的。關(guān)于非原子性會(huì)帶來什么問題，可以閱讀【解鎖代碼-錯(cuò)誤示例 2】 。那么為什么執(zhí)行 eval()方法可以確保原子性，源于 Redis 的特性，下面是官網(wǎng)對(duì) eval 命令的部分解釋：

簡(jiǎn)單來說，就是在 eval 命令執(zhí)行 Lua 代碼的時(shí)候，Lua 代碼將被當(dāng)成一個(gè)命令去執(zhí)行，并且直到 eval 命令執(zhí)行完成，Redis 才會(huì)執(zhí)行其他命令。

錯(cuò)誤示例 1

最常見的解鎖代碼就是直接使用 jedis.del()方法刪除鎖，這種不先判斷鎖的擁有者而直接解鎖的方式，會(huì)導(dǎo)致任何客戶端都可以隨時(shí)進(jìn)行解鎖，即使這把鎖不是它的。

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

<span id="wrongDemo2">錯(cuò)誤示例 2</span>

這種解鎖代碼乍一看也是沒問題，甚至我之前也差點(diǎn)這樣實(shí)現(xiàn)，與正確姿勢(shì)差不多，唯一區(qū)別的是分成兩條命令去執(zhí)行，代碼如下：

public static void wrongReleaseLock2(Jedis jedis, String lockKey, String requestId) {
        
    // 判斷加鎖與解鎖是不是同一個(gè)客戶端
    if (requestId.equals(jedis.get(lockKey))) {
        // 若在此時(shí)，這把鎖突然不是這個(gè)客戶端的，則會(huì)誤解鎖
        jedis.del(lockKey);
    }
}

如代碼注釋，問題在于如果調(diào)用 jedis.del()方法的時(shí)候，這把鎖已經(jīng)不屬于當(dāng)前客戶端的時(shí)候會(huì)解除他人加的鎖。那么是否真的有這種場(chǎng)景？答案是肯定的，比如客戶端 A 加鎖，一段時(shí)間之后客戶端 A 解鎖，在執(zhí)行 jedis.del()之前，鎖突然過期了，此時(shí)客戶端 B 嘗試加鎖成功，然后客戶端 A 再執(zhí)行 del()方法，則將客戶端 B 的鎖給解除了。

總結(jié)

本文主要介紹了如何使用 Java 代碼正確實(shí)現(xiàn) Redis 分布式鎖，對(duì)于加鎖和解鎖也分別給出了兩個(gè)比較經(jīng)典的錯(cuò)誤示例。其實(shí)想要通過 Redis 實(shí)現(xiàn)分布式鎖并不難，只要保證能滿足可靠性里的四個(gè)條件?；ヂ?lián)網(wǎng)雖然給我們帶來了方便，只要有問題就可以 google，然而網(wǎng)上的答案一定是對(duì)的嗎？其實(shí)不然，所以我們更應(yīng)該時(shí)刻保持著質(zhì)疑精神，多想多驗(yàn)證。

如果你的項(xiàng)目中 Redis 是多機(jī)部署的，那么可以嘗試使用 Redisson 實(shí)現(xiàn)分布式鎖，這是 Redis 官方提供的 Java 組件，鏈接在參考閱讀章節(jié)已經(jīng)給出。

<span id="cankao">參考閱讀</span>

[1] Distributed locks with Redis

[2] EVAL command

[3] Redisson