Sparkdo.BackgroundWorkers
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.BackgroundWorkers --version 1.0.1
NuGet\Install-Package Sparkdo.BackgroundWorkers -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.BackgroundWorkers" Version="1.0.1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="Sparkdo.BackgroundWorkers" Version="1.0.1" />
<PackageReference Include="Sparkdo.BackgroundWorkers" />
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.BackgroundWorkers --version 1.0.1
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: Sparkdo.BackgroundWorkers, 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.BackgroundWorkers@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.BackgroundWorkers&version=1.0.1
#tool nuget:?package=Sparkdo.BackgroundWorkers&version=1.0.1
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
Sparkdo.BackgroundWorkers
Sparkdo 后台工作者库,提供后台任务执行和管理功能。
功能特性
- 后台工作者基类:提供后台任务执行的基础实现
- 后台工作者管理器:统一管理和调度后台工作者
- 异步周期性任务支持:支持定时执行的后台任务
- 与 Sparkdo 框架无缝集成
- 支持依赖注入和生命周期管理
安装
<PackageReference Include="Sparkdo.BackgroundWorkers" Version="x.x.x" />
核心组件
IBackgroundWorker
后台工作者接口,继承自 IRunnable,定义了后台任务的基本行为:
StartAsync(): 启动后台工作者StopAsync(): 停止后台工作者
BackgroundWorkerBase
后台工作者基类,实现了 IBackgroundWorker 接口:
- 提供日志记录功能
- 管理取消令牌
- 提供服务定位器功能
IBackgroundWorkerManager
后台工作者管理器接口,负责管理所有后台工作者:
AddAsync(): 添加新的后台工作者StartAsync(): 启动所有后台工作者StopAsync(): 停止所有后台工作者
DefaultBackgroundWorkerManager
默认后台工作者管理器实现:
- 维护后台工作者列表
- 统一管理工作者的启动和停止
- 支持动态添加工作者
AsyncPeriodicBackgroundWorkerBase
异步周期性后台工作者基类:
- 支持定时执行的后台任务
- 自动处理异常和重试
- 可配置执行间隔
扩展性
该库提供了完整的后台任务管理功能,可以通过以下方式扩展:
- 继承
BackgroundWorkerBase实现自定义后台任务 - 继承
AsyncPeriodicBackgroundWorkerBase实现定时任务 - 实现自定义的
IBackgroundWorkerManager来改变管理策略 - 通过
SparkdoBackgroundWorkerOptions配置后台工作者行为
代码结构说明
本项目包含以下主要组件:
核心接口
IBackgroundWorker: 后台工作者接口IBackgroundWorkerManager: 后台工作者管理器接口
核心实现
BackgroundWorkerBase: 后台工作者基类DefaultBackgroundWorkerManager: 默认后台工作者管理器AsyncPeriodicBackgroundWorkerBase: 异步周期性后台工作者基类AsyncPeriodicBackgroundWorkerContext: 异步周期性任务上下文
配置
SparkdoBackgroundWorkerOptions: 后台工作者配置选项SparkdoBackgroundWorkersModule: 后台工作者模块配置
所有公共接口和类都添加了详细的 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
- 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.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
- 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.Threading (>= 1.0.1)
- System.Linq.Dynamic.Core (>= 1.7.0)
NuGet packages (4)
Showing the top 4 NuGet packages that depend on Sparkdo.BackgroundWorkers:
| Package | Downloads |
|---|---|
|
Sparkdo.EventBus
Sparkdo 事件总线实现库,提供本地和分布式事件发布/订阅功能 |
|
|
Sparkdo.BackgroundJobs
Sparkdo 后台作业库,提供后台任务调度和执行功能实现 |
|
|
Sparkdo.BackgroundWorkers.TickerQ
Sparkdo TickerQ 后台工作者库,提供基于 TickerQ 的后台工作者功能集成实现 |
|
|
Sparkdo.BackgroundWorkers.Hangfire
Sparkdo Hangfire 后台工作者库,提供基于 Hangfire 的后台工作者功能集成实现 |
GitHub repositories
This package is not used by any popular GitHub repositories.
| Version | Downloads | Last Updated |
|---|---|---|
| 1.0.2-preview.1 | 159 | 12/4/2025 |
| 1.0.1 | 973 | 11/27/2025 |
| 1.0.0 | 965 | 11/25/2025 |
| 1.0.0-preview.5 | 109 | 10/24/2025 |