自己動手基於 Redis 實現一個 .NET 的分散式鎖類庫

来源:https://www.cnblogs.com/berkerdong/archive/2022/12/09/16968339.html
-Advertisement-
Play Games

分散式鎖的核心其實就是採用一個集中式的服務，然後多個應用節點進行搶占式鎖定來進行實現，今天介紹如何採用Redis作為基礎服務，實現一個分散式鎖的類庫，本方案不考慮 Redis 集群多節點問題，如果引入集群多節點問題，會導致解決成本大幅上升，因為 Redis 單節點就可以很容易的處理10萬併發量了，這 ...


分散式鎖的核心其實就是採用一個集中式的服務，然後多個應用節點進行搶占式鎖定來進行實現，今天介紹如何採用Redis作為基礎服務，實現一個分散式鎖的類庫，本方案不考慮 Redis 集群多節點問題，如果引入集群多節點問題，會導致解決成本大幅上升，因為 Redis 單節點就可以很容易的處理10萬併發量了，這對於日常開發中 99% 的項目足夠使用了。

目標如下：

  1. 支持 using 語法，出 using 範圍之後自動釋放鎖
  2. 支持 嘗試行為，如果鎖獲取不到則直接跳過不等待
  3. 支持 等待行為，如果鎖獲取不到則持續等待直至超過設置的等待時間
  4. 支持信號量控制，實現一個鎖可以同時獲取到幾次，方便對一些方法進行併發控制

代碼整體結構圖

創建 DistributedLock 類庫，然後定義介面文件 IDistributedLock ，方便我們後期擴展其他分散式鎖的實現。

namespace DistributedLock
{
    public interface IDistributedLock
    {

        /// <summary>
        /// 獲取鎖
        /// </summary>
        /// <param name="key">鎖的名稱，不可重覆</param>
        /// <param name="expiry">失效時長</param>
        /// <param name="semaphore">信號量</param>
        /// <returns></returns>
        public IDisposable Lock(string key, TimeSpan expiry = default, int semaphore = 1);

        /// <summary>
        /// 嘗試獲取鎖
        /// </summary>
        /// <param name="key">鎖的名稱，不可重覆</param>
        /// <param name="expiry">失效時長</param>
        /// <param name="semaphore">信號量</param>
        /// <returns></returns>
        public IDisposable? TryLock(string key, TimeSpan expiry = default, int semaphore = 1);

    }
}

創建 DistributedLock.Redis 類庫，安裝下麵兩個 Nuget 包

StackExchange.Redis
Microsoft.Extensions.Options

定義配置模型 RedisSetting

namespace DistributedLock.Redis.Models
{
    public class RedisSetting
    {
        public string Configuration { get; set; }

        public string InstanceName { get; set; }
    }
}

定義 RedisLockHandle

using StackExchange.Redis;

namespace DistributedLock.Redis
{
    public class RedisLockHandle : IDisposable
    {

        public IDatabase Database { get; set; }

        public string LockKey { get; set; }

        public void Dispose()
        {
            try
            {
                Database.LockRelease(LockKey, "123456");
            }
            catch
            {
            }

            GC.SuppressFinalize(this);
        }
    }
}

實現 RedisLock

using DistributedLock.Redis.Models;
using Microsoft.Extensions.Options;
using StackExchange.Redis;
using System.Security.Cryptography;
using System.Text;

namespace DistributedLock.Redis
{
    public class RedisLock : IDistributedLock
    {

        private readonly ConnectionMultiplexer connectionMultiplexer;

        private readonly RedisSetting redisSetting;

        public RedisLock(IOptionsMonitor<RedisSetting> config)
        {
            connectionMultiplexer = ConnectionMultiplexer.Connect(config.CurrentValue.Configuration);
            redisSetting = config.CurrentValue;
        }


