Redis分布式鎖的正確實現(xiàn)方式（Java版）
注：有空看看小編：CodeCow · 程序牛 的個人技術(shù)博客吧：http://www.codecow.cn/
《 你見切距，或者不見我牛隅，我就在那里 —— 不悲不喜 》

本文轉(zhuǎn)載于：https://blog.csdn.net/yb223731/article/details/90349502

一、什么是分布式鎖壹哺？

要介紹分布式鎖，首先要提到與分布式鎖相對應(yīng)的是線程鎖、進程鎖。

線程鎖：主要用來給方法妖滔、代碼塊加鎖。當某個方法或代碼使用鎖桶良，在同一時刻僅有一個線程執(zhí)行該方法或該代碼段座舍。線程鎖只在同一JVM中有效果，因為線程鎖的實現(xiàn)在根本上是依靠線程之間共享內(nèi)存實現(xiàn)的陨帆，比如synchronized是共享對象頭曲秉，顯示鎖Lock是共享某個變量（state）。

進程鎖：為了控制同一操作系統(tǒng)中多個進程訪問某個共享資源疲牵，因為進程具有獨立性承二，各個進程無法訪問其他進程的資源，因此無法通過synchronized等線程鎖實現(xiàn)進程鎖纲爸。

分布式鎖：當多個進程不在同一個系統(tǒng)中亥鸠，用分布式鎖控制多個進程對資源的訪問。

二识啦、分布式鎖的使用場景读虏。

線程間并發(fā)問題和進程間并發(fā)問題都是可以通過分布式鎖解決的，但是強烈不建議這樣做袁滥！因為采用分布式鎖解決這些小問題是非常消耗資源的盖桥！分布式鎖應(yīng)該用來解決分布式情況下的多進程并發(fā)問題才是最合適的。

有這樣一個情境题翻，線程A和線程B都共享某個變量X揩徊。

如果是單機情況下（單JVM），線程之間共享內(nèi)存嵌赠，只要使用線程鎖就可以解決并發(fā)問題塑荒。

如果是分布式情況下（多JVM），線程A和線程B很可能不是在同一JVM中姜挺，這樣線程鎖就無法起到作用了，這時候就要用到分布式鎖來解決炊豪。

三、分布式鎖的實現(xiàn)（Redis）

分布式鎖實現(xiàn)的關(guān)鍵是在分布式的應(yīng)用服務(wù)器外牵舱，搭建一個存儲服務(wù)器，存儲鎖信息缺虐，這時候我們很容易就想到了Redis芜壁。首先我們要搭建一個Redis服務(wù)器，用Redis服務(wù)器來存儲鎖信息顷牌。

在實現(xiàn)的時候要注意的幾個關(guān)鍵點：

1、鎖信息必須是會過期超時的塞淹，不能讓一個線程長期占有一個鎖而導致死鎖韧掩；

2、同一時刻只能有一個線程獲取到鎖疗锐。

幾個要用到的redis命令：

setnx(key, value)：“set if not exits”费彼，若該key-value不存在，則成功加入緩存并且返回1雇卷，否則返回0颠猴。

get(key)：獲得key對應(yīng)的value值关划，若不存在則返回nil贮折。

getset(key, value)：先獲取key對應(yīng)的value值资盅，若不存在則返回nil，然后將舊的value更新為新的value每庆。

expire(key, seconds)：設(shè)置key-value的有效期為seconds秒今穿。

看一下流程圖：

在這個流程下，不會導致死鎖腮出。

我采用Jedis作為Redis客戶端的api拔创，下面來看一下具體實現(xiàn)的代碼。

（1）首先要創(chuàng)建一個Redis連接池。

public class RedisPool {
 
    private static JedisPool pool;//jedis連接池
 
    private static int maxTotal = 20;//最大連接數(shù)
 
    private static int maxIdle = 10;//最大空閑連接數(shù)
 
    private static int minIdle = 5;//最小空閑連接數(shù)
 
    private static boolean testOnBorrow = true;//在取連接時測試連接的可用性
 
    private static boolean testOnReturn = false;//再還連接時不測試連接的可用性
 
    static {
        initPool();//初始化連接池
    }
 
