Redis 分布式鎖的實現(xiàn)

目錄結(jié)構(gòu):

  • [前言]
  • [可靠性]
  • [代碼實現(xiàn)]
    • [組件依賴]
    • [加鎖代碼]
    • [解鎖代碼]
  • [總結(jié)]
  • [參考閱讀]

一、前言

1.1 實現(xiàn)方式

分布式鎖一般有三種實現(xiàn)方式:1. 數(shù)據(jù)庫樂觀鎖;2. 基于Redis的分布式鎖;3. 基于ZooKeeper的分布式鎖。本篇博客將介紹第二種方式,基于Redis實現(xiàn)分布式鎖。雖然網(wǎng)上已經(jīng)有各種介紹Redis分布式鎖實現(xiàn)的博客,然而他們的實現(xiàn)卻有著各種各樣的問題,為了避免誤人子弟,本文將詳細介紹如何正確地實現(xiàn)Redis分布式鎖。
Springboot集成Redis參考:https://www.cnblogs.com/zwqh/p/11664782.html,我們使用Springboot2.0默認的Lettuce連接。

1.2 使用場景

參考:https://blog.csdn.net/chunqiu3351/article/details/100762270
分布式鎖的思路是:
在整個系統(tǒng)提供一個全局、唯一的獲取鎖的“東西”,然后每個系統(tǒng)在需要加鎖時,都去問這個“東西”拿到一把鎖,這樣不同的系統(tǒng)拿到的就可以認為是同一把鎖。

二、可靠性

首先,為了確保分布式鎖可用,我們至少要確保鎖的實現(xiàn)同時滿足以下四個條件:

  1. 互斥性。在任意時刻,保證只有一臺機器的一個線程可以持有鎖。
  2. 不會發(fā)生死鎖。即使有一個客戶端在持有鎖的期間崩潰而沒有主動解鎖,也能保證后續(xù)其他客戶端能加鎖。
  3. 具有容錯性。只要大部分的Redis節(jié)點正常運行,客戶端就可以加鎖和解鎖。
  4. 具備非阻塞性。一旦獲取不到鎖就立刻返回加鎖失敗。
  5. 解鈴還須系鈴人。加鎖和解鎖必須是同一個客戶端,客戶端自己不能把別人加的鎖給解了。

三、代碼實現(xiàn)

3.1 組件依賴

我們使用的是Springboot2.3.0版本,首先我們要通過Maven引入spring-boot-starter-data-redis操作Redis,在pom.xml文件加入下面的代碼:

<dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter-data-redis</artifactId>
</dependency>

3.2 加鎖代碼

正確姿勢

Talk is easy, show me the codes first。先展示代碼,再帶大家慢慢解釋為什么這樣實現(xiàn):

    /**
     * 獲取鎖
     *
     * @param lockKey    鎖
     * @param identity   身份標(biāo)識(保證鎖不會被其他人釋放)
     * @param expireTime 鎖的過期時間(單位:秒)
     * @return
     */
    public boolean lock(String lockKey, String identity, long expireTime) {
        boolean lockResult = redisTemplate.opsForValue().setIfAbsent(lockKey, identity, expireTime, TimeUnit.SECONDS);
        return lockResult;
    }

可以看到,我們加鎖就一行代碼:redisTemplate.opsForValue().setIfAbsent(lockKey, identity, expireTime, TimeUnit.SECONDS),這個setIfAbsent()方法一共有4個形參:

  1. 第一個為key,我們使用key來當(dāng)鎖,因為key是唯一的,一個資源對應(yīng)一個唯一的key。
  2. 第二個為value,我們傳的是requestId,很多童鞋可能不明白,有key作為鎖不就夠了嗎,為什么還要用到value?原因就是我們在上面講到可靠性時,分布式鎖要滿足第四個條件解鈴還須系鈴人,通過給value賦值為requestId,我們就知道這把鎖是哪個請求加的了,在解鎖的時候就可以有依據(jù)。requestId可以使用UUID.randomUUID().toString()方法生成。
  3. 第三個參數(shù)expireTime為過期時間,此參數(shù)保證程序加鎖后崩潰導(dǎo)致不能主動釋放鎖的時候自動釋放鎖,防止出現(xiàn)死鎖。
  4. 第四個參數(shù),鎖的過期時間(單位:秒)。

