MVFC.Aspire.Helpers.RabbitMQ 6.4.0

MVFC.Aspire.Helpers.RabbitMQ

🇧🇷 Leia em Português

Helper for integrating with RabbitMQ in .NET Aspire projects, including automatic creation of exchanges, queues, and dead letter queues.

Overview

MVFC.Aspire.Helpers.RabbitMQ is an extension library for .NET Aspire that facilitates integration with RabbitMQ. It provides extension methods to add RabbitMQ resources to your Aspire application, configure exchanges, queues, and dead letter queues, and setup references between projects.

Project Structure

• MVFC.Aspire.Helpers.RabbitMQ: Helpers and extensions library for RabbitMQ.

Features

• Adds a configured RabbitMQ container.
• Support for custom exchanges and queues via definitions.json.
• Support for dead letter exchanges (DLX).
• Support for message TTL per queue.
• Support for data persistence via Docker volume.
• Support for custom credentials.
• Support for the RabbitMQ Management UI.

Compatible Images:

• rabbitmq

Installation

dotnet add package MVFC.Aspire.Helpers.RabbitMQ

Usage Example in AppHost

var builder = DistributedApplication.CreateBuilder(args);

var rabbitMQ = builder.AddRabbitMQ("rabbitmq")
    .WithCredentials(username: "admin", password: "password")
    .WithExchanges([
        new ExchangeConfig("test-exchange", "topic"),
        new ExchangeConfig("dead-letter", "fanout")
    ])
    .WithQueues([
        new QueueConfig("test-queue", ExchangeName: "test-exchange", RoutingKey: "test.*", DeadLetterExchange: "dead-letter"),
        new QueueConfig("empty-queue", ExchangeName: "test-exchange", RoutingKey: "empty.*"),
        new QueueConfig("dlq", ExchangeName: "dead-letter")
    ])
    .WithDataVolume("rabbit-mq");

builder.AddProject<Projects.MVFC_Aspire_Helpers_Playground_Api>("api-example")
       .WithReference(rabbitMQ)
       .WaitFor(rabbitMQ);

await builder.Build().RunAsync();

Main Parameters for AddRabbitMQ

• name: RabbitMQ resource name.
• amqpPort (Optional): AMQP Port (default: 5672).
• httpPort (Optional): Management UI Port (default: 15672).

Fluent Methods

Exchanges and Queues Configuration

ExchangeConfig

QueueConfig

Other important Optional parameters:

• connectionStringSection (Optional): Defines the path to the environment variable or configuration containing the RabbitMQ connection string. Default is "ConnectionStrings:rabbitmq". Each : indicates a level/section within the appsettings.json file:

{
  "ConnectionStrings": {
    "rabbitmq": "localhost:5672"
  }
}

Requirements

• .NET 9+
• Aspire.Hosting >= 9.5.0

License

Apache-2.0