    public static Jedis getJedis(){
        return pool.getResource();
    }
 
    public static void close(Jedis jedis){
        jedis.close();
    }
 
    private static void initPool(){
        JedisPoolConfig config = new JedisPoolConfig();
        config.setMaxTotal(maxTotal);
        config.setMaxIdle(maxIdle);
        config.setMinIdle(minIdle);
        config.setTestOnBorrow(testOnBorrow);
        config.setTestOnReturn(testOnReturn);
        config.setBlockWhenExhausted(true);
        pool = new JedisPool(config, "127.0.0.1", 6379, 5000, "liqiyao");
    }
}

（2）對Jedis的api進行封裝灭红，封裝一些實現(xiàn)分布式鎖需要用到的操作。

public class RedisPoolUtil {
 
    private RedisPoolUtil(){}
 
    private static RedisPool redisPool;
 
    public static String get(String key){
        Jedis jedis = null;
        String result = null;
        try {
            jedis = RedisPool.getJedis();
            result = jedis.get(key);
        } catch (Exception e){
            e.printStackTrace();
        } finally {
            if (jedis != null) {
                jedis.close();
            }
            return result;
        }
    }
 
    public static Long setnx(String key, String value){
        Jedis jedis = null;
        Long result = null;
        try {
            jedis = RedisPool.getJedis();
            result = jedis.setnx(key, value);
        } catch (Exception e){
            e.printStackTrace();
        } finally {
            if (jedis != null) {
                jedis.close();
            }
            return result;
        }
    }
 
    public static String getSet(String key, String value){
        Jedis jedis = null;
        String result = null;
        try {
            jedis = RedisPool.getJedis();
            result = jedis.getSet(key, value);
        } catch (Exception e){
            e.printStackTrace();
        } finally {
            if (jedis != null) {
                jedis.close();
            }
            return result;
        }
    }
 
    public static Long expire(String key, int seconds){
        Jedis jedis = null;
        Long result = null;
        try {
            jedis = RedisPool.getJedis();
            result = jedis.expire(key, seconds);
        } catch (Exception e){
            e.printStackTrace();
        } finally {
            if (jedis != null) {
                jedis.close();
            }
            return result;
        }
    }
 
    public static Long del(String key){
        Jedis jedis = null;
        Long result = null;
        try {
            jedis = RedisPool.getJedis();
            result = jedis.del(key);
        } catch (Exception e){
            e.printStackTrace();
        } finally {
            if (jedis != null) {
                jedis.close();
            }
            return result;
        }
    }
}

（3）分布式鎖工具類

public class DistributedLockUtil {
 
    private DistributedLockUtil(){
    }
 
    public static boolean lock(String lockName){//lockName可以為共享變量名娇斑，也可以為方法名毫缆，主要是用于模擬鎖信息
        System.out.println(Thread.currentThread() + "開始嘗試加鎖！");
        Long result = RedisPoolUtil.setnx(lockName, String.valueOf(System.currentTimeMillis() + 5000));
        if (result != null && result.intValue() == 1){
            System.out.println(Thread.currentThread() + "加鎖成功苦丁！");
            RedisPoolUtil.expire(lockName, 5);
            System.out.println(Thread.currentThread() + "執(zhí)行業(yè)務(wù)邏輯旺拉！");
            RedisPoolUtil.del(lockName);
            return true;
        } else {
            String lockValueA = RedisPoolUtil.get(lockName);
            if (lockValueA != null && Long.parseLong(lockValueA) >= System.currentTimeMillis()){
                String lockValueB = RedisPoolUtil.getSet(lockName, String.valueOf(System.currentTimeMillis() + 5000));
                if (lockValueB == null || lockValueB.equals(lockValueA)){
                    System.out.println(Thread.currentThread() + "加鎖成功！");
                    RedisPoolUtil.expire(lockName, 5);
                    System.out.println(Thread.currentThread() + "執(zhí)行業(yè)務(wù)邏輯晋涣！");
                    RedisPoolUtil.del(lockName);
                    return true;
                } else {
                    return false;
                }
            } else {
                return false;
            }
        }
    }
}

前言

