Redis分佈式鎖
Redis分佈式鎖正確的實現方法
分佈式鎖通常有數據庫樂觀鎖、基於Redis的分佈式鎖以及基於ZooKeeper的分佈式鎖三種實現方式，而本文將爲你們帶來的就是第二種基於Redis的分佈式鎖正確的實現方法，但願對你們會有所幫助。html
可靠性
首先，想要保證分佈式鎖可使用，下面這四個條件是必需要知足的：redis
- 互斥性。在任意時刻，只有一個客戶端能持有鎖。
- 不會發生死鎖。即便有一個客戶端在持有鎖的期間崩潰而沒有主動解鎖，也能保證後續其餘客戶端能加鎖。
- 具備容錯性。只要大部分的Redis節點正常運行，客戶端就能夠加鎖和解鎖。
解鈴還須繫鈴人。加鎖和解鎖必須是同一個客戶端，客戶端本身不能把別人加的鎖給解了。數據庫
代碼實現
引入Jedis開源組件
首先咱們要經過Maven引入Jedis開源組件，在pom.xml文件加入下面的代碼：編程
<dependency>
<groupId>redis.clients</groupId>
<artifactId>jedis</artifactId>
<version>2.9.0</version>
</dependency>
加鎖代碼
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()方法就只會致使兩種結果：多線程
- 當前沒有鎖（key不存在），那麼就進行加鎖操做，並對鎖設置個有效期，同時value表示加鎖的客戶端。
- 已有鎖存在，不作任何操做。
錯誤示例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()方法。dom
錯誤示例2
這一種錯誤示例就比較難以發現問題，並且實現也比較複雜。實現思路：使用jedis.setnx()命令實現加鎖，其中key是鎖，value是鎖的過時時間。執行過程：編程語言
- 經過setnx()方法嘗試加鎖，若是當前鎖不存在，返回加鎖成功。
- 若是鎖已經存在則獲取鎖的過時時間，和當前時間比較，若是鎖已通過期，則設置新的過時時間，返回加鎖成功。
代碼以下：分佈式
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;
}
這段代碼的錯誤之處在於：
- 因爲是客戶端本身生成過時時間，因此須要強制要求分佈式下每一個客戶端的時間必須同步。
- 當鎖過時的時候，若是多個客戶端同時執行jedis.getSet()方法，那麼雖然最終只有一個客戶端能夠加鎖，可是這個客戶端的鎖的過時時間可能被其餘客戶端覆蓋。
- 鎖不具有擁有者標識，即任何客戶端均可以解鎖。
解鎖代碼
正確代碼
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命令執行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的鎖給解除了。
總結
以上事例僅爲參考，具體加鎖解鎖須要結合具體的業務場景來作，以上毫不是最佳或惟一標準，如某些場景不須要過時時間，不須要記錄requestId等
使用小記
@Component
public class LockUtil {
private static final Logger logger = LoggerFactory.getLogger(LockUtil.class);
@Autowired
private RedisUtils redisUtils;
/**
* 加鎖：
* key惟一，放入緩存，每次操做前，先查key
*
* @param key
* @throws Exception
*/
public void addLock(String key) throws Exception {
if (StrUtils.isEmpty(redisUtils.get(CtimsModelEnum.CTIMS_REPORT_BIZ, key))) {
//查詢爲空，說明該記錄沒有被鎖，能夠操做，則添加一條記錄到緩存，key有意義，保證惟一，value無心義
redisUtils.set(CtimsModelEnum.CTIMS_REPORT_BIZ, key, "lock");
logger.info("程序加鎖，key={}", key);
} else {
//若是查詢非空，說明記錄被鎖，等待5ms，繼續操做，直到放開鎖
Thread.sleep(5);
logger.info("程序被鎖，等待5，key={}", key);
addLock(key);
}
}
/**
* 放開鎖
*
* @param key
* @throws Exception
*/
public void delLock(String key) throws Exception {
redisUtils.del(CtimsModelEnum.CTIMS_REPORT_BIZ, key);
logger.info("程序鎖被釋放，key={}", key);
}
}
- 1. 分佈式鎖——Redis分佈式鎖
- 2. Redis分佈式鎖
- 3. redis 分佈式鎖
- 4. redis分佈式鎖
- 5. Redis 分佈式鎖
- 6. Redis--分佈式鎖
- 7. redis--分佈式鎖
- 更多相關文章...
- • Redis發佈訂閱模式 - Redis教程
- • ASP.NET MVC - 樣式和佈局 - ASP.NET 教程
- • 再有人問你分佈式事務，把這篇扔給他
- • 常用的分佈式事務解決方案
-
每一个你不满意的现在，都有一个你没有努力的曾经。
- 1. 分佈式鎖——Redis分佈式鎖
- 2. Redis分佈式鎖
- 3. redis 分佈式鎖
- 4. redis分佈式鎖
- 5. Redis 分佈式鎖
- 6. Redis--分佈式鎖
- 7. redis--分佈式鎖