1. 程式人生 > >單機redis環境java實現分散式鎖

單機redis環境java實現分散式鎖

分散式鎖一般有三種實現方式:1. 資料庫樂觀鎖;2. 基於Redis的分散式鎖;3. 基於ZooKeeper的分散式鎖。 為了確保分散式鎖可用,我們至少要確保鎖的實現同時滿足以下四個條件: 1)互斥性。在任意時刻,只有一個客戶端能持有鎖。  2)不會發生死鎖。即使有一個客戶端在持有鎖的期間崩潰而沒有主動解鎖,也能保證後續其他客戶端能加鎖。  3)具有容錯性。只要大部分的Redis節點正常執行,客戶端就可以加鎖和解鎖。  4)解鈴還須繫鈴人。加鎖和解鎖必須是同一個客戶端,客戶端自己不能把別人加的鎖給解了。  正確的redis單機版本分散式鎖的實現方式,如果Redis是多機部署的,那麼可以嘗試使用Redisson實現分散式鎖,這是Redis官方提供的Java元件。
1)首先新增pom.xml中新增jedis的jar包依賴
<dependency>
	<groupId>redis.clients</groupId>
	<artifactId>jedis</artifactId>
	<version>2.9.0</version>
</dependency>
2)分散式鎖工具類
import java.util.Collections;
import redis.clients.jedis.Jedis;
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";
	private static final Long RELEASE_SUCCESS = 1L;
//獲取鎖
	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;
	}
	
//釋放鎖
	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;
	}
}
程式碼說明: 可以看到,我們加鎖就一行程式碼: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單機部署的場景,所以容錯性我們暫不考慮。 ====================分割線開始===================== 錯誤加鎖示例:
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);
    }
}

為什麼用Lua程式碼實現解鎖? eval命令執行Lua程式碼的時候,Lua程式碼將被當成一個命令去執行,並且直到eval命令執行完成,Redis才會執行其他命令。這樣就防止下面示例2的問題。 錯誤解鎖示例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);
    }
}
====================分割線結束===================== 3)測試分散式鎖
import lock.util.RedisTool;
import redis.clients.jedis.Jedis;
public class TestLock {
	public static void main(String[] args) {
		Jedis jedis = new Jedis("localhost", 6379);
		//獲取鎖
		boolean success = RedisTool.tryGetDistributedLock(jedis, "lock", "request1", 30000);
		try {
			if(success) {
				System.out.println("request1成功獲取鎖");
				Thread.sleep(1000);
			}else {
				System.out.println("request1獲取鎖失敗");
			}
		} catch (InterruptedException e) {
			e.printStackTrace();
		}finally {
			//釋放鎖
			RedisTool.releaseDistributedLock(jedis, "lock", "request1");
		}
	}
}