DistributedLock?實現.Net分布式鎖功能

更新時間：2025年08月29日 09:28:11 作者：LongtengGensSupreme

DistributedLock是一個輕量級、線程安全的.NET庫,用來在分布式環(huán)境下實現鎖的功能,今天給大家介紹一個.NET里非常好用的分布式鎖庫DistributedLock,感興趣的朋友跟隨小編一起看看吧

什么是 DistributedLock

DistributedLock 是一個輕量級、線程安全的 .NET 庫，用來在分布式環(huán)境下實現鎖的功能。支持多種后端存儲，包括：

Redis
SQL Server
PostgreSQL
MySQL
MongoDB
內存模式（本地鎖）

只需要更換存儲提供程序，就能無縫地在不同的環(huán)境下使用。

基本使用

安裝 NuGet 包

在項目中引入需要的后端依賴，如：

dotnet add package DistributedLock  --包含所有實現的元包
dotnet add package DistributedLock.Redis
dotnet add package DistributedLock.SqlServer

（Redis 和 SQL Server 是最常見的場景，也可以選擇別的實現）

使用 Redis 分布式鎖

  var RedisConnectionString = "localhost:6379,abortConnect=false";
  var LockName = "MyResourceLock";
  var connection = await ConnectionMultiplexer.ConnectAsync(RedisConnectionString); // uses StackExchange.Redis
  var @lock = new RedisDistributedLock(LockName, connection.GetDatabase());
  await using (var handle = await @lock.TryAcquireAsync())
  {
      if (handle != null) { /* I have the lock */ }
  }

只要使用 Acquire / AcquireAsync 獲取鎖，代碼塊執(zhí)行完畢后會自動釋放，非常優(yōu)雅。

使用 SQL Server 分布式鎖

using Medallion.Threading.SqlServer;
using System;
using System.Threading;
using System.Threading.Tasks;
namespace DistributedLockDemo
{
    internal class Program
    {
        static async Task Main(string[] args)
        {
            var connectionString = "Server=myServerAddress;Database=Locks;User Id=myUsername;Password=myPassword;";
            var lockName = "MyResourceLock";
            // 創(chuàng)建分布式鎖對象（不需要 using，因為它不實現 IDisposable）
            var sqlLock = new SqlDistributedLock(lockName, connectionString);
            // 嘗試獲取鎖，返回的鎖句柄（LockHandle）實現了 IDisposable
            using (var lockHandle = sqlLock.TryAcquire(TimeSpan.FromSeconds(30)))
            {
                if (lockHandle != null) // 判斷是否成功獲取鎖
                {
                    // 持有鎖，執(zhí)行需要同步的代碼
                    Console.WriteLine("Lock acquired, performing operation...");
                    // 模擬業(yè)務操作
                    await Task.Delay(1000); // 建議使用異步延遲而非 Thread.Sleep
                }
                else
                {
                    Console.WriteLine("Failed to acquire lock within the timeout.");
                }
            } // 此處會自動釋放鎖（lockHandle.Dispose()）
        }
    }
}

在 定時任務（Quartz、Hangfire 等） 場景中，特別適合用來避免多節(jié)點重復執(zhí)行。

依賴注入集成

appsettings.json

{
  "ConnectionStrings": {
    "SqlServer": "Server=myServerAddress;Database=Locks;User Id=myUsername;Password=myPassword;",
    "Redis": "localhost:6379"
  }
}

DistributedLock 支持依賴注入，適合在項目中使用。

// Startup.cs 或 Program.cs
public void ConfigureServices(IServiceCollection services)
{
    var connectionString = Configuration.GetConnectionString("SqlServer");
    services.AddSingleton<IDistributedLockProvider>(_ => 
        new SqlDistributedSynchronizationProvider(connectionString));
    services.AddTransient<SomeService>();
}
// SomeService.cs
public class SomeService
{
    private readonly IDistributedLockProvider _lockProvider;
    public SomeService(IDistributedLockProvider lockProvider)
    {
        _lockProvider = lockProvider;
    }
    public async Task InitializeUserAccountAsync(int id)
    {
        var @lock = _lockProvider.CreateLock(#34;UserAccount{id}");
        await using (await @lock.AcquireAsync())
        {
            // 執(zhí)行需要同步的操作
            Console.WriteLine(#34;Initializing user account {id}...");
            await Task.Delay(1000);
        }
    }
}