Sparkdo.DistributedLocking
1.0.1
.NET 10.0
This package targets .NET 10.0. The package is compatible with this framework or higher.
.NET Standard 2.0
This package targets .NET Standard 2.0. The package is compatible with this framework or higher.
There is a newer prerelease version of this package available.
See the version list below for details.
See the version list below for details.
dotnet add package Sparkdo.DistributedLocking --version 1.0.1
NuGet\Install-Package Sparkdo.DistributedLocking -Version 1.0.1
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Sparkdo.DistributedLocking" Version="1.0.1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="Sparkdo.DistributedLocking" Version="1.0.1" />
<PackageReference Include="Sparkdo.DistributedLocking" />
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add Sparkdo.DistributedLocking --version 1.0.1
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: Sparkdo.DistributedLocking, 1.0.1"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
#:package Sparkdo.DistributedLocking@1.0.1
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=Sparkdo.DistributedLocking&version=1.0.1
#tool nuget:?package=Sparkdo.DistributedLocking&version=1.0.1
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
Sparkdo.DistributedLocking
Sparkdo 分布式锁实现库,基于 Medallion.Threading 提供分布式锁功能的具体实现。
功能特性
- 基于 Medallion.Threading 的分布式锁实现
- 支持多种分布式锁后端(Redis、Azure、SQL Server等)
- 与 Sparkdo 分布式锁抽象层无缝集成
- 支持异步锁操作
- 支持 AOT 编译
安装
<PackageReference Include="Sparkdo.DistributedLocking" Version="x.x.x" />
核心组件
MedallionDistributedLock
基于 Medallion.Threading 的分布式锁实现:
- 实现了
IDistributedLock接口 - 支持多种分布式锁后端
- 通过
IDistributedLockProvider获取锁提供程序
MedallionDistributedLockHandle
基于 Medallion.Threading 的分布式锁句柄实现:
- 实现了
IDistributedLockHandle接口 - 负责管理和释放分布式锁资源
IDistributedLockProviderFactory
分布式锁提供程序工厂接口:
- 用于创建分布式锁提供程序实例
NotImplementedDistributedLockProviderFactory
未实现的分布式锁提供程序工厂:
- 提供默认的工厂实现
- 需要被具体的实现替换
DistributedLockHandleExtensions
分布式锁句柄扩展类:
- 提供将 Sparkdo 分布式锁句柄转换为 Medallion 分布式同步句柄的扩展方法
SparkdoDistributedLockingModule
Sparkdo 分布式锁模块类:
- 用于注册分布式锁相关的服务到依赖注入容器
使用示例
// 在 Startup.cs 或 Program.cs 中配置具体的分布式锁提供程序工厂
services.AddSingleton<IDistributedLockProviderFactory, RedisDistributedLockProviderFactory>();
// 获取分布式锁服务
var distributedLock = serviceProvider.GetService<IDistributedLock>();
// 尝试获取锁
await using var handle = await distributedLock.TryAcquireAsync("myLock", TimeSpan.FromSeconds(10));
if (handle != null)
{
// 执行需要同步保护的代码
// 锁会在 using 语句结束时自动释放
}
扩展性
该库提供了基于 Medallion.Threading 的分布式锁实现,可以通过以下方式扩展:
- 实现自定义的
IDistributedLockProviderFactory来支持不同的分布式锁后端 - 配置具体的分布式锁提供程序工厂来替换默认的未实现工厂
代码结构说明
本项目包含以下主要组件:
核心实现
MedallionDistributedLock: 基于 Medallion.Threading 的分布式锁实现MedallionDistributedLockHandle: 基于 Medallion.Threading 的分布式锁句柄实现
工厂接口与实现
IDistributedLockProviderFactory: 分布式锁提供程序工厂接口NotImplementedDistributedLockProviderFactory: 未实现的分布式锁提供程序工厂
扩展方法
DistributedLockHandleExtensions: 分布式锁句柄扩展类
配置
SparkdoDistributedLockingModule: 分布式锁模块配置
所有公共接口和类都添加了详细的 XML 文档注释,便于开发者理解和使用。
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | net5.0 was computed. net5.0-windows was computed. net6.0 was computed. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 was computed. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. net9.0 was computed. net9.0-android was computed. net9.0-browser was computed. net9.0-ios was computed. net9.0-maccatalyst was computed. net9.0-macos was computed. net9.0-tvos was computed. net9.0-windows was computed. net10.0 is compatible. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.0-windows was computed. |
| .NET Core | netcoreapp2.0 was computed. netcoreapp2.1 was computed. netcoreapp2.2 was computed. netcoreapp3.0 was computed. netcoreapp3.1 was computed. |
| .NET Standard | netstandard2.0 is compatible. netstandard2.1 was computed. |
| .NET Framework | net461 was computed. net462 was computed. net463 was computed. net47 was computed. net471 was computed. net472 was computed. net48 was computed. net481 was computed. |
| MonoAndroid | monoandroid was computed. |
| MonoMac | monomac was computed. |
| MonoTouch | monotouch was computed. |
| Tizen | tizen40 was computed. tizen60 was computed. |
| Xamarin.iOS | xamarinios was computed. |
| Xamarin.Mac | xamarinmac was computed. |
| Xamarin.TVOS | xamarintvos was computed. |
| Xamarin.WatchOS | xamarinwatchos was computed. |
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
-
.NETStandard 2.0
- DistributedLock.Core (>= 1.0.8)
- JetBrains.Annotations (>= 2025.2.2)
- Microsoft.Bcl.AsyncInterfaces (>= 10.0.0)
- Microsoft.Extensions.Configuration (>= 10.0.0)
- Microsoft.Extensions.Configuration.CommandLine (>= 10.0.0)
- Microsoft.Extensions.Configuration.EnvironmentVariables (>= 10.0.0)
- Microsoft.Extensions.Configuration.FileExtensions (>= 10.0.0)
- Microsoft.Extensions.Configuration.Json (>= 10.0.0)
- Microsoft.Extensions.Configuration.UserSecrets (>= 10.0.0)
- Microsoft.Extensions.DependencyInjection (>= 10.0.0)
- Microsoft.Extensions.DependencyInjection.Abstractions (>= 10.0.0)
- Microsoft.Extensions.DependencyModel (>= 10.0.0)
- Microsoft.Extensions.FileProviders.Physical (>= 10.0.0)
- Microsoft.Extensions.Hosting.Abstractions (>= 10.0.0)
- Microsoft.Extensions.Localization (>= 10.0.0)
- Microsoft.Extensions.Logging (>= 10.0.0)
- Microsoft.Extensions.Logging.Abstractions (>= 10.0.0)
- Microsoft.Extensions.Options (>= 10.0.0)
- Microsoft.Extensions.Options.ConfigurationExtensions (>= 10.0.0)
- Microsoft.Extensions.Options.DataAnnotations (>= 10.0.0)
- Nito.AsyncEx.Context (>= 5.1.2)
- Sparkdo.DistributedLocking.Abstractions (>= 1.0.1)
- Sparkdo.Threading (>= 1.0.1)
- System.Linq.Dynamic.Core (>= 1.7.0)
- System.Runtime.Loader (>= 4.3.0)
- System.Text.Json (>= 10.0.0)
-
net10.0
- DistributedLock.Core (>= 1.0.8)
- JetBrains.Annotations (>= 2025.2.2)
- Microsoft.Extensions.Configuration (>= 10.0.0)
- Microsoft.Extensions.Configuration.CommandLine (>= 10.0.0)
- Microsoft.Extensions.Configuration.EnvironmentVariables (>= 10.0.0)
- Microsoft.Extensions.Configuration.FileExtensions (>= 10.0.0)
- Microsoft.Extensions.Configuration.Json (>= 10.0.0)
- Microsoft.Extensions.Configuration.UserSecrets (>= 10.0.0)
- Microsoft.Extensions.DependencyInjection (>= 10.0.0)
- Microsoft.Extensions.DependencyInjection.Abstractions (>= 10.0.0)
- Microsoft.Extensions.DependencyModel (>= 10.0.0)
- Microsoft.Extensions.FileProviders.Physical (>= 10.0.0)
- Microsoft.Extensions.Hosting.Abstractions (>= 10.0.0)
- Microsoft.Extensions.Localization (>= 10.0.0)
- Microsoft.Extensions.Logging (>= 10.0.0)
- Microsoft.Extensions.Logging.Abstractions (>= 10.0.0)
- Microsoft.Extensions.Options (>= 10.0.0)
- Microsoft.Extensions.Options.ConfigurationExtensions (>= 10.0.0)
- Microsoft.Extensions.Options.DataAnnotations (>= 10.0.0)
- Nito.AsyncEx.Context (>= 5.1.2)
- Sparkdo.DistributedLocking.Abstractions (>= 1.0.1)
- Sparkdo.Threading (>= 1.0.1)
- System.Linq.Dynamic.Core (>= 1.7.0)
NuGet packages (1)
Showing the top 1 NuGet packages that depend on Sparkdo.DistributedLocking:
| Package | Downloads |
|---|---|
|
Sparkdo.DistributedLocking.StackExchangeRedis
Sparkdo 分布式锁 Redis 实现库,基于 StackExchange.Redis 和 Medallion.Threading.Redis 提供分布式锁功能的 Redis 实现 |
GitHub repositories
This package is not used by any popular GitHub repositories.
| Version | Downloads | Last Updated |
|---|---|---|
| 1.0.2-preview.1 | 138 | 12/4/2025 |
| 1.0.1 | 214 | 11/27/2025 |
| 1.0.0 | 212 | 11/25/2025 |
| 1.0.0-preview.5 | 95 | 10/24/2025 |