        /// <summary>
        /// 獲取鎖
        /// </summary>
        /// <param name="key">鎖的名稱，不可重覆</param>
        /// <param name="expiry">失效時長</param>
        /// <param name="semaphore">信號量</param>
        /// <returns></returns>
        public IDisposable Lock(string key, TimeSpan expiry = default, int semaphore = 1)
        {

            if (expiry == default)
            {
                expiry = TimeSpan.FromMinutes(1);
            }

            var endTime = DateTime.UtcNow + expiry;

            RedisLockHandle redisLockHandle = new();

        StartTag:
            {
                for (int i = 0; i < semaphore; i++)
                {
                    var keyMd5 = redisSetting.InstanceName + Convert.ToHexString(MD5.HashData(Encoding.UTF8.GetBytes(key + i)));

                    try
                    {
                        var database = connectionMultiplexer.GetDatabase();

                        if (database.LockTake(keyMd5, "123456", expiry))
                        {
                            redisLockHandle.LockKey = keyMd5;
                            redisLockHandle.Database = database;
                            return redisLockHandle;
                        }
                    }
                    catch
                    {

                    }
                }


                if (redisLockHandle.LockKey == default)
                {

                    if (DateTime.UtcNow < endTime)
                    {
                        Thread.Sleep(1000);
                        goto StartTag;
                    }
                    else
                    {
                        throw new Exception("獲取鎖" + key + "超時失敗");
                    }
                }
            }

            return redisLockHandle;
        }


        public IDisposable? TryLock(string key, TimeSpan expiry = default, int semaphore = 1)
        {

            if (expiry == default)
            {
                expiry = TimeSpan.FromMinutes(1);
            }


            for (int i = 0; i < semaphore; i++)
            {
                var keyMd5 = redisSetting.InstanceName + Convert.ToHexString(MD5.HashData(Encoding.UTF8.GetBytes(key + i)));

                try
                {
                    var database = connectionMultiplexer.GetDatabase();

                    if (database.LockTake(keyMd5, "123456", expiry))
                    {
                        RedisLockHandle redisLockHandle = new()
                        {
                            LockKey = keyMd5,
                            Database = database
                        };
                        return redisLockHandle;
                    }
                }
                catch
                {
                }
            }
            return null;

        }
    }
}

定義 ServiceCollectionExtensions

using DistributedLock.Redis.Models;
using Microsoft.Extensions.DependencyInjection;

namespace DistributedLock.Redis
{
    public static class ServiceCollectionExtensions
    {
        public static void AddRedisLock(this IServiceCollection services, Action<RedisSetting> action)
        {
            services.Configure(action);
            services.AddSingleton<IDistributedLock, RedisLock>();
        }
    }
}

使用時只要在配置文件中加入 redis 連接字元串信息，然後註入服務即可。
appsettings.json

{
  "ConnectionStrings": {
    "redisConnection": "127.0.0.1,Password=123456,DefaultDatabase=0"
  }
}

註入示例代碼：

//註冊分散式鎖 Redis模式
builder.Services.AddRedisLock(options =>
{
    options.Configuration = builder.Configuration.GetConnectionString("redisConnection")!;
    options.InstanceName = "lock";
});

使用示例

using DistributedLock;
using Microsoft.AspNetCore.Mvc;

namespace WebAPI.Controllers
{

    [Route("[controller]")]
    [ApiController]
    public class DemoController : ControllerBase
    {


        private readonly IDistributedLock distLock;

        public DemoController(IDistributedLock distLock)
        {
            this.distLock = distLock;
        }