分布式鎖一般有三種實現(xiàn)方式：1. 數(shù)據(jù)庫樂觀鎖沉桌；2. 基于Redis的分布式鎖；3. 基于ZooKeeper的分布式鎖撇贺。本篇博客將介紹第二種方式松嘶，基于Redis實現(xiàn)分布式鎖挎扰。雖然網(wǎng)上已經(jīng)有各種介紹Redis分布式鎖實現(xiàn)的博客，然而他們的實現(xiàn)卻有著各種各樣的問題尽超，為了避免誤人子弟梧躺，本篇博客將詳細介紹如何正確地實現(xiàn)Redis分布式鎖傲绣。

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

互斥性菠净。在任意時刻彪杉，只有一個客戶端能持有鎖派近。
不會發(fā)生死鎖。即使有一個客戶端在持有鎖的期間崩潰而沒有主動解鎖构哺，也能保證后續(xù)其他客戶端能加鎖。
具有容錯性残拐。只要大部分的Redis節(jié)點正常運行碟嘴，客戶端就可以加鎖和解鎖。
解鈴還須系鈴人错沃。加鎖和解鎖必須是同一個客戶端雀瓢，客戶端自己不能把別人加的鎖給解了刃麸。
代碼實現(xiàn)
組件依賴
首先我們要通過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泊业。先展示代碼吁伺，再帶大家慢慢解釋為什么這樣實現(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 請求標識
     * @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，我們就知道這把鎖是哪個請求加的了贱迟，在解鎖的時候就可以有依據(jù)絮供。requestId可以使用UUID.randomUUID().toString()方法生成。

第三個為nxxx缚俏，這個參數(shù)我們填的是NX萍肆，意思是SET IF NOT EXIST，即當key不存在時包雀，我們進行set操作亲铡；若key已經(jīng)存在葡兑，則不做任何操作讹堤；

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

第五個為time，與第四個參數(shù)相呼應(yīng)手负，代表key的過期時間姑尺。

總的來說，執(zhí)行上面的set()方法就只會導致兩種結(jié)果：1. 當前沒有鎖（key不存在）衡楞，那么就進行加鎖操作敦姻，并對鎖設(shè)置個有效期，同時value表示加鎖的客戶端迷守。2. 已有鎖存在旺入，不做任何操作。

心細的童鞋就會發(fā)現(xiàn)了礼华，我們的加鎖代碼滿足我們可靠性里描述的三個條件拗秘。首先，set()加入了NX參數(shù)扮匠，可以保證如果已有key存在，則函數(shù)不會調(diào)用成功疹蛉，也就是只有一個客戶端能持有鎖力麸，滿足互斥性。其次筑舅，由于我們對鎖設(shè)置了過期時間陨舱，即使鎖的持有者后續(xù)發(fā)生崩潰而沒有解鎖版仔，鎖也會因為到了過期時間而自動解鎖（即key被刪除）蛮粮，不會發(fā)生死鎖。最后莺奔，因為我們將value賦值為requestId变泄，代表加鎖的客戶端請求標識，那么在客戶端在解鎖的時候就可以進行校驗是否是同一個客戶端屏富。由于我們只考慮Redis單機部署的場景蛙卤，所以容錯性我們暫不考慮。

錯誤示例1

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

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

setnx()方法作用就是SET IF NOT EXIST艾扮，expire()方法就是給鎖加一個過期時間占婉。乍一看好像和前面的set()方法結(jié)果一樣，然而由于這是兩條Redis命令酌予，不具有原子性奖慌，如果程序在執(zhí)行完setnx()之后突然崩潰简僧，導致鎖沒有設(shè)置過期時間。那么將會發(fā)生死鎖岛马。網(wǎng)上之所以有人這樣實現(xiàn)啦逆，是因為低版本的jedis并不支持多參數(shù)的set()方法。

錯誤示例2

這一種錯誤示例就比較難以發(fā)現(xiàn)問題乃坤，而且實現(xiàn)也比較復(fù)雜沟蔑。實現(xiàn)思路：使用jedis.setnx()命令實現(xiàn)加鎖，其中key是鎖枫吧，value是鎖的過期時間宇色。執(zhí)行過程：1. 通過setnx()方法嘗試加鎖宣蠕，如果當前鎖不存在，返回加鎖成功抢蚀。2. 如果鎖已經(jīng)存在則獲取鎖的過期時間，和當前時間比較唱逢，如果鎖已經(jīng)過期坞古，則設(shè)置新的過期時間，返回加鎖成功织堂。代碼如下：

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()) {
        // 鎖已過期潦俺，獲取上一個鎖的過期時間黑竞，并設(shè)置現(xiàn)在鎖的過期時間
        String oldValueStr = jedis.getSet(lockKey, expiresStr);
        if (oldValueStr != null && oldValueStr.equals(currentValueStr)) {
            // 考慮多線程并發(fā)的情況疏旨，只有一個線程的設(shè)置值和當前值相同扎酷，它才有權(quán)利加鎖
            return true;
        }
    }
        
    // 其他情況法挨，一律返回加鎖失敗
    return false;
 
}

