Redis中怎么實(shí)現(xiàn)一個分布式文件夾鎖

Redis中怎么實(shí)現(xiàn)一個分布式文件夾鎖，很多新手對此不是很清楚，為了幫助大家解決這個難題，下面小編將為大家詳細(xì)講解，有這方面需求的人可以來學(xué)習(xí)下，希望你能有所收獲。

思考和調(diào)研

分布式鎖常見的三種實(shí)現(xiàn)方式：數(shù)據(jù)庫、zookeeper/etcd（臨時(shí)有序節(jié)點(diǎn)）、redis（setnx/lua腳本），各有千秋。

數(shù)據(jù)庫實(shí)現(xiàn)分布式鎖

實(shí)現(xiàn)

原理簡單易實(shí)現(xiàn)，創(chuàng)建一張lock表，存儲鎖定的資源、上鎖對象、獲取鎖的資源、獲取鎖時(shí)間等，獲取鎖時(shí)查詢該資源是否存在記錄，存在且未過失效時(shí)間則獲取鎖失敗，不存在則插入一條數(shù)據(jù)并且獲取鎖成功；釋放鎖則更簡單，刪除鎖數(shù)據(jù)即可。

缺點(diǎn)

• 釋放鎖刪除數(shù)據(jù)時(shí)，會出現(xiàn)死鎖情況

優(yōu)點(diǎn)

• 實(shí)現(xiàn)簡單

zookeeper/etcd實(shí)現(xiàn)分布式鎖

詳見zookeeper總結(jié)

redis實(shí)現(xiàn)分布式鎖

詳見Redis總結(jié)

分布式文件夾鎖實(shí)現(xiàn)過程

基于開文處所列情況，要覆蓋所有復(fù)雜情況很難，但是實(shí)現(xiàn)基本的文件夾鎖是必須的，故選擇了redis+lua腳本，具體代碼如下

java獲取鎖工具類

/**
 * redis工具類
 */
public class RedisLockUtils {

    static final Long SUCCESS = 1L;
    static final String LOCKED_HASH = "cs:lockedHashKey";
    static final String GET_LOCK_LUA_RESOURCE = "/lua/getFileLock.lua";
    static final String RELEASE_LOCK_LUA_RESOURCE = "/lua/releaseFileLock.lua";
    static final Logger LOG = LoggerFactory.getLogger(RedisLockUtils.class);
    
    /**
     * 獲取文件夾鎖
     * @param redisTemplate
     * @param lockProjectId
     * @param lockKey
     * @param requestValue
     * @param expireTime 單位：秒
     * @return
     */
    public static boolean getFileLock(RedisTemplate redisTemplate, Long lockProjectId, String lockKey, String requestValue, Integer expireTime) {

        LOG.info("start run lua script，{{}} start request lock",lockKey);
        long start = System.currentTimeMillis();
        DefaultRedisScript<String> luaScript =new DefaultRedisScript<>();
        luaScript.setLocation(new ClassPathResource(GET_LOCK_LUA_RESOURCE));
        luaScript.setResultType(String.class);

        Object result = redisTemplate.execute(
                luaScript,
                Arrays.asList(lockKey, LOCKED_HASH + lockProjectId),
                requestValue,
                String.valueOf(expireTime),
                String.valueOf(System.currentTimeMillis())
        );
        boolean getLockStatus = SUCCESS.equals(result);

        LOG.info("{{}} cost time {} ms，request lock result：{}",lockKey,(System.currentTimeMillis()-start), getLockStatus);
        return getLockStatus;
    }

    /**
     * 釋放文件夾鎖
     * @param redisTemplate
     * @param lockProjectId
     * @param lockKey
     * @param requestValue
     * @return
     */
    public static boolean releaseFileLock(RedisTemplate redisTemplate, Long lockProjectId, String lockKey, String requestValue) {

        DefaultRedisScript<String> luaScript =new DefaultRedisScript<>();
        luaScript.setLocation(new ClassPathResource(RELEASE_LOCK_LUA_RESOURCE));
        luaScript.setResultType(String.class);

        Object result = redisTemplate.execute(
                luaScript,
                Arrays.asList(lockKey, LOCKED_HASH + lockProjectId),
                requestValue
        );
        boolean releaseLockStatus = SUCCESS.equals(result);

        LOG.info("{{}}release lock result：{}", lockKey, releaseLockStatus);
        return releaseLockStatus;
    }

}

