KafkaConsumerHost 1.0.23

KafkaConsumerHost

KafkaConsumerHost is a simple .NET SDK that provides a framework for building Kafka consumers with dynamic topic handling and dependency injection support.

Requirements

• .NET 8.0

Installation

You can install the package via NuGet:

Install-Package KafkaConsumerHost

Usage

1. Create a New .NET 8 Service Project

Create a new .NET 8 service project and add the following code to the Program.cs file:

using Microsoft.Extensions.Hosting;
using KafkaConsumerHost.Extensions;

var host = Host.CreateDefaultBuilder(args)
    .AddKafkaConsumerHost()
    .Build();

await host.RunAsync();

2. Define a Kafka Consumer

Create a class that inherits from KafkaConsumerBase and use the ConsumeTopicAttribute to specify the topic to consume:

using KafkaConsumerHost;
using KafkaConsumerHost.Attributes;

public class OrdersConsumer : KafkaConsumerBase
{
    [ConsumeTopic(PropertyName=nameof(MyKafkaSettings.ExampleTopic),FromType= typeof(IOptions<MyKafkaSettings>))]
    public async Task HandleOrder(string message)
    {
        // Handle the message
    }
}

3. Define KafkaConsumerConfig in the appsettings.json file

{
  "KafkaConsumerConfig": {
    "BootstrapServers": "localhost:9092",
    "GroupId": "test-group",
    "AutoOffsetReset": "Latest"//or "Earliest"
  }
}

4. Define MyKafkaSettings in the appsettings.json file

{
  "MyKafkaSettings": {
    "ExampleTopic": "example-topic"
  }
}

5. Inject the KafkaConsumerConfig and MyKafkaSettings into the service

using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Hosting;
using KafkaConsumerHost.Extensions;


var host = Host.CreateDefaultBuilder(args)
    .AddKafkaConsumerHost()
    .ConfigureServices((hostContext, services) =>
    {
        services.Configure<KafkaConsumerConfig>(c=>hostContext.Configuration.GetSection(nameof(KafkaConsumerConfig)).Bind(c));
        services.Configure<MyKafkaSettings>(c=>hostContext.Configuration.GetSection(nameof(MyKafkaSettings)).Bind(c));
        //Add other services here
    })
    .Build();

await host.RunAsync();

6. Run the Service

Run the service and the Kafka consumer will start consuming messages from the specified topic.

License

This project is licensed under the MIT License - see the LICENSE file for details.