那么這段代碼問題在哪里？1. 由于是客戶端自己生成過期時間凡纳，所以需要強制要求分布式下每個客戶端的時間必須同步荐糜。 2. 當鎖過期的時候，如果多個客戶端同時執(zhí)行jedis.getSet()方法延塑，那么雖然最終只有一個客戶端可以加鎖答渔，但是這個客戶端的鎖的過期時間可能被其他客戶端覆蓋沼撕。3. 鎖不具備擁有者標識芜飘，即任何客戶端都可以解鎖磨总。

解鎖代碼

正確姿勢

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

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代碼傳到j(luò)edis.eval()方法里辨泳，并使參數(shù)KEYS[1]賦值為lockKey玖院，ARGV[1]賦值為requestId难菌。eval()方法是將Lua代碼交給Redis服務(wù)端執(zhí)行。

那么這段Lua代碼的功能是什么呢遇绞？其實很簡單猎塞，首先獲取鎖對應(yīng)的value值氮兵，檢查是否與requestId相等豺谈，如果相等則刪除鎖（解鎖）。那么為什么要使用Lua語言來實現(xiàn)呢银亲？因為要確保上述操作是原子性的纽匙。關(guān)于非原子性會帶來什么問題烛缔，可以閱讀【解鎖代碼-錯誤示例2】 。那么為什么執(zhí)行eval()方法可以確保原子性院喜，源于Redis的特性晕翠，下面是官網(wǎng)對eval命令的部分解釋：

簡單來說淋肾，就是在eval命令執(zhí)行Lua代碼的時候，Lua代碼將被當成一個命令去執(zhí)行樊卓，并且直到eval命令執(zhí)行完成简识，Redis才會執(zhí)行其他命令。

錯誤示例1
最常見的解鎖代碼就是直接使用jedis.del()方法刪除鎖，這種不先判斷鎖的擁有者而直接解鎖的方式颈走，會導致任何客戶端都可以隨時進行解鎖咱士，即使這把鎖不是它的。

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

錯誤示例2

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

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

如代碼注釋，問題在于如果調(diào)用jedis.del()方法的時候粥帚，這把鎖已經(jīng)不屬于當前客戶端的時候會解除他人加的鎖弄抬。那么是否真的有這種場景？答案是肯定的拖陆，比如客戶端A加鎖懊亡，一段時間之后客戶端A解鎖店枣，在執(zhí)行jedis.del()之前，鎖突然過期了闷旧，此時客戶端B嘗試加鎖成功钧唐，然后客戶端A再執(zhí)行del()方法钝侠，則將客戶端B的鎖給解除了。

總結(jié)
本文主要介紹了如何使用Java代碼正確實現(xiàn)Redis分布式鎖里初，對于加鎖和解鎖也分別給出了兩個比較經(jīng)典的錯誤示例忽舟。其實想要通過Redis實現(xiàn)分布式鎖并不難，只要保證能滿足可靠性里的四個條件斥难⊙普铮互聯(lián)網(wǎng)雖然給我們帶來了方便，只要有問題就可以google竞阐，然而網(wǎng)上的答案一定是對的嗎骆莹？其實不然担猛，所以我們更應(yīng)該時刻保持著質(zhì)疑精神，多想多驗證先改。

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

最后：

不足之處掸掸，還望小伙伴多多諒解猾漫；
有錯之處感凤，還望小伙伴指出，小編會盡快改正