Sparkdo.DistributedLocking.Abstractions 1.0.0-preview.5

.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.
This is a prerelease version of Sparkdo.DistributedLocking.Abstractions.
There is a newer version of this package available.
See the version list below for details. 
dotnet add package Sparkdo.DistributedLocking.Abstractions --version 1.0.0-preview.5
                    


                    

                
NuGet\Install-Package Sparkdo.DistributedLocking.Abstractions -Version 1.0.0-preview.5
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.Abstractions" Version="1.0.0-preview.5" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="Sparkdo.DistributedLocking.Abstractions" Version="1.0.0-preview.5" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="Sparkdo.DistributedLocking.Abstractions" />
                    


                            Project file
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.Abstractions --version 1.0.0-preview.5
                    


                    

                
#r "nuget: Sparkdo.DistributedLocking.Abstractions, 1.0.0-preview.5"
#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.Abstractions@1.0.0-preview.5
#: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.Abstractions&version=1.0.0-preview.5&prerelease
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=Sparkdo.DistributedLocking.Abstractions&version=1.0.0-preview.5&prerelease
                    


                            Install as a Cake Tool

Sparkdo.DistributedLocking.Abstractions

Sparkdo 分布式锁抽象库，提供分布式锁功能的核心接口和基础实现。

功能特性

  • 定义分布式锁的核心接口
  • 提供本地分布式锁的默认实现
  • 支持锁键名标准化配置
  • 与 Sparkdo 框架无缝集成
  • 支持异步锁操作
  • 支持 AOT 编译

安装

<PackageReference Include="Sparkdo.DistributedLocking.Abstractions" Version="x.x.x" />

核心组件

IDistributedLock

分布式锁接口，定义了分布式锁的核心功能：

  • TryAcquireAsync(): 尝试获取分布式锁

IDistributedLockHandle

分布式锁句柄接口，表示一个已获取的分布式锁：

  • 实现了 IAsyncDisposable 接口，支持异步释放锁资源

DistributedLockOptions

分布式锁配置选项，用于配置分布式锁的相关参数：

  • KeyPrefix: 分布式锁名称前缀，用于避免不同应用间的锁名称冲突

IDistributedLockKeyNormalizer

分布式锁键名标准化器接口，用于标准化分布式锁的键名：

  • NormalizeKey(): 标准化分布式锁的键名

DefaultDistributedLockKeyNormalizer

默认分布式锁键名标准化器实现：

  • 通过添加配置的前缀来避免不同应用间的锁名称冲突

LocalDistributedLock

本地分布式锁实现，基于 SemaphoreSlim 实现：

  • 主要用于单个应用实例内的并发控制
  • 不适用于真正的分布式环境

LocalDistributedLockHandle

本地分布式锁句柄实现，用于管理和释放本地分布式锁：

  • 确保锁在使用完毕后能被正确释放

SparkdoDistributedLockingAbstractionsModule

Sparkdo 分布式锁抽象模块类，用于注册分布式锁相关的服务：

  • 自动注册分布式锁相关服务到依赖注入容器

使用示例

// 获取分布式锁服务
var distributedLock = serviceProvider.GetService<IDistributedLock>();

// 尝试获取锁
await using var handle = await distributedLock.TryAcquireAsync("myLock", TimeSpan.FromSeconds(10));
if (handle != null)
{
    // 执行需要同步保护的代码
    // 锁会在 using 语句结束时自动释放
}

扩展性

该库提供了完整的分布式锁抽象实现，可以通过以下方式扩展：

  1. 实现自定义的 IDistributedLock 来支持真正的分布式锁（如基于 Redis、ZooKeeper 等）
  2. 实现自定义的 IDistributedLockKeyNormalizer 来定义特定的键名标准化规则
  3. 通过 DistributedLockOptions 配置锁的行为

代码结构说明

本项目包含以下主要组件：

核心接口

  • IDistributedLock: 分布式锁接口
  • IDistributedLockHandle: 分布式锁句柄接口
  • IDistributedLockKeyNormalizer: 分布式锁键名标准化器接口

基础实现

  • DefaultDistributedLockKeyNormalizer: 默认分布式锁键名标准化器实现
  • LocalDistributedLock: 本地分布式锁实现
  • LocalDistributedLockHandle: 本地分布式锁句柄实现

配置

  • DistributedLockOptions: 分布式锁配置选项
  • SparkdoDistributedLockingAbstractionsModule: 分布式锁抽象模块配置

所有公共接口和类都添加了详细的 XML 文档注释，便于开发者理解和使用。

Product 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.

NuGet packages (3)

Showing the top 3 NuGet packages that depend on Sparkdo.DistributedLocking.Abstractions:

Package Downloads
Sparkdo.EventBus

Sparkdo 事件总线实现库，提供本地和分布式事件发布/订阅功能
Sparkdo.BackgroundJobs

Sparkdo 后台作业库，提供后台任务调度和执行功能实现
Sparkdo.DistributedLocking

Sparkdo 分布式锁实现库，基于 Medallion.Threading 提供分布式锁功能的具体实现

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
1.0.2-preview.1 151 12/4/2025
1.0.1 1,012 11/27/2025
1.0.0 978 11/25/2025
1.0.0-preview.5 98 10/24/2025