Aspire.RabbitMQ.Client
8.2.0
Prefix Reserved
dotnet add package Aspire.RabbitMQ.Client --version 8.2.0
NuGet\Install-Package Aspire.RabbitMQ.Client -Version 8.2.0
<PackageReference Include="Aspire.RabbitMQ.Client" Version="8.2.0" />
paket add Aspire.RabbitMQ.Client --version 8.2.0
#r "nuget: Aspire.RabbitMQ.Client, 8.2.0"
// Install Aspire.RabbitMQ.Client as a Cake Addin #addin nuget:?package=Aspire.RabbitMQ.Client&version=8.2.0 // Install Aspire.RabbitMQ.Client as a Cake Tool #tool nuget:?package=Aspire.RabbitMQ.Client&version=8.2.0
Aspire.RabbitMQ.Client library
Registers an IConnection in the DI container for connecting to a RabbitMQ server. Enables corresponding health check, logging and telemetry.
Getting started
Prerequisites
- RabbitMQ server and the server hostname for connecting a client.
Install the package
Install the .NET Aspire RabbitMQ library with NuGet:
dotnet add package Aspire.RabbitMQ.Client
Usage example
In the Program.cs file of your project, call the AddRabbitMQClient
extension method to register an IConnection
for use via the dependency injection container. The method takes a connection name parameter.
builder.AddRabbitMQClient("messaging");
You can then retrieve the IConnection
instance using dependency injection. For example, to retrieve the connection from a Web API controller:
private readonly IConnection _connection;
public ProductsController(IConnection connection)
{
_connection = connection;
}
Configuration
The .NET Aspire RabbitMQ component provides multiple options to configure the connection based on the requirements and conventions of your project.
Use a connection string
When using a connection string from the ConnectionStrings
configuration section, you can provide the name of the connection string when calling builder.AddRabbitMQClient()
:
builder.AddRabbitMQClient("myConnection");
And then the connection string will be retrieved from the ConnectionStrings
configuration section:
{
"ConnectionStrings": {
"myConnection": "amqp://username:password@localhost:5672"
}
}
See the ConnectionString documentation for more information on how to format this connection string.
Use configuration providers
The .NET Aspire RabbitMQ component supports Microsoft.Extensions.Configuration. It loads the RabbitMQClientSettings
from configuration by using the Aspire:RabbitMQ:Client
key. Example appsettings.json
that configures some of the options:
{
"Aspire": {
"RabbitMQ": {
"Client": {
"DisableHealthChecks": true
}
}
}
}
Use inline delegates
Also you can pass the Action<RabbitMQClientSettings> configureSettings
delegate to set up some or all the options inline, for example to disable health checks from code:
builder.AddRabbitMQClient("messaging", settings => settings.DisableHealthChecks = true);
You can also setup the ConnectionFactory using the Action<ConnectionFactory> configureConnectionFactory
delegate parameter of the AddRabbitMQClient
method. For example to set the client provided name for connections:
builder.AddRabbitMQClient("messaging", configureConnectionFactory: factory => factory.ClientProvidedName = "MyApp");
AppHost extensions
In your AppHost project, install the Aspire.Hosting.RabbitMQ
library with NuGet:
dotnet add package Aspire.Hosting.RabbitMQ
Then, in the Program.cs file of AppHost
, register a RabbitMQ server and consume the connection using the following methods:
var messaging = builder.AddRabbitMQ("messaging");
var myService = builder.AddProject<Projects.MyService>()
.WithReference(messaging);
The WithReference
method configures a connection in the MyService
project named messaging
. In the Program.cs file of MyService
, the RabbitMQ connection can be consumed using:
builder.AddRabbitMQClient("messaging");
Additional documentation
- https://rabbitmq.github.io/rabbitmq-dotnet-client/
- https://github.com/dotnet/aspire/tree/main/src/Components/README.md
Feedback & contributing
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net8.0 is compatible. 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. |
-
net8.0
- AspNetCore.HealthChecks.Rabbitmq (>= 8.0.1)
- Microsoft.Extensions.Configuration.Abstractions (>= 8.0.0)
- Microsoft.Extensions.Configuration.Binder (>= 8.0.2)
- Microsoft.Extensions.DependencyInjection.Abstractions (>= 8.0.1)
- Microsoft.Extensions.Diagnostics.HealthChecks (>= 8.0.8)
- Microsoft.Extensions.Hosting.Abstractions (>= 8.0.0)
- Microsoft.Extensions.Logging.Abstractions (>= 8.0.1)
- Microsoft.Extensions.Options (>= 8.0.2)
- Microsoft.Extensions.Primitives (>= 8.0.0)
- OpenTelemetry.Extensions.Hosting (>= 1.9.0)
- Polly.Core (>= 8.4.1)
- RabbitMQ.Client (>= 6.8.1 && < 7.0.0)
NuGet packages (5)
Showing the top 5 NuGet packages that depend on Aspire.RabbitMQ.Client:
Package | Downloads |
---|---|
SimpleUseAspireRabbitMQ
Package Description |
|
EventBusRabbitMQInfraDJ
Package Description |
|
Toss.EventBusRabbitMQ
Package Description |
|
03744689F2EFE6FB5738A7EA27A9DCAC
Package Description |
|
ALibrary.EventBus.RabbitMQ
EventBus.RabbitMQ |
GitHub repositories (1)
Showing the top 1 popular GitHub repositories that depend on Aspire.RabbitMQ.Client:
Repository | Stars |
---|---|
dotnet/eShop
A reference .NET application implementing an eCommerce site
|
Version | Downloads | Last updated |
---|---|---|
8.2.0 | 288 | 8/29/2024 |
8.1.0 | 8,209 | 7/23/2024 |
8.0.2 | 6,376 | 6/28/2024 |
8.0.1 | 10,742 | 5/21/2024 |
8.0.0 | 3,456 | 5/21/2024 |
8.0.0-preview.7.24251.11 | 3,281 | 5/7/2024 |
8.0.0-preview.6.24214.1 | 3,892 | 4/23/2024 |
8.0.0-preview.5.24201.12 | 4,668 | 4/9/2024 |
8.0.0-preview.4.24156.9 | 4,616 | 3/12/2024 |
8.0.0-preview.3.24105.21 | 7,856 | 2/13/2024 |
8.0.0-preview.2.23619.3 | 9,795 | 12/20/2023 |
8.0.0-preview.1.23557.2 | 8,402 | 11/14/2023 |