為什么使用setIfAbsent方法呢?這個方法的好處就是,如果redis中已經(jīng)存在這個key了,就會返回失敗,并且不改變redis中的數(shù)據(jù),這樣就不會把別的線程的加的鎖給覆蓋掉。
總的來說,執(zhí)行上面的setIfAbsent方法就只會導(dǎo)致兩種結(jié)果:1. 當(dāng)前沒有鎖(key不存在),那么就進行加鎖操作,并對鎖設(shè)置個有效期,同時value表示加鎖的客戶端。2. 已有鎖存在,不做任何操作。

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

3.2.1 錯誤示例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()方法。

3.2.2 錯誤示例2

這一種錯誤示例就比較難以發(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è)置新的過期時間,返回加鎖成功。代碼如下:

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;

}

那么這段代碼問題在哪里?1. 由于是客戶端自己生成過期時間,所以需要強制要求分布式下每個客戶端的時間必須同步。 2. 當(dāng)鎖過期的時候,如果多個客戶端同時執(zhí)行jedis.getSet()方法,那么雖然最終只有一個客戶端可以加鎖,但是這個客戶端的鎖的過期時間可能被其他客戶端覆蓋。3. 鎖不具備擁有者標(biāo)識,即任何客戶端都可以解鎖。

3.3 解鎖代碼

正確姿勢

還是先展示代碼,再帶大家慢慢解釋為什么這樣實現(xiàn):

    /**
     * 釋放鎖
     *
     * @param lockKey  鎖
     * @param identity 身份標(biāo)識(保證鎖不會被其他人釋放)
     * @return
     */
    public Object releaseLock(String lockKey, String identity) {
        String luaScript = "if " +
                "  redis.call('get', KEYS[1]) == ARGV[1] " +
                "then " +
                "  return redis.call('del', KEYS[1]) " +
                "else " +
                "  return 0 " +
                "end";
        DefaultRedisScript<Boolean> redisScript = new DefaultRedisScript<>();
        redisScript.setResultType(Boolean.class);
        redisScript.setScriptText(luaScript);
        List<String> keys = new ArrayList<>();
        keys.add(lockKey);
        Object result = redisTemplate.execute(redisScript, keys, identity);
        return (boolean) result;
    }

我們寫了一個簡單的Lua腳本代碼。將Lua代碼傳到redisTemplate.execute()方法里,并使參數(shù)KEYS[1]賦值為keys,ARGV[1]賦值為identity。execute()方法是將Lua代碼交給Redis服務(wù)端執(zhí)行。

那么這段Lua代碼的功能是什么呢?其實很簡單,首先獲取鎖對應(yīng)的value值,檢查是否與identity相等,如果相等則刪除鎖(解鎖)。那么為什么要使用Lua語言來實現(xiàn)呢?因為要確保上述操作是原子性的。關(guān)于非原子性會帶來什么問題,可以閱讀【解鎖代碼-錯誤示例2】 。那么執(zhí)行execute()方法可以確保原子性,源于Redis的特性,下面是官網(wǎng)對execute命令的部分解釋。

Lua腳本原子性說明

簡單來說,就是在execute命令執(zhí)行Lua代碼的時候,Lua代碼將被當(dāng)成一個命令去執(zhí)行,并且直到execute命令執(zhí)行完成,Redis才會執(zhí)行其他命令。

3.3.1 錯誤示例1

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

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

3.3.2 錯誤示例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的鎖給解除了。

四、 application.properties

redis配置信息:

spring.application.name=redis-distributed-lock
# 應(yīng)用服務(wù) WEB 訪問端口
server.port=8080
################ Redis 基礎(chǔ)配置 ##############
# Redis數(shù)據(jù)庫索引(默認為0)
spring.redis.database=0
# Redis服務(wù)器地址
spring.redis.host=127.0.0.1
# Redis服務(wù)器連接端口
spring.redis.port=6379
# Redis服務(wù)器連接密碼(默認為空)
spring.redis.password=
# 鏈接超時時間 單位 ms(毫秒)
spring.redis.timeout=3000
################ Redis 線程池設(shè)置 ##############
# 連接池最大連接數(shù)(使用負值表示沒有限制) 默認 8
spring.redis.lettuce.pool.max-active=8
# 連接池最大阻塞等待時間(使用負值表示沒有限制) 默認 -1
spring.redis.lettuce.pool.max-wait=-1
# 連接池中的最大空閑連接 默認 8
spring.redis.lettuce.pool.max-idle=8
# 連接池中的最小空閑連接 默認 0
spring.redis.lettuce.pool.min-idle=0

RedisLockTool.java

package com.erbadagang.springboot.redisdistributedlock.tool;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.data.redis.core.RedisTemplate;
import org.springframework.data.redis.core.script.DefaultRedisScript;
import org.springframework.stereotype.Component;

import java.util.ArrayList;
import java.util.List;
import java.util.concurrent.TimeUnit;

/**
 * @description Redis分布式鎖實現(xiàn)工具類。
 * @ClassName: RedisLockTool
 * @author: 郭秀志 jbcode@126.com
 * @date: 2020/8/2 16:29
 * @Copyright:
 */
@Component
public class RedisLockTool {
    @Autowired
    RedisTemplate redisTemplate;

    /**
     * 獲取鎖
     *
     * @param lockKey    鎖
     * @param identity   身份標(biāo)識(保證鎖不會被其他人釋放)
     * @param expireTime 鎖的過期時間(單位:秒)
     * @return
     */
    public boolean lock(String lockKey, String identity, long expireTime) {
        boolean lockResult = redisTemplate.opsForValue().setIfAbsent(lockKey, identity, expireTime, TimeUnit.SECONDS);
        return lockResult;
    }

    /**
     * 釋放鎖
     *
     * @param lockKey  鎖
     * @param identity 身份標(biāo)識(保證鎖不會被其他人釋放)
     * @return
     */
    public boolean releaseLock(String lockKey, String identity) {
        String luaScript = "if " +
                "  redis.call('get', KEYS[1]) == ARGV[1] " +
                "then " +
                "  return redis.call('del', KEYS[1]) " +
                "else " +
                "  return 0 " +
                "end";
        DefaultRedisScript<Boolean> redisScript = new DefaultRedisScript<>();
        redisScript.setResultType(Boolean.class);
        redisScript.setScriptText(luaScript);
        List<String> keys = new ArrayList<>();
        keys.add(lockKey);
        Object result = redisTemplate.execute(redisScript, keys, identity);
        return (boolean) result;
    }
}

RedisLockController.java

package com.erbadagang.springboot.redisdistributedlock.controller;

import com.erbadagang.springboot.redisdistributedlock.tool.RedisLockTool;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;

/**
 * @description 分布式鎖的測試controller,加鎖和釋放鎖2個url。
 * @ClassName: RedisLockController
 * @author: 郭秀志 jbcode@126.com
 * @date: 2020/8/2 16:31
 * @Copyright:
 */
@RestController
@RequestMapping("distributedLock/")
public class RedisLockController {
    //鎖標(biāo)識key的前綴,后面加上自己的需加鎖業(yè)務(wù)的資源標(biāo)識碼。
    private final String lockPreKey = "DistributedLockKey";

    @Autowired
    private RedisLockTool redisLock;