        [HttpGet("Test")]
        public void Test()
        {

            //鎖定鍵只要是一個字元串即可，可以簡單理解為鎖的標識名字，可以是用戶名，用戶id ，訂單id 等等，根據業務需求自己定義
            string lockKey = "xx1";


            using (distLock.Lock(lockKey))
            {
                //代碼塊同時只有一個請求可以進來執行，其餘沒有獲取到鎖的全部處於等待狀態
                //鎖定時常1分鐘，1分鐘後無論代碼塊是否執行完成鎖都會被釋放，同時等待時常也為1分鐘，1分鐘後還沒有獲取到鎖，則拋出異常
            }


            using (distLock.Lock(lockKey, TimeSpan.FromSeconds(300)))
            {
                //代碼塊同時只有一個請求可以進來執行，其餘沒有獲取到鎖的全部處於等待狀態
                //鎖定時常300秒，300秒後無論代碼塊是否執行完成鎖都會被釋放，同時等待時常也為300秒，300秒後還沒有獲取到鎖，則拋出異常
            }


            using (distLock.Lock(lockKey, TimeSpan.FromSeconds(300), 5))
            {
                //代碼塊同時有五個請求可以進來執行，其餘沒有獲取到鎖的全部處於等待狀態
                //鎖定時常300秒，300秒後無論代碼塊是否執行完成鎖都會被釋放，同時等待時常也為300秒，300秒後還沒有獲取到鎖，則拋出異常

                //該代碼塊有5個請求同時拿到鎖，簽發出去的5把鎖，每把鎖的時間都是單獨計算的，並非300秒後 5個鎖會全部同時釋放，可能只會釋放 2個或3個，釋放之後心的請求又可以獲取到，總之最多只有5個請求可以進入
            }


            var lockHandle1 = distLock.TryLock(lockKey);

            if (lockHandle1 != null)
            {
                //代碼塊同時只有一個請求可以進來執行，其餘沒有獲取到鎖的直接為 null 不等待，也不執行
                //鎖定時常1分鐘，1分鐘後無論代碼塊是否執行完成鎖都會被釋放
            }

            var lockHandle2 = distLock.TryLock(lockKey, TimeSpan.FromSeconds(300));

            if (lockHandle2 != null)
            {
                //代碼塊同時只有一個請求可以進來執行，其餘沒有獲取到鎖的直接為 null 不等待，也不執行
                //鎖定時常300秒，300秒後無論代碼塊是否執行完成鎖都會被釋放
            }


            var lockHandle3 = distLock.TryLock(lockKey, TimeSpan.FromSeconds(300), 5);

            if (lockHandle3 != null)
            {
                //代碼塊同時有五個請求可以進來執行，其餘沒有獲取到鎖的直接為 null 不等待，也不執行
                //鎖定時常300秒，300秒後無論代碼塊是否執行完成鎖都會被釋放

                //該代碼塊有5個請求同時拿到鎖，簽發出去的5把鎖，每把鎖的時間都是單獨計算的，並非300秒後 5個鎖會全部同時釋放，可能只會釋放 2個或3個，釋放之後心的請求又可以獲取到，總之最多只有5個請求可以進入
            }
        }

    }
}

