分布式鎖一般有三種實現(xiàn)方式:
1、數(shù)據(jù)庫樂觀鎖;
2、基于Redis的分布式鎖;
3、基于ZooKeeper的分布式鎖。
本文將介紹第二種方式,基于Redis實現(xiàn)分布式鎖。雖然網(wǎng)上已經(jīng)有各種介紹Redis分布式鎖實現(xiàn)的博客,然而他們的實現(xiàn)卻有著各種各樣的問題,為了避免誤人子弟,本篇博客將詳細(xì)介紹如何正確地實現(xiàn)Redis分布式鎖。
可靠性
首先,為了確保分布式鎖可用,我們至少要確保鎖的實現(xiàn)同時滿足以下四個條件:
1、互斥性。在任意時刻,只有一個客戶端能持有鎖。
2、不會發(fā)生死鎖。即使有一個客戶端在持有鎖的期間崩潰而沒有主動解鎖,也能保證后續(xù)其他客戶端能加鎖。
3、具有容錯性。只要大部分的Redis節(jié)點正常運行,客戶端就可以加鎖和解鎖。
4、解鈴還須系鈴人。加鎖和解鎖必須是同一個客戶端,客戶端自己不能把別人加的鎖給解了。
代碼實現(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 請求標(biāo)識 * @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來當(dāng)鎖,因為key是唯一的。
第二個為value,我們傳的是requestId,很多童鞋可能不明白,有key作為鎖不就夠了嗎,為什么還要用到value?原因就是我們在上面講到可靠性時,分布式鎖要滿足第四個條件解鈴還須系鈴人,通過給value賦值為requestId,我們就知道這把鎖是哪個請求加的了,在解鎖的時候就可以有依據(jù)。requestId可以使用UUID.randomUUID().toString()方法生成。
第三個為nxxx,這個參數(shù)我們填的是NX,意思是SET IF NOT EXIST,即當(dāng)key不存在時,我們進(jìn)行set操作;若key已經(jīng)存在,則不做任何操作;
第四個為expx,這個參數(shù)我們傳的是PX,意思是我們要給這個key加一個過期的設(shè)置,具體時間由第五個參數(shù)決定。
第五個為time,與第四個參數(shù)相呼應(yīng),代表key的過期時間。
總的來說,執(zhí)行上面的set()方法就只會導(dǎo)致兩種結(jié)果:1. 當(dāng)前沒有鎖(key不存在),那么就進(jìn)行加鎖操作,并對鎖設(shè)置個有效期,同時value表示加鎖的客戶端。2. 已有鎖存在,不做任何操作。
心細(xì)的童鞋就會發(fā)現(xiàn)了,我們的加鎖代碼滿足我們可靠性里描述的三個條件:
1、首先,set()加入了NX參數(shù),可以保證如果已有key存在,則函數(shù)不會調(diào)用成功,也就是只有一個客戶端能持有鎖,滿足互斥性。
2、其次,由于我們對鎖設(shè)置了過期時間,即使鎖的持有者后續(xù)發(fā)生崩潰而沒有解鎖,鎖也會因為到了過期時間而自動解鎖(即key被刪除),不會發(fā)生死鎖。
3、最后,因為我們將value賦值為requestId,代表加鎖的客戶端請求標(biāo)識,那么在客戶端在解鎖的時候就可以進(jìn)行校驗是否是同一個客戶端。由于我們只考慮Redis單機(jī)部署的場景,所以容錯性我們暫不考慮。
錯誤示例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()之后突然崩潰,導(dǎo)致鎖沒有設(shè)置過期時間。那么將會發(fā)生死鎖。網(wǎng)上之所以有人這樣實現(xiàn),是因為低版本的jedis并不支持多參數(shù)的set()方法。
錯誤示例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; } // 如果鎖存在,獲取鎖的過期時間 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è)置值和當(dāng)前值相同,它才有權(quán)利加鎖 return true; } } // 其他情況,一律返回加鎖失敗 return false; }
這一種錯誤示例就比較難以發(fā)現(xiàn)問題,而且實現(xiàn)也比較復(fù)雜。實現(xiàn)思路:使用jedis.setnx()命令實現(xiàn)加鎖,其中key是鎖,value是鎖的過期時間。
執(zhí)行過程:
1、通過setnx()方法嘗試加鎖,如果當(dāng)前鎖不存在,返回加鎖成功。
2、如果鎖已經(jīng)存在則獲取鎖的過期時間,和當(dāng)前時間比較,如果鎖已經(jīng)過期,則設(shè)置新的過期時間,返回加鎖成功。代碼如下:
那么這段代碼問題在哪里?
1、由于是客戶端自己生成過期時間,所以需要強(qiáng)制要求分布式下每個客戶端的時間必須同步。
2、當(dāng)鎖過期的時候,如果多個客戶端同時執(zhí)行jedis.getSet()方法,那么雖然最終只有一個客戶端可以加鎖,但是這個客戶端的鎖的過期時間可能被其他客戶端覆蓋。
3、鎖不具備擁有者標(biāo)識,即任何客戶端都可以解鎖。
解鎖代碼
正確姿勢
還是先展示代碼,再帶大家慢慢解釋為什么這樣實現(xiàn):
public class RedisTool { private static final Long RELEASE_SUCCESS = 1L; /** * 釋放分布式鎖 * @param jedis Redis客戶端 * @param lockKey 鎖 * @param requestId 請求標(biāo)識 * @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代碼將被當(dāng)成一個命令去執(zhí)行,并且直到eval命令執(zhí)行完成,Redis才會執(zhí)行其他命令。
錯誤示例1
最常見的解鎖代碼就是直接使用jedis.del()方法刪除鎖,這種不先判斷鎖的擁有者而直接解鎖的方式,會導(dǎo)致任何客戶端都可以隨時進(jìn)行解鎖,即使這把鎖不是它的。
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)不屬于當(dāng)前客戶端的時候會解除他人加的鎖。那么是否真的有這種場景?答案是肯定的,比如客戶端A加鎖,一段時間之后客戶端A解鎖,在執(zhí)行jedis.del()之前,鎖突然過期了,此時客戶端B嘗試加鎖成功,然后客戶端A再執(zhí)行del()方法,則將客戶端B的鎖給解除了。
以上就是腳本之家小編給大家整理的全部相關(guān)知識點,感謝大家的學(xué)習(xí)和支持。
標(biāo)簽:畢節(jié) 河源 定州 拉薩 泰州 伊春 甘南 南寧
巨人網(wǎng)絡(luò)通訊聲明:本文標(biāo)題《Redis分布式鎖的正確實現(xiàn)方法總結(jié)》,本文關(guān)鍵詞 Redis,分布式,鎖,的,正確,;如發(fā)現(xiàn)本文內(nèi)容存在版權(quán)問題,煩請?zhí)峁┫嚓P(guān)信息告之我們,我們將及時溝通與處理。本站內(nèi)容系統(tǒng)采集于網(wǎng)絡(luò),涉及言論、版權(quán)與本站無關(guān)。