MVFC.Aspire.Helpers.RabbitMQ 9.0.3

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.

Motivation

Using RabbitMQ in local environments often requires:

• Maintaining a definitions.json with exchanges/queues/bindings.
• Manually loading that file or running rabbitmqctl commands.
• Repeating configuration for each Aspire solution.

With .NET Aspire you can start a RabbitMQ container, but you still need to:

• Configure users/passwords and management UI.
• Declare exchanges, queues and DLQs consistently.
• Keep connection details in sync with your applications.

MVFC.Aspire.Helpers.RabbitMQ wraps this into a fluent API:

• AddRabbitMQ(...) to provision RabbitMQ in Aspire.
• WithExchanges(...) and WithQueues(...) to declare topology from code.
• WithDataVolume(...) and WithCredentials(...) for persistence and security.
• project.WithReference(rabbitMQ) to wire your services to the broker.

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 ExchangeConfig/QueueConfig.
• 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

Quick Aspire usage (AppHost)

using Aspire.Hosting;
using MVFC.Aspire.Helpers.RabbitMQ;

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();

Provisioning diagram

sequenceDiagram
    participant Aspire as .NET Aspire
    participant Container as RabbitMQ Container
    participant Configurator as RabbitMQ Processor
    
    Aspire->>Container: Start container (rabbitmq:management)
    Container-->>Aspire: Ready (AMQP port 5672 available)
    Aspire->>Configurator: Trigger OnResourceReady
    Configurator->>Container: Create Exchanges
    Configurator->>Container: Create Queues
    Configurator->>Container: Bind Queues to Exchanges
    Configurator-->>Aspire: Provisioning Completed
    Aspire->>App: Start App with AMQP ConnectionString

AddRabbitMQ parameters

• 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 optional parameters

• connectionStringSection (optional):
  Path to the configuration section containing the RabbitMQ connection string.
  Default: "ConnectionStrings:rabbitmq".

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

Requirements

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

License

Apache-2.0