SpringBoot + Redis 分佈式鎖:模擬搶單(附實現源碼)

前言

前段時間面試時被頻繁問到一個Redis的問題就是如何通過Redis實現分佈式鎖,自己雖然平時使用Redis,但是並沒有去實現過這個問題,今天正好看到一篇公衆號文章,就通過代碼去實現該問題。

實現Redis的分佈式鎖,通過setNx來實現的,這就涉及到了創建鎖以及刪除鎖。

這其中需要考慮的問題爲:

  • nx生成鎖
  • 模擬搶單動作
  • 如何刪除鎖

Java中操作Redis通過jedis來實現,因此首先引入pom依賴

<dependency>
    <groupId>redis.clients</groupId>
    <artifactId>jedis</artifactId>
</dependency>

對於分佈式鎖的生成通常需要注意如下幾個方面:

  • 創建鎖的策略:redis的普通key一般都允許覆蓋,A用戶set某個key後,B在set相同的key時同樣能成功,如果是鎖場景,那就無法知道到底是哪個用戶set成功的;這裏jedis的setnx方式爲我們解決了這個問題,簡單原理是:當A用戶先set成功了,那B用戶set的時候就返回失敗,滿足了某個時間點只允許一個用戶拿到鎖。
  • 鎖過期時間:某個搶購場景時候,如果沒有過期的概念,當A用戶生成了鎖,但是後面的流程被阻塞了一直無法釋放鎖,那其他用戶此時獲取鎖就會一直失敗,無法完成搶購的活動;當然正常情況一般都不會阻塞,A用戶流程會正常釋放鎖;過期時間只是爲了更有保障。

下面通過代碼來實現加鎖操作:


import org.springframework.context.annotation.Configuration;
import redis.clients.jedis.Jedis;
import redis.clients.jedis.JedisPool;
import redis.clients.jedis.JedisPoolConfig;
import redis.clients.jedis.params.SetParams;

/**
 * @author v_vllchen
 */
@Configuration
public class JedisConfig {
    private static  JedisPool jedisPool;
    /**
     * 初始化jedisPool
     */
    static {
        JedisPoolConfig config = new JedisPoolConfig();
        config.setMaxTotal(1024);
        config.setMaxIdle(10);
        config.setMaxWaitMillis(1000);
        config.setTestOnBorrow(true);
        config.setTestOnReturn(true);
        jedisPool = new JedisPool(config, "127.0.0.1", 6379, 2000,"123456");
    }
    /**
     * 加鎖
     * @param key
     * @param val
     * @return
     */
    public boolean setnx(String key, String val) {
        Jedis jedis = null;
        try {
            jedis = jedisPool.getResource();
            if (jedis == null) {
                return false;
            }
            SetParams params = new SetParams();
            params.nx();
            params.px(1000*60);
            boolean b = jedis.set(key, val,params).
                    equalsIgnoreCase("ok");
            return b;
        } catch (Exception ex) {
        } finally {
            if (jedis != null) {
                jedis.close();
            }
        }
        return false;
    }

    /**
     * 刪除鎖
     * @param key
     * @param val
     * @return
     */
    public int delnx(String key, String val) {
        Jedis jedis = null;
        try {
            jedis = jedisPool.getResource();
            if (jedis == null) {
                return 0;
            }
            //if redis.call('get','orderkey')=='1111' then return redis.call('del','orderkey') else return 0 end
            StringBuilder sbScript = new StringBuilder();
            sbScript.append("if redis.call('get','").append(key).append("')").append("=='").append(val).append("'").
                    append(" then ").
                    append("    return redis.call('del','").append(key).append("')").
                    append(" else ").
                    append("    return 0").
                    append(" end");

            return Integer.valueOf(jedis.eval(sbScript.toString()).toString());
        } catch (Exception ex) {
        } finally {
            if (jedis != null) {
                jedis.close();
            }
        }
        return 0;
    }
}

這裏注意點在於jedis的set方法,其參數的說明如:

  • NX:是否存在key,存在就不set成功
  • PX:key過期時間單位設置爲毫秒(EX:單位秒)

setnx如果失敗直接封裝返回false即可,下面我們通過一個get方式的api來調用下這個setnx方法:

    @GetMapping("/setnx/{key}/{val}")
    public boolean setnx(@PathVariable String key, @PathVariable String val) {
        return jedisConfig.setnx(key, val);
    }

訪問如下測試url,正常來說第一次返回了true,第二次返回了false,由於第二次請求的時候redis的key已存在,所以無法set成功
由上圖能夠看到只有一次set成功,並key具有一個有效時間,此時已到達了分佈式鎖的條件。
在這裏插入圖片描述
在這裏插入圖片描述
如何刪除鎖

上面是創建鎖,同樣的具有有效時間,但是我們不能完全依賴這個有效時間,場景如:有效時間設置1分鐘,本身用戶A獲取鎖後,沒遇到什麼特殊情況正常生成了搶購訂單後,此時其他用戶應該能正常下單了纔對,但是由於有個1分鐘後鎖才能自動釋放,那其他用戶在這1分鐘無法正常下單(因爲鎖還是A用戶的),因此我們需要A用戶操作完後,主動去解鎖:(代碼在上面的配置類中)

 /**
     * 刪除鎖
     * @param key
     * @param val
     * @return
     */
    public int delnx(String key, String val) {
        Jedis jedis = null;
        try {
            jedis = jedisPool.getResource();
            if (jedis == null) {
                return 0;
            }
            //if redis.call('get','orderkey')=='1111' then return redis.call('del','orderkey') else return 0 end
            StringBuilder sbScript = new StringBuilder();
            sbScript.append("if redis.call('get','").append(key).append("')").append("=='").append(val).append("'").
                    append(" then ").
                    append("    return redis.call('del','").append(key).append("')").
                    append(" else ").
                    append("    return 0").
                    append(" end");

            return Integer.valueOf(jedis.eval(sbScript.toString()).toString());
        } catch (Exception ex) {
        } finally {
            if (jedis != null) {
                jedis.close();
            }
        }
        return 0;
    }

