Sparkdo.EventBus.RabbitMQ
1.0.2
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.EventBus.RabbitMQ --version 1.0.2
NuGet\Install-Package Sparkdo.EventBus.RabbitMQ -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.EventBus.RabbitMQ" Version="1.0.2" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="Sparkdo.EventBus.RabbitMQ" Version="1.0.2" />
<PackageReference Include="Sparkdo.EventBus.RabbitMQ" />
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.EventBus.RabbitMQ --version 1.0.2
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: Sparkdo.EventBus.RabbitMQ, 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.EventBus.RabbitMQ@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.EventBus.RabbitMQ&version=1.0.2
#tool nuget:?package=Sparkdo.EventBus.RabbitMQ&version=1.0.2
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
Sparkdo.EventBus.RabbitMQ
Sparkdo RabbitMQ 事件总线实现,提供基于 RabbitMQ 的分布式事件发布和订阅功能。
功能特性
- 基于 RabbitMQ 的分布式事件总线实现
- 支持事件的发布和订阅
- 支持发件箱和收件箱模式
- 支持工作单元集成
- 支持多租户
- 支持事件追踪和关联ID
- 与 Sparkdo 框架无缝集成
安装
<PackageReference Include="Sparkdo.EventBus.RabbitMQ" Version="x.x.x" />
核心组件
RabbitMqDistributedEventBus
RabbitMQ 分布式事件总线核心实现类,继承自 DistributedEventBusBase 并实现了 IRabbitMqDistributedEventBus 接口:
InitializeAsync(): 初始化事件总线,创建消费者并绑定队列PublishAsync(): 发布事件到 RabbitMQSubscribe(): 订阅事件处理程序Unsubscribe(): 取消订阅事件处理程序
SparkdoRabbitMqEventBusOptions
RabbitMQ 事件总线配置选项类,用于配置 RabbitMQ 相关参数:
ConnectionName: RabbitMQ 连接名称ClientName: 客户端名称ExchangeName: 交换机名称ExchangeType: 交换机类型PrefetchCount: 预取计数QueueArguments: 队列参数ExchangeArguments: 交换机参数
SparkdoEventBusRabbitMqModule
RabbitMQ 事件总线模块配置类,负责注册相关服务:
- 配置 RabbitMQ 事件总线选项
- 注册事件总线服务
- 初始化事件总线
配置
在 appsettings.json 中配置 RabbitMQ 事件总线:
{
"Sparkdo": {
"RabbitMQ": {
"EventBus": {
"ClientName": "MyApp",
"ExchangeName": "MyExchange",
"ConnectionName": "Default"
}
}
}
}
使用示例
发布事件
public class MyService
{
private readonly IDistributedEventBus _eventBus;
public MyService(IDistributedEventBus eventBus)
{
_eventBus = eventBus;
}
public async Task PublishEventAsync()
{
var eventData = new MyEventData { Message = "Hello World" };
await _eventBus.PublishAsync(eventData);
}
}
订阅事件
public class MyEventHandler : IDistributedEventHandler<MyEventData>
{
public async Task HandleEventAsync(MyEventData eventData)
{
// 处理事件
Console.WriteLine($"Received event: {eventData.Message}");
}
}
// 在模块中注册事件处理器
public class MyModule : Module
{
public override void Configure(IConfigureContext context)
{
context.Services.AddTransient<MyEventHandler>();
}
}
扩展性
该库提供了完整的 RabbitMQ 事件总线实现,可以通过以下方式扩展:
- 自定义事件序列化器实现 IRabbitMqSerializer 接口
- 自定义消息消费者实现 IRabbitMqMessageConsumer 接口
- 通过 SparkdoRabbitMqEventBusOptions 配置事件总线行为
- 实现自定义的事件处理器
代码结构说明
本项目包含以下主要组件:
核心实现
RabbitMqDistributedEventBus: RabbitMQ 分布式事件总线实现SparkdoRabbitMqEventBusOptions: RabbitMQ 事件总线配置选项IRabbitMqDistributedEventBus: RabbitMQ 分布式事件总线接口
配置
SparkdoEventBusRabbitMqModule: RabbitMQ 事件总线模块PostConfigureSparkdoRabbitMqEventBusOptions: RabbitMQ 事件总线选项后配置
接口抽象
IRabbitMqDistributedEventBus: RabbitMQ 分布式事件总线接口
所有公共接口和类都添加了详细的 XML 文档注释,便于开发者理解和使用。
| Product | Versions 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.Composite (>= 10.0.5)
- Microsoft.Extensions.FileProviders.Embedded (>= 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)
- RabbitMQ.Client (>= 7.2.1)
- Sparkdo.EventBus (>= 1.0.2)
- Sparkdo.RabbitMQ (>= 1.0.2)
- System.Linq.Dynamic.Core (>= 1.7.1)
- TimeZoneConverter (>= 7.2.0)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.
| Version | Downloads | Last Updated |
|---|---|---|
| 1.0.3-preview.1 | 34 | 5/17/2026 |
| 1.0.2 | 99 | 4/27/2026 |
| 1.0.2-preview.5 | 54 | 4/15/2026 |
| 1.0.2-preview.4 | 77 | 2/8/2026 |
| 1.0.2-preview.3 | 70 | 2/1/2026 |
| 1.0.2-preview.2 | 67 | 1/31/2026 |
| 1.0.2-preview.1 | 184 | 12/4/2025 |
| 1.0.1 | 232 | 11/27/2025 |
| 1.0.0 | 214 | 11/25/2025 |
| 1.0.0-preview.5 | 141 | 10/24/2025 |