至此關於 自己動手基於 Redis 實現一個 .NET 的分散式鎖類庫 就講解完了，有任何不明白的，可以在文章下麵評論或者私信我，歡迎大家積極的討論交流，有興趣的朋友可以關註我目前在維護的一個 .NET 基礎框架項目，項目地址如下
https://github.com/berkerdong/NetEngine.git
https://gitee.com/berkerdong/NetEngine.git


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • 每日演算法之字元串的排列
    JZ38 字元串的排列 描述 輸入一個長度為 n 字元串，列印出該字元串中字元的所有排列，你可以以任意順序返回這個字元串數組。 例如輸入字元串ABC,則輸出由字元A,B,C所能排列出來的所有字元串ABC,ACB,BAC,BCA,CBA和CAB。 題目主要信息 給定一個長度為n的字元串，求其中所有字元 ...
  • 進位制數的靈活運用
    簡單記錄一下springboot引用kettle對接數據 第一步（這一步講述了下載kettle、創建資料庫連接、轉換等，如果這一步會的可以略過，直接看第二步） 先從kettle官網下載kettle，官網地址：https://sourceforge.net/projects/pentaho/ 進入官網 ...
  • python基礎-模塊和包
    1.什麼是python的包 包就是一個文件夾，裡面放著一個個py文件或子包； 在包中可以被調用的一個個py文件，我們叫做模塊； 如上，test就是一個包、two.py就是test下的一個模塊，child是子包，結構和test包一樣； 包的身份證 可以看到test下還有一個__init__.py命名的 ...
  • 彙編指令
    add add 目的,源 ; 加法指令，結果放入目操作數，操作數的長度必須相同 adc adc 目的,源 ; 帶進位加法，目的=目的+源+CF and and 目的,源 ; 邏輯按位與 指令，結果放到目的操作數。 ; 影響標誌位OF、SF、ZF、PF和CF。 call call s ; 使call ...
  • PHP Firebase HTTP v1 API 新版推送
    //最近一個公司項目需要對接firebase推送，官方文檔就是謝特,再網上找了很多大神的資料，還是有很多坑，把自己踩的坑記錄一下,平時都是伸手黨，這次回饋一下 use Google\Client; /** * 註意需要準備vpn * 1.安裝sdk composer require google/a ...
  • SSM總結
    SSM Spring IOC（控制反轉）& DI（依賴註入） IOC是容器，用來裝Spring創建的Bean對象。 Bean註入方式 Set方法註入 構造器註入 @Autowared自動註入 <!-- SpringBean的註入方式 --> <!-- 手動裝配 --> <!-- == set方法註入 ...
  • 想早點下班？試試Aorm庫吧，更方便的進行Go資料庫操作
    使用go進行項目開發，大多數人會使用gorm，但是gorm有一些缺點，我無法接受。於是開發出了aorm，目前能有滿足日常開發需求，並且完善了使用文檔，希望能夠幫助到大家。 ...
  • .net core 中 WebApiClientCore的使用
    WebApiClient 介面註冊與選項 1 配置文件中配置HttpApiOptions選項 配置示例 "IUserApi": { "HttpHost": "http://www.webappiclient.com/", "UseParameterPropertyValidate": false, ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發（一）：使用.NET MAUI開發第一個安卓APP
    移動開發（一）：使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說，近來想嘗試開發一款安卓APP，考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP，畢竟是使用Visual Studio開發工具，使用起來也比較的順手，結合微軟官方的教程進行了安卓 ...
  • wpf ToggleButton選中效果和一個登錄界面
    前言 QuestPDF 是一個開源 .NET 庫，用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫，它徹底改變了我們生成 PDF 文檔的方 ...
  • 彈幕樹洞項目功能新增篇
    項目地址 項目後端地址： https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址： ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址： http://tree ...
  • 第27篇 sqlserver2022詳細安裝步驟
    話不多說，直接開乾 一.下載 1.官方鏈接下載： https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe，運行開始下載SQL server； 二. ...
  • .NET 開源高性能 MQTT 類庫
    前言 隨著物聯網（IoT）技術的迅猛發展，MQTT（消息隊列遙測傳輸）協議憑藉其輕量級和高效性，已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫，為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog文檔翻譯系列（六） - 可用的接收器、增強器、格式化輸出
    Serilog支持多種接收器用於日誌存儲，增強器用於添加屬性，LogContext管理動態屬性，支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項，適用於不同需求。 ...
  • 警惕 Visual Studio 屬性求值副作用導致邏輯不符合預期
    目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據，爬取信息時需要模擬瀏覽器行為，否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下： 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • [使用目前最新版]HybridCLR6.9.0+YooAsset2.2.4實現純C# Unity熱更新方案 (一)
    1.前言 什麼是熱更新 游戲或者軟體更新時，無需重新下載客戶端進行安裝，而是在應用程式啟動的情況下，在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR，Xlua，ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles，Addressable， ...
  • 在 ASP.NET Core Web API 中使用操作篩選器統一處理通用操作
    本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺，其實像阿裡雲，騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後，它會送 ...
  • 第28篇 如何.net中實現高效可靠數據同步api
    通過以下方式可以高效，並保證數據同步的可靠性 1.API設計 使用RESTful設計，確保API端點明確，並使用適當的HTTP方法（如POST用於創建，PUT用於更新）。 設計清晰的請求和響應模型，以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證，確保接收到的數據符合預期格 ...
所有分類