lua腳本

獲取文件夾鎖

入?yún)⒄f明

requestKey為請求鎖的路徑，requestValue為請求鎖的value，應(yīng)為請求鎖時(shí)生成的UUID，確保解鎖人只能為上鎖人，lockedKeys為存放所有鎖的哈希表的key，這里用常量加項(xiàng)目id的方式，確保一個項(xiàng)目的所有鎖存在一個哈希表里面，expireTime為鎖的過期時(shí)間，nowTime為當(dāng)前時(shí)間，由于lua腳本里面獲取當(dāng)前時(shí)間消耗性能且獲取的是redis服務(wù)器上的當(dāng)前時(shí)間，可能不準(zhǔn)確。

思路說明

首先，通過GET key判斷是否有人正在操作這個文件夾，若有人在操作則直接返回0（獲取鎖失?。?，否則獲取存放該項(xiàng)目鎖的哈希表里面的所有key，遍歷所有key，通過lua腳本的string.find函數(shù)對比該key和請求的key是否存在包含或被包含關(guān)系，若存在包含關(guān)系且未失效，則返回0（獲取鎖失?。?，否則則可獲取鎖，設(shè)置key和過期時(shí)間及存入哈希表（哈希表內(nèi)存放請求鎖的key和請求時(shí)間），最后返回1（獲取鎖成功）。

例如請求上圖中項(xiàng)目下的C文件夾的鎖，請求路徑為：項(xiàng)目/A/C，當(dāng)另一個人想操作D文件夾，請求路徑為：項(xiàng)目/A/C/D，此時(shí)查詢到存儲這個項(xiàng)目所有鎖定key的哈希表，里面包含項(xiàng)目/A/C這個key，這兩個key通過lua函數(shù)string.find發(fā)現(xiàn)項(xiàng)目/A/C/D包含項(xiàng)目/A/C，且未到過期時(shí)間，則獲取鎖失敗，否則獲取鎖成功。

local requestKey=KEYS[1]
local lockedKeys=KEYS[2]
local requestValue=ARGV[1]
local expireTime=ARGV[2]
local nowTime=ARGV[3]
if redis.call('get',requestKey)
then
    return 0
end
local lockedHash = redis.call('hkeys',lockedKeys)
for i=1, #lockedHash do
    if string.find(requestKey,lockedHash[i]) or string.find(lockedHash[i],requestKey)
    then
        local lockTime = redis.call('hget',lockedKeys,lockedHash[i])
        if (nowTime-lockTime) >= expireTime * 1000
        then
            redis.call('hdel',lockedKeys,lockedHash[i])
        else
            return 0
        end
    end
end
redis.call('set',requestKey,requestValue)
redis.call('expire',requestKey,expireTime)
redis.call('hset',lockedKeys,requestKey,nowTime)
return 1

釋放文件夾鎖

入?yún)⒄f明

requestKey為請求鎖的路徑，requestValue為請求鎖的value，應(yīng)為請求鎖時(shí)生成的UUID，確保解鎖人只能為上鎖人，lockedKeys為存放所有鎖的哈希表的key，這里用常量加項(xiàng)目id的方式，確保一個項(xiàng)目的所有鎖存在一個哈希表里面。

local requestKey=KEYS[1]
local lockedKeys=KEYS[2]
local requestValue=ARGV[1]
if redis.call('get', requestKey) == requestValue
then
    redis.call('hdel', lockedKeys,requestKey)
    return redis.call('del',requestKey)
else
    return 0
end

優(yōu)點(diǎn)

1. 靈活，鎖定的范圍可以隨requestKey變化而變化

2. 性能不錯，經(jīng)測試除了第一次lua腳本未緩存耗時(shí)較長，第二次之后則在10ms左右可得到請求結(jié)果

缺點(diǎn)

1. 可靠性依賴redis

2. 不是可重入鎖

3. 維護(hù)成本較高，需熟知redis的5種數(shù)據(jù)結(jié)構(gòu)及l(fā)ua腳本

看完上述內(nèi)容是否對您有幫助呢？如果還想對相關(guān)知識有進(jìn)一步的了解或閱讀更多相關(guān)文章，請關(guān)注億速云行業(yè)資訊頻道，感謝您對億速云的支持。