前言
分布式鎖一般有三種實(shí)現(xiàn)方式：
- 數(shù)據(jù)庫(kù)樂(lè)觀鎖析校；
- 基于Redis的分布式鎖；
- 基于ZooKeeper的分布式鎖铜涉。
本篇內(nèi)容將介紹第二種方式智玻，基于Redis實(shí)現(xiàn)分布式鎖。
簡(jiǎn)介
首先芙代，為了確保分布式鎖可用吊奢，我們至少要確保鎖的實(shí)現(xiàn)同時(shí)滿足以下四個(gè)條件：
1.互斥性。在任意時(shí)刻纹烹，只有一個(gè)客戶端能持有鎖页滚。
2.不會(huì)發(fā)生死鎖。即使有一個(gè)客戶端在持有鎖的期間崩潰而沒(méi)有主動(dòng)解鎖铺呵，也能保證后續(xù)其他客戶端能加鎖裹驰。
3.具有容錯(cuò)性。只要大部分的Redis節(jié)點(diǎn)正常運(yùn)行片挂，客戶端就可以加鎖和解鎖幻林。
4.解鈴還須系鈴人。加鎖和解鎖必須是同一個(gè)客戶端音念，客戶端自己不能把別人加的鎖給解了沪饺。
代碼實(shí)現(xiàn)
1.導(dǎo)入依賴
首先我們要通過(guò)Maven引入Jedis開(kāi)源組件，在pom.xml文件加入下面的代碼：
<dependency>
<groupId>redis.clients</groupId>
<artifactId>jedis</artifactId>
<version>2.9.0</version>
</dependency>
2.加鎖代碼
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來(lái)當(dāng)鎖肝谭，因?yàn)閗ey是唯一的掘宪。
第二個(gè)為value，我們傳的是requestId攘烛，很多童鞋可能不明白魏滚，有key作為鎖不就夠了嗎，為什么還要用到value坟漱？原因就是我們?cè)谏厦嬷v到可靠性時(shí)鼠次，分布式鎖要滿足第四個(gè)條件解鈴還須系鈴人，通過(guò)給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è)過(guò)期的設(shè)置叭披，具體時(shí)間由第五個(gè)參數(shù)決定。
第五個(gè)為time玩讳，與第四個(gè)參數(shù)相呼應(yīng)涩蜘，代表key的過(guò)期時(shí)間。
總的來(lái)說(shuō)熏纯，執(zhí)行上面的set()方法就只會(huì)導(dǎo)致兩種結(jié)果：1. 當(dāng)前沒(méi)有鎖（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è)置了過(guò)期時(shí)間沼琉，即使鎖的持有者后續(xù)發(fā)生崩潰而沒(méi)有解鎖北苟，鎖也會(huì)因?yàn)榈搅诉^(guò)期時(shí)間而自動(dòng)解鎖（即key被刪除），不會(huì)發(fā)生死鎖打瘪。最后友鼻，因?yàn)槲覀儗alue賦值為requestId，代表加鎖的客戶端請(qǐng)求標(biāo)識(shí)闺骚，那么在客戶端在解鎖的時(shí)候就可以進(jìn)行校驗(yàn)是否是同一個(gè)客戶端彩扔。由于我們只考慮Redis單機(jī)部署的場(chǎng)景，所以容錯(cuò)性我們暫不考慮僻爽。
錯(cuò)誤示例1
比較常見(jiàn)的錯(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) {
// 若在這里程序突然崩潰，則無(wú)法設(shè)置過(guò)期時(shí)間胸梆，將發(fā)生死鎖
jedis.expire(lockKey, expireTime);
}
}
setnx()方法作用就是SET IF NOT EXIST蔗衡，expire()方法就是給鎖加一個(gè)過(guò)期時(shí)間。乍一看好像和前面的set()方法結(jié)果一樣乳绕，然而由于這是兩條Redis命令绞惦，不具有原子性，如果程序在執(zhí)行完setnx()之后突然崩潰洋措，導(dǎo)致鎖沒(méi)有設(shè)置過(guò)期時(shí)間济蝉。那么將會(huì)發(fā)生死鎖。網(wǎng)上之所以有人這樣實(shí)現(xiàn)菠发，是因?yàn)榈桶姹镜膉edis并不支持多參數(shù)的set()方法王滤。
錯(cuò)誤示例2
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;
}
// 如果鎖存在滓鸠，獲取鎖的過(guò)期時(shí)間
String currentValueStr = jedis.get(lockKey);
if (currentValueStr != null && Long.parseLong(currentValueStr) < System.currentTimeMillis()) {
// 鎖已過(guò)期雁乡，獲取上一個(gè)鎖的過(guò)期時(shí)間，并設(shè)置現(xiàn)在鎖的過(guò)期時(shí)間
String oldValueStr = jedis.getSet(lockKey, expiresStr);
if (oldValueStr != null && oldValueStr.equals(currentValueStr)) {
// 考慮多線程并發(fā)的情況糜俗，只有一個(gè)線程的設(shè)置值和當(dāng)前值相同踱稍，它才有權(quán)利加鎖
return true;
}
}
// 其他情況硫狞，一律返回加鎖失敗
return false;
}
這一種錯(cuò)誤示例就比較難以發(fā)現(xiàn)問(wèn)題氛雪，而且實(shí)現(xiàn)也比較復(fù)雜光绕。實(shí)現(xiàn)思路：使用jedis.setnx()命令實(shí)現(xiàn)加鎖桑寨，其中key是鎖，value是鎖的過(guò)期時(shí)間尊惰。執(zhí)行過(guò)程：1. 通過(guò)setnx()方法嘗試加鎖憎乙，如果當(dāng)前鎖不存在炭玫，返回加鎖成功卵凑。2. 如果鎖已經(jīng)存在則獲取鎖的過(guò)期時(shí)間庆聘，和當(dāng)前時(shí)間比較胜臊，如果鎖已經(jīng)過(guò)期，則設(shè)置新的過(guò)期時(shí)間伙判，返回加鎖成功象对。代碼如下：
那么這段代碼問(wèn)題在哪里？1. 由于是客戶端自己生成過(guò)期時(shí)間澳腹，所以需要強(qiáng)制要求分布式下每個(gè)客戶端的時(shí)間必須同步。 2. 當(dāng)鎖過(guò)期的時(shí)候杨何，如果多個(gè)客戶端同時(shí)執(zhí)行jedis.getSet()方法酱塔，那么雖然最終只有一個(gè)客戶端可以加鎖，但是這個(gè)客戶端的鎖的過(guò)期時(shí)間可能被其他客戶端覆蓋危虱。3. 鎖不具備擁有者標(biāo)識(shí)羊娃，即任何客戶端都可以解鎖。
2.解鎖代碼
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腳本代碼弥雹，上一次見(jiàn)到這個(gè)編程語(yǔ)言還是在《黑客與畫家》里垃帅，沒(méi)想到這次居然用上了。第二行代碼剪勿，我們將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語(yǔ)言來(lái)實(shí)現(xiàn)呢班眯？因?yàn)橐_保上述操作是原子性的。關(guān)于非原子性會(huì)帶來(lái)什么問(wèn)題烁巫，可以閱讀【解鎖代碼-錯(cuò)誤示例2】 鳖敷。那么為什么執(zhí)行eval()方法可以確保原子性，源于Redis的特性程拭，在eval命令執(zhí)行Lua代碼的時(shí)候定踱，Lua代碼將被當(dāng)成一個(gè)命令去執(zhí)行，并且直到eval命令執(zhí)行完成恃鞋，Redis才會(huì)執(zhí)行其他命令
錯(cuò)誤示例1
最常見(jiàn)的解鎖代碼就是直接使用jedis.del()方法刪除鎖崖媚，這種不先判斷鎖的擁有者而直接解鎖的方式亦歉，會(huì)導(dǎo)致任何客戶端都可以隨時(shí)進(jìn)行解鎖，即使這把鎖不是它的畅哑。
public static void wrongReleaseLock1(Jedis jedis, String lockKey) {
jedis.del(lockKey);
}
錯(cuò)誤示例2
這種解鎖代碼乍一看也是沒(méi)問(wèn)題肴楷，甚至我之前也差點(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);
}
}
如代碼注釋呵恢，問(wèn)題在于如果調(diào)用jedis.del()方法的時(shí)候，這把鎖已經(jīng)不屬于當(dāng)前客戶端的時(shí)候會(huì)解除他人加的鎖媚创。那么是否真的有這種場(chǎng)景渗钉？答案是肯定的，比如客戶端A加鎖钞钙，一段時(shí)間之后客戶端A解鎖鳄橘，在執(zhí)行jedis.del()之前，鎖突然過(guò)期了芒炼，此時(shí)客戶端B嘗試加鎖成功瘫怜，然后客戶端A再執(zhí)行del()方法，則將客戶端B的鎖給解除了本刽。
