Sparkdo.DistributedLocking.Abstractions 1.0.2

There is a newer prerelease version of this package available.
See the version list below for details.

dotnet add package Sparkdo.DistributedLocking.Abstractions --version 1.0.2

NuGet\Install-Package Sparkdo.DistributedLocking.Abstractions -Version 1.0.2

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.2" />

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.2" />
                    

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

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

#r "nuget: Sparkdo.DistributedLocking.Abstractions, 1.0.2"

#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.2

#: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.2
                    

                            Install as a Cake Addin

#tool nuget:?package=Sparkdo.DistributedLocking.Abstractions&version=1.0.2
                    

                            Install as a Cake Tool

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

Sparkdo.DistributedLocking.Abstractions

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

功能特性

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

安装

<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 语句结束时自动释放
}

扩展性

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

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

代码结构说明

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

核心接口

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

基础实现

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

配置

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

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

Product	Compatible and additional computed target framework versions.
.NET	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.

Compatible target framework(s)

Included target framework(s) (in package)

Learn more about Target Frameworks and .NET Standard.

net10.0
- JetBrains.Annotations (>= 2025.2.4)
- Microsoft.Extensions.Configuration (>= 10.0.5)
- Microsoft.Extensions.Configuration.CommandLine (>= 10.0.5)
- Microsoft.Extensions.Configuration.EnvironmentVariables (>= 10.0.5)
- Microsoft.Extensions.Configuration.FileExtensions (>= 10.0.5)
- Microsoft.Extensions.Configuration.Json (>= 10.0.5)
- Microsoft.Extensions.Configuration.UserSecrets (>= 10.0.5)
- Microsoft.Extensions.DependencyInjection (>= 10.0.5)
- Microsoft.Extensions.DependencyInjection.Abstractions (>= 10.0.5)
- Microsoft.Extensions.DependencyModel (>= 10.0.5)
- Microsoft.Extensions.FileProviders.Physical (>= 10.0.5)
- Microsoft.Extensions.Hosting.Abstractions (>= 10.0.5)
- Microsoft.Extensions.Localization (>= 10.0.5)
- Microsoft.Extensions.Logging (>= 10.0.5)
- Microsoft.Extensions.Logging.Abstractions (>= 10.0.5)
- Microsoft.Extensions.Options (>= 10.0.5)
- Microsoft.Extensions.Options.ConfigurationExtensions (>= 10.0.5)
- Microsoft.Extensions.Options.DataAnnotations (>= 10.0.5)
- Nito.AsyncEx.Context (>= 5.1.2)
- Sparkdo.Core (>= 1.0.2)
- System.Linq.Dynamic.Core (>= 1.7.1)

NuGet packages (3)

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

Package	Downloads
Sparkdo.EventBus Sparkdo 事件总线实现库，提供本地和分布式事件发布/订阅功能	3.0K
Sparkdo.BackgroundJobs Sparkdo 后台作业库，提供后台任务调度和执行功能实现	1.3K
Sparkdo.DistributedLocking Sparkdo 分布式锁实现库，基于 Medallion.Threading 提供分布式锁功能的具体实现	1.2K

GitHub repositories

This package is not used by any popular GitHub repositories.

Version	Downloads	Last Updated
1.0.3-preview.1	40	5/17/2026
1.0.2	358	4/27/2026
1.0.2-preview.5	90	4/15/2026
1.0.2-preview.4	104	2/8/2026
1.0.2-preview.3	114	2/1/2026
1.0.2-preview.2	118	1/31/2026
1.0.2-preview.1	200	12/4/2025
1.0.1	1,057	11/27/2025
1.0.0	1,014	11/25/2025
1.0.0-preview.5	147	10/24/2025