快捷導(dǎo)航

基于Redis實現(xiàn)分布式鎖的方法（lua腳本版）

更新時間：2021年05月12日 10:44:30 作者：總有人想害朕

這篇文章主要介紹了基于Redis實現(xiàn)分布式鎖的方法（lua腳本版）,本文給大家介紹的非常詳細(xì)，對大家的學(xué)習(xí)或工作具有一定的參考借鑒價值，需要的朋友可以參考下

1、前言

在Java中，我們通過鎖來避免由于競爭而造成的數(shù)據(jù)不一致問題。通常我們使用synchronized 、Lock來實現(xiàn)。但是Java中的鎖只能保證在同一個JVM進程內(nèi)中可用，在跨JVM進程，例如分布式系統(tǒng)上則不可靠了。

2、分布式鎖

分布式鎖，是一種思想，它的實現(xiàn)方式有很多，如基于數(shù)據(jù)庫實現(xiàn)、基于緩存（Redis等）實現(xiàn)、基于Zookeeper實現(xiàn)等等。為了確保分布式鎖可用，我們至少要確保鎖的實現(xiàn)同時滿足以下四個條件

互斥性：在任意時刻，只有一個客戶端能持有鎖。
不會發(fā)生死鎖：即使客戶端在持有鎖的期間崩潰而沒有主動解鎖，也能保證后續(xù)其他客戶端能加鎖。
具有容錯性：只要大部分的Redis節(jié)點正常運行，客戶端就可以加鎖和解鎖。
解鈴還須系鈴人：加鎖和解鎖必須是同一個客戶端，客戶端自己不能把別人加的鎖給解了。

3、基于Redis實現(xiàn)分布式鎖

以下代碼實現(xiàn)了基于redis中間件的分布式鎖。加鎖的過程中為了保障setnx（設(shè)置KEY）和expire（設(shè)置超時時間）盡可能在一個事務(wù)中，使用到了lua腳本的方式，將需要完成的指令一并提交到redis中；

3.1、RedisConfig.java

package com.demo.configuration;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.data.redis.connection.RedisConnectionFactory;
import org.springframework.data.redis.core.RedisTemplate;
import org.springframework.data.redis.serializer.GenericJackson2JsonRedisSerializer;
import org.springframework.data.redis.serializer.StringRedisSerializer;

@Configuration
public class RedisConfig {

    @Bean
    public RedisTemplate<String, Object> redisTemplate(RedisConnectionFactory factory) {
        RedisTemplate<String, Object> template = new RedisTemplate<>();
        template.setConnectionFactory(factory);
        // key采用String的序列化方式
        template.setKeySerializer(new StringRedisSerializer());
        // value序列化方式采用jackson
        template.setValueSerializer(new GenericJackson2JsonRedisSerializer());
        template.afterPropertiesSet();
        return template;
    }

}

3.2、RedisLockController.java

package com.demo.controller;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.core.io.ClassPathResource;
import org.springframework.data.redis.core.RedisTemplate;
import org.springframework.data.redis.core.script.DefaultRedisScript;
import org.springframework.scripting.support.ResourceScriptSource;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import java.util.Arrays;

@RestController
@RequestMapping("/redis")
public class RedisLockController {

    @Autowired
    private RedisTemplate<String, Object> redisTemplate;

    @RequestMapping(value = "/lock/{key}/{uid}/{expire}")
    public Long lock(@PathVariable("key") String key, @PathVariable("uid") String uid, @PathVariable("expire") Integer expire) {
        Long result = null;
        try {
            //調(diào)用lua腳本并執(zhí)行
            DefaultRedisScript<Long> redisScript = new DefaultRedisScript<>();
            redisScript.setResultType(Long.class);//返回類型是Long
            //lua文件存放在resources目錄下的redis文件夾內(nèi)
            redisScript.setScriptSource(new ResourceScriptSource(new ClassPathResource("redis/redis_lock.lua")));
            result = redisTemplate.execute(redisScript, Arrays.asList(key), uid, expire);
            System.out.println("lock==" + result);
        } catch (Exception e) {
            e.printStackTrace();
        }
        return result;
    }

    @RequestMapping(value = "/unlock/{key}/{uid}")
    public Long unlock(@PathVariable("key") String key, @PathVariable("uid") String uid) {
        Long result = null;
        try {
            //調(diào)用lua腳本并執(zhí)行
            DefaultRedisScript<Long> redisScript = new DefaultRedisScript<>();
            redisScript.setResultType(Long.class);//返回類型是Long
            //lua文件存放在resources目錄下的redis文件夾內(nèi)
            redisScript.setScriptSource(new ResourceScriptSource(new ClassPathResource("redis/redis_unlock.lua")));
            result = redisTemplate.execute(redisScript, Arrays.asList(key), uid);
            System.out.println("unlock==" + result);
        } catch (Exception e) {
            e.printStackTrace();
        }
        return result;
    }

}

3.3、redis_lock.lua

if redis.call('setnx',KEYS[1],ARGV[1]) == 1 then
    return redis.call('expire',KEYS[1],ARGV[2])
else
    return 0
end

3.4、redis_unlock.lua

if redis.call("exists",KEYS[1]) == 0 then
    return 1
end

if redis.call('get',KEYS[1]) == ARGV[1] then
    return redis.call('del',KEYS[1])
else
    return 0
end