redis實現分布式鎖的正確方式(java版)

1.組件依賴

通過Maven引入Jedis開源組件,在pom.xml文件加入下面的代碼:

<dependency>
<groupId>redis.clients</groupId>
<artifactId>jedis</artifactId>
<version>2.9.0</version>
</dependency>
2.加鎖的實現
2.1常見的兩種錯誤方式

1.第一種

public static void wrongGetLock(Jedis jedis,String key,String value,int expTime){
        Long result = jedis.setnx(key, value);
        if(result == 1){
            //若在這里程序突然崩潰,則無法設置過期時間,將發生死鎖
            jedis.expire(key, expTime);
        }
    }

2.第二種

    public static boolean wrongGetLock2(Jedis jedis,String key,String value,int expTime){
        long expires = System.currentTimeMillis() + expTime;
        String expiresStr = String.valueOf(expires);
        
        // 如果當前鎖不存在,返回加鎖成功
        if (jedis.setnx(key, expiresStr) == 1) {
            return true;
        }
        // 如果鎖存在,獲取鎖的過期時間
        String currentValueStr = jedis.get(key);
        if(currentValueStr != null && Long.valueOf(currentValueStr)<System.currentTimeMillis()){
            // 鎖已過期,獲取上一個鎖的過期時間,并設置現在鎖的過期時間
            String oldString = jedis.getSet(key, expiresStr);
            if(oldString != null && oldString.equals(currentValueStr)){
                return true;
            }
        }
        return false;
    }

問題所在:

  1. 由于是客戶端自己生成過期時間,所以需要強制要求分布式下每個客戶端的時間必須同步。
  2. 當鎖過期的時候,如果多個客戶端同時執行jedis.getSet()方法,那么雖然最終只有一個客戶端可以加鎖,但是這個客戶端的鎖的過期時間可能被其他客戶端覆蓋。
  3. 鎖不具備擁有者標識,即任何客戶端都可以解鎖。
2.2 正確的加鎖方式
public class RedisTool {
    
    private static final Logger logger = LoggerFactory.getLogger(RedisTool.class);
    
    //加鎖成功標志
    private static final String LOCK_SUCCESS = "OK";
    //解鎖成功標志
    private static final String RELEASE_SUCCESS = "1";
    //加鎖標志
    private static final String SET_IF_NOT_EXIST = "NX";
    //給鎖設置過期時間的標志
    private static final String SET_WITH_EXPIRE_TIME = "PX";
    
    
    /**
     * 嘗試獲得鎖
     * @param jedis    redis實例
     * @param key      具體的鎖
     * @param value    鎖的值,解鎖的時候用
     * @param expTime  鎖的失效時間
     * @return 加鎖成功標志
     */
    public static boolean getDistributedLock(Jedis jedis,String key,String value,int expTime){
        boolean isLocked = false;
        try {
            String result = jedis.set(key, value, SET_IF_NOT_EXIST, SET_WITH_EXPIRE_TIME, expTime);
            if (LOCK_SUCCESS.equals(result)) {
                isLocked = true;
            }
        } catch (Exception e) {
            e.printStackTrace();
            logger.error("redis加鎖失敗:"+e.getMessage());
        }
        return isLocked;
    }
}

可以看到,我們加鎖就一行代碼:jedis.set(String key, String value, String nxxx, String expx, int time),這個set()方法一共有五個形參:

  • 第一個為key,我們使用key來當鎖,因為key是唯一的。
  • 第二個為value,在解鎖的時候就可以有依據。value可以使用UUID.randomUUID().toString()方法生成。
  • 第三個為nxxx,這個參數我們填的是NX,意思是SET IF NOT EXIST,即當key不存在時,我們進行set操作;若key已經存在,則不做任何操作;
  • 第四個為expx,這個參數我們傳的是PX,意思是我們要給這個key加一個過期的設置,具體時間由第五個參數決定。
  • 第五個為time,與第四個參數相呼應,代表key的過期時間。

首先,set()加入了NX參數,可以保證如果已有key存在,則函數不會調用成功,也就是只有一個客戶端能持有鎖,滿足互斥性。其次,由于我們對鎖設置了過期時間,即使鎖的持有者后續發生崩潰而沒有解鎖,鎖也會因為到了過期時間而自動解鎖(即key被刪除),不會發生死鎖。最后,因為我們將value賦值為requestId,代表加鎖的客戶端請求標識,那么在客戶端在解鎖的時候就可以進行校驗是否是同一個客戶端。由于我們只考慮Redis單機部署的場景,所以容錯性我們暫不考慮。

3.解鎖
3.1 解鎖的常見兩種錯誤方式

1.第一種

public static void wrongReleaseLock1(Jedis jedis, String lockKey) {
        jedis.del(lockKey);
}

最常見的解鎖代碼就是直接使用jedis.del()方法刪除鎖,這種不先判斷鎖的擁有者而直接解鎖的方式,會導致任何客戶端都可以隨時進行解鎖,即使這把鎖不是它的。

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的鎖給解除了。

3.2 正確的解鎖方式
    /**
     * 嘗試解鎖(刪除key)
     * @param jedis  redis實例
     * @param key    具體的鎖
     * @param value   
     * @return
     */
    public static boolean releaseDistributedLock(Jedis jedis, String key, String value){
        boolean isUnlocked = false;
        try {
            //獲取鎖對應的value值,檢查是否與requestId相等,如果相等則刪除鎖(解鎖);eval()方法執行Lua腳本是原子性的
            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(key), Collections.singletonList(value));
            if(!CommonUtils.check(result) && RELEASE_SUCCESS.equals(result.toString())){
                isUnlocked = true;
            }
        } catch (Exception e) {
            e.printStackTrace();
            logger.error("redis解鎖異常:"+e.getMessage());
        }
        return isUnlocked;
    }

那么這段Lua代碼的功能是什么呢?其實很簡單,首先獲取鎖對應的value值,檢查是否與requestId相等,如果相等則刪除鎖(解鎖)。那么為什么要使用Lua語言來實現呢?因為要確保上述操作是原子性的。
簡單來說,就是在eval命令執行Lua代碼的時候,Lua代碼將被當成一個命令去執行,并且直到eval命令執行完成,Redis才會執行其他命令。

原文鏈接

最后編輯于
?著作權歸作者所有,轉載或內容合作請聯系作者
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 227,488評論 6 531
  • 序言:濱河連續發生了三起死亡事件,死亡現場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發現死者居然都...
    沈念sama閱讀 98,034評論 3 414
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 175,327評論 0 373
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 62,554評論 1 307
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 71,337評論 6 404
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上,一...
    開封第一講書人閱讀 54,883評論 1 321
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 42,975評論 3 439
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 42,114評論 0 286
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當地人在樹林里發現了一具尸體,經...
    沈念sama閱讀 48,625評論 1 332
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 40,555評論 3 354
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 42,737評論 1 369
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 38,244評論 5 355
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發生泄漏。R本人自食惡果不足惜,卻給世界環境...
    茶點故事閱讀 43,973評論 3 345
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 34,362評論 0 25
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 35,615評論 1 280
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 51,343評論 3 390
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 47,699評論 2 370