一、什么是分布式鎖？

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

線程鎖：主要用來給方法、代碼塊加鎖。當某個方法或代碼使用鎖，在同一時刻僅有一個線程執行該方法或該代碼段。線程鎖只在同一JVM中有效果，因為線程鎖的實現在根本上是依靠線程之間共享內存實現的，比如synchronized是共享對象頭，顯示鎖Lock是共享某個變量（state）。

進程鎖：為了控制同一操作系統中多個進程訪問某個共享資源，因為進程具有獨立性，各個進程無法訪問其他進程的資源，因此無法通過synchronized等線程鎖實現進程鎖。

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

二、分布式鎖的使用場景。

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

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

如果是單機情況下（單JVM），線程之間共享內存，只要使用線程鎖就可以解決并發問題。

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

三、分布式鎖的實現（Redis）

分布式鎖實現的關鍵是在分布式的應用服務器外，搭建一個存儲服務器，存儲鎖信息，這時候我們很容易就想到了Redis。首先我們要搭建一個Redis服務器，用Redis服務器來存儲鎖信息。

在實現的時候要注意的幾個關鍵點：

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

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

幾個要用到的redis命令：

setnx（key， value）：“set if not exits”，若該key-value不存在，則成功加入緩存并且返回1，否則返回0。

get（key）：獲得key對應的value值，若不存在則返回nil。

getset（key， value）：先獲取key對應的value值，若不存在則返回nil，然后將舊的value更新為新的value。

expire（key， seconds）：設置key-value的有效期為seconds秒。

我采用Jedis作為Redis客戶端的api，下面來看一下具體實現的代碼。

（1）首先要創建一個Redis連接池。

public class RedisPool {private static JedisPool pool;//jedis連接池private static int maxTotal = 20;//最大連接數 private static int maxIdle = 10;//最大空閑連接數 private static int minIdle = 5;//最小空閑連接數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進行封裝，封裝一些實現分布式鎖需要用到的操作。

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（） + “執行業務邏輯！”）;RedisPoolUtil.del（lockName）; return true; } else { String lockValueA = RedisPoolUtil.get（lockName）; //判斷從pool.Resouce（）里面取出的是否小于當前時間 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（） + “執行業務邏輯！”）;RedisPoolUtil.del（lockName）; return true; } else { return false; } } else {return false; } } }}

前言

分布式鎖一般有三種實現方式：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; } } // 其他情況，一律返回加鎖失敗 return false;}

那么這段代碼問題在哪里？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組件。