前言
分布式鎖一般有三種實現(xiàn)方式：1. 數(shù)據(jù)庫樂觀鎖黄鳍；2. 基于Redis的分布式鎖关串；3. 基于ZooKeeper的分布式鎖赏淌。本篇博客將介紹第二種方式踩寇，基于Redis實現(xiàn)分布式鎖。雖然網上已經有各種介紹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已經存在，則不做任何操作着绷；
- 第四個為expx蛔钙，這個參數(shù)我們傳的是PX，意思是我們要給這個key加一個過期的設置蓬戚，具體時間由第五個參數(shù)決定夸楣。
- 第五個為time，與第四個參數(shù)相呼應，代表key的過期時間豫喧。
總的來說石洗，執(zhí)行上面的set()方法就只會導致兩種結果：
1. 當前沒有鎖（key不存在），那么就進行加鎖操作紧显，并對鎖設置個有效期讲衫，同時value表示加鎖的客戶端。
2. 已有鎖存在孵班，不做任何操作涉兽。
心細的童鞋就會發(fā)現(xiàn)了，我們的加鎖代碼滿足我們可靠性里描述的三個條件篙程。首先枷畏，set()加入了NX參數(shù)，可以保證如果已有key存在虱饿，則函數(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) {
// 若在這里程序突然崩潰，則無法設置過期時間贰谣，將發(fā)生死鎖
jedis.expire(lockKey, expireTime);
}
}
setnx()方法作用就是SET IF NOT EXIST娜搂，expire()方法就是給鎖加一個過期時間。乍一看好像和前面的set()方法結果一樣吱抚，然而由于這是兩條Redis命令百宇，不具有原子性，如果程序在執(zhí)行完setnx()之后突然崩潰秘豹，導致鎖沒有設置過期時間携御。那么將會發(fā)生死鎖。網上之所以有人這樣實現(xiàn)，是因為低版本的jedis并不支持多參數(shù)的set()方法啄刹。
錯誤示例2
這一種錯誤示例就比較難以發(fā)現(xiàn)問題涮坐，而且實現(xiàn)也比較復雜。實現(xiàn)思路：使用jedis.setnx()命令實現(xiàn)加鎖誓军，其中key是鎖袱讹，value是鎖的過期時間。執(zhí)行過程：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()) {
// 鎖已過期管怠，獲取上一個鎖的過期時間，并設置現(xiàn)在鎖的過期時間
String oldValueStr = jedis.getSet(lockKey, expiresStr);
if (oldValueStr != null && oldValueStr.equals(currentValueStr)) {
// 考慮多線程并發(fā)的情況缸榄，只有一個線程的設置值和當前值相同渤弛，它才有權利加鎖
return true;
}
}
// 其他情況，一律返回加鎖失敗
return false;
}
那么這段代碼問題在哪里甚带？
- 由于是客戶端自己生成過期時間她肯，所以需要強制要求分布式下每個客戶端的時間必須同步。
- 當鎖過期的時候鹰贵，如果多個客戶端同時執(zhí)行
jedis.getSet()方法晴氨，那么雖然最終只有一個客戶端可以加鎖，但是這個客戶端的鎖的過期時間可能被其他客戶端覆蓋碉输。 - 鎖不具備擁有者標識籽前，即任何客戶端都可以解鎖。
解鎖代碼
正確姿勢
還是先展示代碼敷钾，再帶大家慢慢解釋為什么這樣實現(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代碼傳到jedis.eval()方法里粱侣，并使參數(shù)KEYS[1]賦值為lockKey，ARGV[1]賦值為requestId蓖宦。eval()方法是將Lua代碼交給Redis服務端執(zhí)行齐婴。
那么這段Lua代碼的功能是什么呢？其實很簡單球昨，首先獲取鎖對應的value值尔店，檢查是否與requestId相等，如果相等則刪除鎖（解鎖）主慰。那么為什么要使用Lua語言來實現(xiàn)呢嚣州？因為要確保上述操作是原子性的。關于非原子性會帶來什么問題共螺，可以閱讀【解鎖代碼-錯誤示例2】 该肴。那么為什么執(zhí)行eval()方法可以確保原子性，源于Redis的特性藐不，下面是官網對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);
}
}
如代碼注釋捂掰，問題在于如果調用jedis.del()方法的時候，這把鎖已經不屬于當前客戶端的時候會解除他人加的鎖曾沈。那么是否真的有這種場景尘颓？答案是肯定的，比如客戶端A加鎖晦譬，一段時間之后客戶端A解鎖，在執(zhí)行jedis.del()之前互广，鎖突然過期了敛腌，此時客戶端B嘗試加鎖成功卧土，然后客戶端A再執(zhí)行del()方法，則將客戶端B的鎖給解除了像樊。
總結
總結
本文主要介紹了如何使用Java代碼正確實現(xiàn)Redis分布式鎖尤莺，對于加鎖和解鎖也分別給出了兩個比較經典的錯誤示例。其實想要通過Redis實現(xiàn)分布式鎖并不難生棍，只要保證能滿足可靠性里的四個條件颤霎。互聯(lián)網雖然給我們帶來了方便涂滴，只要有問題就可以google友酱，然而網上的答案一定是對的嗎？其實不然柔纵，所以我們更應該時刻保持著質疑精神缔杉，多想多驗證。
如果你的項目中Redis是多機部署的搁料，那么可以嘗試使用Redisson實現(xiàn)分布式鎖或详，這是Redis官方提供的Java組件，鏈接在參考閱讀章節(jié)已經給出郭计。