    /**
     * 測試加鎖
     *
     * @param id       加鎖的資源id
     * @param identity 身份標(biāo)識
     * @return
     */
    @GetMapping("lock")
    public String lock(@RequestParam("id") String id,
                       @RequestParam("identity") String identity) {
        String lockKey = lockPreKey + ":" + id;
        boolean lockSuccess = redisLock.lock(lockKey, identity, 60);
        String result = "lock failed";
        if (lockSuccess) {
            result = "lock success";
        }
        return result;
    }

    /**
     * 測試釋放鎖
     *
     * @param id       釋放鎖的資源id
     * @param identity 身份標(biāo)識
     * @return
     */
    @GetMapping("release")
    public String release(@RequestParam("id") String id,
                          @RequestParam("identity") String identity) {
        String lockKey = lockPreKey + ":" + id;
        boolean releaseSuccess = redisLock.releaseLock(lockKey, identity);
        String result = "release failed";
        if (releaseSuccess) {
            result = "release success";
        }
        return result;
    }
}

實際使用中,identity可以使用String identity = UUID.randomUUID().toString();生成來保證唯一性。

五、測試

啟動Redis和Springboot服務(wù)。

  1. 加鎖功能:
    訪問http://localhost:8080/distributedLock/lock?id=5&identity=erbadagang,返回lock success
  2. 再次訪問上面鏈接http://localhost:8080/distributedLock/lock?id=5&identity=erbadagang,返回lock failed,說明第一次加的鎖還存在。
  3. 修改參數(shù)id值為6來生成新的key,訪問http://localhost:8080/distributedLock/lock?id=6&identity=erbadagang,返回lock success。不同的key代表不同的鎖,互不沖突。
  4. 先加鎖,訪問http://localhost:8080/distributedLock/lock?id=6&identity=erbadagang,再釋放鎖,訪問http://localhost:8080/distributedLock/release?id=6&identity=erbadagang,返回release success。
  5. 如果鎖不存在(沒創(chuàng)建或者已經(jīng)釋放一次),進行釋放鎖,返回release failed。

總結(jié)

本文主要介紹了如何使用Java代碼正確實現(xiàn)Redis分布式鎖,對于加鎖和解鎖也分別給出了兩個比較經(jīng)典的錯誤示例。其實想要通過Redis實現(xiàn)分布式鎖并不難,只要保證能滿足可靠性里的四個條件?;ヂ?lián)網(wǎng)雖然給我們帶來了方便,只要有問題就可以Baidu,然而網(wǎng)上的答案一定是對的嗎?其實不然,所以我們更應(yīng)該時刻保持著質(zhì)疑精神,多想多驗證。

如果你的項目中Redis是多機部署的,那么可以嘗試使用Redisson實現(xiàn)分布式鎖,這是Redis官方提供的Java組件。

此外,實現(xiàn)Redis的分布式鎖,除了自己基于redis client原生api來實現(xiàn)之外,還可以使用開源框架:Redission。Redisson是一個企業(yè)級的開源Redis Client,也提供了分布式鎖的支持。我也非常推薦大家使用,為什么呢?
回想一下上面說的,如果自己寫代碼來通過redis設(shè)置一個值,是通過下面這個命令設(shè)置的。
SET anyLock unique_value NX PX 30000
這里設(shè)置的超時時間是30s,假如我超過30s都還沒有完成業(yè)務(wù)邏輯的情況下,key會過期,其他線程有可能會獲取到鎖。
這樣一來的話,第一個線程還沒執(zhí)行完業(yè)務(wù)邏輯,第二個線程進來了也會出現(xiàn)線程安全問題。所以我們還需要額外的去維護這個過期時間,太麻煩了~

底線


本文源代碼使用 Apache License 2.0開源許可協(xié)議,這里是本文源碼Gitee地址,可通過命令git clone+地址下載代碼到本地,也可直接點擊鏈接通過瀏覽器方式查看源代碼。

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時請結(jié)合常識與多方信息審慎甄別。
平臺聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點,簡書系信息發(fā)布平臺,僅提供信息存儲服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

友情鏈接更多精彩內(nèi)容