Sparkdo.EventBus.Kafka 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. 
dotnet add package Sparkdo.EventBus.Kafka --version 1.0.1
                    


                    

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


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="Sparkdo.EventBus.Kafka" />
                    


                            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.EventBus.Kafka --version 1.0.1
                    


                    

                
#r "nuget: Sparkdo.EventBus.Kafka, 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.EventBus.Kafka@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.EventBus.Kafka&version=1.0.1
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=Sparkdo.EventBus.Kafka&version=1.0.1
                    


                            Install as a Cake Tool

Sparkdo.EventBus.Kafka

Sparkdo Kafka 事件总线实现，提供基于 Kafka 的分布式事件发布和订阅功能。

功能特性

  • 基于 Kafka 的分布式事件总线实现
  • 支持事件的发布和订阅
  • 支持发件箱和收件箱模式
  • 支持工作单元集成
  • 支持多租户
  • 支持事件追踪和关联ID
  • 与 Sparkdo 框架无缝集成

安装

<PackageReference Include="Sparkdo.EventBus.Kafka" Version="x.x.x" />

核心组件

KafkaDistributedEventBus

Kafka 分布式事件总线核心实现类，继承自 DistributedEventBusBase：

  • InitializeAsync(): 初始化事件总线，创建消费者并绑定主题
  • PublishAsync(): 发布事件到 Kafka
  • Subscribe(): 订阅事件处理程序
  • Unsubscribe(): 取消订阅事件处理程序

SparkdoKafkaEventBusOptions

Kafka 事件总线配置选项类，用于配置 Kafka 相关参数：

  • ConnectionName: Kafka 连接名称
  • TopicName: Kafka 主题名称
  • GroupId: Kafka 消费者组ID

SparkdoEventBusKafkaModule

Kafka 事件总线模块配置类，负责注册相关服务：

  • 配置 Kafka 事件总线选项
  • 注册事件总线服务
  • 初始化事件总线

配置

在 appsettings.json 中配置 Kafka 事件总线：

{
  "Sparkdo": {
    "Kafka": {
      "EventBus": {
        "TopicName": "MyTopic",
        "GroupId": "MyGroup",
        "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>();
    }
}

扩展性

该库提供了完整的 Kafka 事件总线实现，可以通过以下方式扩展：

  1. 自定义事件序列化器实现 IKafkaSerializer 接口
  2. 自定义消息消费者实现 IKafkaMessageConsumer 接口
  3. 通过 SparkdoKafkaEventBusOptions 配置事件总线行为
  4. 实现自定义的事件处理器

代码结构说明

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

核心实现

  • KafkaDistributedEventBus: Kafka 分布式事件总线实现
  • SparkdoKafkaEventBusOptions: Kafka 事件总线配置选项
  • MessageExtensions: Kafka 消息扩展方法

配置

  • SparkdoEventBusKafkaModule: Kafka 事件总线模块

扩展方法

  • MessageExtensions: Kafka 消息扩展方法，用于提取消息ID和关联ID

所有公共接口和类都添加了详细的 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

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.2-preview.1 135 12/4/2025
1.0.1 165 11/27/2025
1.0.0 175 11/25/2025
1.0.0-preview.5 101 10/24/2025