這裏也使用了jedis方式,直接執行lua腳本:根據val判斷其是否存在,如果存在就del;

其實個人認爲通過jedis的get方式獲取val後,然後再比較value是否是當前持有鎖的用戶,如果是那最後再刪除,效果其實相當;只不過直接通過eval執行腳本,這樣避免多一次操作了redis而已,縮短了原子操作的間隔。(如有不同見解請留言探討);同樣這裏創建個get方式的api來測試:

    @GetMapping("/delnx/{key}/{val}")
    public int delnx(@PathVariable String key, @PathVariable String val) {
        return jedisConfig.delnx(key, val);
    }

注意的是delnx時,需要傳遞創建鎖時的value,因爲通過et的value與delnx的value來判斷是否是持有鎖的操作請求,只有value一樣才允許del;

模擬搶單動作(10w個人開搶)

有了上面對分佈式鎖的粗略基礎,我們模擬下10w人搶單的場景,其實就是一個併發操作請求而已,由於環境有限,只能如此測試;如下初始化10w個用戶,並初始化庫存,商品等信息,如下代碼:


import com.example.redis.config.JedisConfig;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.util.StringUtils;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import javax.annotation.Resource;
import java.util.ArrayList;
import java.util.List;
import java.util.concurrent.TimeUnit;
import java.util.stream.IntStream;

/**
 * @author v_vllchen
 */
@RestController
@RequestMapping("/test")
public class TestController {
    private Logger logger = LoggerFactory.getLogger(getClass());
    @Resource
    private JedisConfig jedisConfig;


    //總庫存
    private long stock = 0;
    //商品key名字
    private String goodsKey = "goods_key";
    //獲取鎖的超時時間 秒
    private int timeout = 30 * 1000;

    @GetMapping("/getOrder")
    public List<String> getOrder() {
        //搶到商品的用戶
        List<String> shopUsers = new ArrayList<>();
        //構造很多用戶
        List<String> users = new ArrayList<>();
        IntStream.range(0, 100000).parallel().forEach(b -> {
            users.add("測試用戶-" + b);
        });

        //初始化庫存
        stock = 10;
        //模擬開搶
        users.parallelStream().forEach(b -> {
            String shopUser = start(b);
            if (!StringUtils.isEmpty(shopUser)) {
                shopUsers.add(shopUser);
            }
        });

        return shopUsers;
    }
    /**
     * 模擬搶單動作
     *
     * @param b
     * @return
     */
    private String start(String b) {
        //用戶開搶時間
        long startTime = System.currentTimeMillis();

        //未搶到的情況下,30秒內繼續獲取鎖
        while ((startTime + timeout) >= System.currentTimeMillis()) {
            //商品是否剩餘
            if (stock <= 0) {
                break;
            }
            if (jedisConfig.setnx(goodsKey, b)) {
                //用戶b拿到鎖
                logger.info("用戶{}拿到鎖...", b);
                try {
                    //商品是否剩餘
                    if (stock <= 0) {
                        break;
                    }
                    //模擬生成訂單耗時操作,方便查看:神牛-50 多次獲取鎖記錄
                    try {
                        TimeUnit.SECONDS.sleep(1);
                    } catch (InterruptedException e) {
                        e.printStackTrace();
                    }

                    //搶購成功,商品遞減,記錄用戶
                    stock -= 1;
                    //搶單成功跳出
                    logger.info("用戶{}搶單成功跳出...所剩庫存:{}", b, stock);

                    return b + "搶單成功,所剩庫存:" + stock;
                } finally {
                    logger.info("用戶{}釋放鎖...", b);
                    //釋放鎖
                    jedisConfig.delnx(goodsKey, b);
                }
            } else {
                //用戶b沒拿到鎖,在超時範圍內繼續請求鎖,不需要處理
//                if (b.equals("神牛-50") || b.equals("神牛-69")) {
//                    logger.info("用戶{}等待獲取鎖...", b);
//                }
            }
        }
        return "";
    }

    @GetMapping("/setnx/{key}/{val}")
    public boolean setnx(@PathVariable String key, @PathVariable String val) {
        return jedisConfig.setnx(key, val);
    }
    @GetMapping("/delnx/{key}/{val}")
    public int delnx(@PathVariable String key, @PathVariable String val) {
        return jedisConfig.delnx(key, val);
    }


}

這裏實現的邏輯是:

  • parallelStream():並行流模擬多用戶搶購
  • (startTime + timeout) >=
    System.currentTimeMillis():判斷未搶成功的用戶,timeout秒內繼續獲取鎖
  • 獲取鎖前和後都判斷庫存是否還足夠
  • jedisCom.setnx(shangpingKey, b):用戶獲取搶購鎖
  • 獲取鎖後並下單成功,最後釋放鎖:jedisCom.delnx(shangpingKey, b)
    在這裏插入圖片描述

項目已上傳到GitHub中,可以下載自己看

源碼地址

結語:

終於實現了該問題,也通過代碼的實現瞭解了分佈式鎖的邏輯,也懂了該如何操作Redis鎖。

我是一個走在學習路上、膜拜大佬的程序員!

在這裏插入圖片描述

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章