Ler em inglês

Compartilhar via


integração .NET AspireRabbitMQ

Inclui:integração de hospedagem e Client integração

RabbitMQ é um agente de streaming e mensagens confiáveis, que é fácil de implantar em ambientes de nuvem, localmente e em seu computador local. A integração .NET AspireRabbitMQ permite que você se conecte a instâncias de RabbitMQ existentes ou crie novas instâncias de .NET com a imagem de contêiner docker.io/library/rabbitmq.

Integração de hospedagem

A integração de hospedagem do RabbitMQ modela um servidor RabbitMQ como o tipo RabbitMQServerResource. Para acessar esse tipo e suas APIs, adicione o pacote NuGet 📦Aspire.Hosting.RabbitMQ no projeto de host de aplicativo .

CLI do .NET
dotnet add package Aspire.Hosting.RabbitMQ

Para obter mais informações, consulte dotnet add package ou Gerenciar dependências de pacotes em .NET aplicativos.

Adicionar RabbitMQ recurso de servidor

No projeto de host do aplicativo, chame AddRabbitMQ na instância builder para adicionar um recurso de servidor RabbitMQ:

C#
var builder = DistributedApplication.CreateBuilder(args);

var rabbitmq = builder.AddRabbitMQ("messaging");

builder.AddProject<Projects.ExampleProject>()
       .WithReference(rabbitmq);

// After adding all resources, run the app...

Quando .NET.NET Aspire adiciona uma imagem de contêiner ao host do aplicativo, conforme mostrado no exemplo anterior com a imagem docker.io/library/rabbitmq, ele cria uma nova instância de servidor RabbitMQ no computador local. Uma referência ao servidor RabbitMQ (a variável rabbitmq) é adicionada ao ExampleProject. O recurso de servidor RabbitMQ inclui credenciais padrão com um username de "guest" e password gerados aleatoriamente utilizando o método CreateDefaultPasswordParameter.

O método WithReference configura uma conexão no ExampleProject denominado "messaging". Para obter mais informações, consulte ciclo de vida do recurso contêiner.

Dica

Se você preferir se conectar a um servidor RabbitMQ existente, chame AddConnectionString em vez disso. Para obter mais informações, consulte Referenciar recursos existentes.

Adicionar recurso de servidor RabbitMQ com plug-in de gerenciamento

Para adicionar o plug-in de gerenciamento RabbitMQ ao recurso de servidor RabbitMQ, chame o método WithManagementPlugin:

C#
var builder = DistributedApplication.CreateBuilder(args);

var rabbitmq = builder.AddRabbitMQ("messaging")
                      .WithManagementPlugin();

builder.AddProject<Projects.ExampleProject>()
        .WithReference(rabbitmq);

// After adding all resources, run the app...

O plug-in de gerenciamento de RabbitMQ fornece uma API baseada em HTTP para gerenciamento e monitoramento do servidor RabbitMQ. .NET .NET Aspire adiciona outra imagem de contêiner docker.io/library/rabbitmq-management ao host do aplicativo que executa o plug-in de gerenciamento.

Adicionar RabbitMQ recurso de servidor com volume de dados

Para adicionar um volume de dados ao recurso de servidor RabbitMQ, chame o método WithDataVolume no recurso de servidor RabbitMQ:

C#
var builder = DistributedApplication.CreateBuilder(args);

var rabbitmq = builder.AddRabbitMQ("messaging")
                      .WithDataVolume(isReadOnly: false);

builder.AddProject<Projects.ExampleProject>()
        .WithReference(rabbitmq);

// After adding all resources, run the app...

O volume de dados é usado para persistir os dados do servidor RabbitMQ fora do ciclo de vida de seu contêiner. O volume de dados é montado no caminho /var/lib/rabbitmq no contêiner do servidor RabbitMQ e, quando um parâmetro name não é fornecido, o nome é gerado aleatoriamente. Para obter mais informações sobre volumes de dados e detalhes sobre por que eles são preferidos em vez de montagens de ligação , consulte os documentos Docker: Volumes.

Adicionar recurso RabbitMQ ao servidor com montagem de vínculo de dados

Para adicionar uma montagem de associação de dados ao recurso de servidor RabbitMQ, chame o método WithDataBindMount:

C#
var builder = DistributedApplication.CreateBuilder(args);

var rabbitmq = builder.AddRabbitMQ("messaging")
                      .WithDataBindMount(
                          source: @"C:\RabbitMQ\Data",
                          isReadOnly: false);

builder.AddProject<Projects.ExampleProject>()
        .WithReference(rabbitmq);

// After adding all resources, run the app...

Importante

Os de dados associam montagens têm funcionalidade limitada em comparação com volumes, que oferecem melhor desempenho, portabilidade e segurança, tornando-os mais adequados para ambientes de produção. No entanto, as montagens de vínculo permitem acesso direto e modificação de arquivos no sistema host, ideal para desenvolvimento e teste quando são necessárias alterações em tempo real.

As montagens de associação de dados dependem do sistema de arquivos do computador host para manter os dados do servidor RabbitMQ em reinicializações de contêiner. A montagem de associação de dados é montada no C:\RabbitMQ\Data no caminho do Windows (ou /RabbitMQ/Data no Unix) na máquina host dentro do contêiner do servidor RabbitMQ. Para obter mais informações sobre montagens de vinculação de dados, consulte Docker documentação: Montagens de vinculação.

Adicionar RabbitMQ recurso de servidor com parâmetros

Quando você quiser fornecer explicitamente o nome de usuário e a senha usados pela imagem de contêiner, você pode fornecer essas credenciais como parâmetros. Considere o seguinte exemplo alternativo:

C#
var builder = DistributedApplication.CreateBuilder(args);

var username = builder.AddParameter("username", secret: true);
var password = builder.AddParameter("password", secret: true);

var rabbitmq = builder.AddRabbitMQ("messaging", username, password);

builder.AddProject<Projects.ExampleProject>()
       .WithReference(rabbitmq);

// After adding all resources, run the app...

Para obter mais informações sobre como fornecer parâmetros, consulte Parâmetros externos.

Verificações de integridade de integração de hospedagem

A integração de hospedagem RabbitMQ adiciona automaticamente uma verificação de integridade para o recurso de servidor RabbitMQ. A verificação de integridade verifica se o servidor RabbitMQ está em execução e se uma conexão pode ser estabelecida com ele.

A integração com hospedagem depende do pacote NuGet 📦 AspNetCore.HealthChecks.Rabbitmq.

integração Client

Para começar a usar a integração do cliente .NET AspireRabbitMQ, instale o pacote NuGet 📦Aspire.RabbitMQ.Client no projeto que consome o cliente, isto é, o projeto do aplicativo que usa o cliente RabbitMQ. A integração do cliente RabbitMQ registra uma instância de IConnection que você pode usar para interagir com RabbitMQ.

CLI do .NET
dotnet add package Aspire.RabbitMQ.Client

Adicionar RabbitMQ cliente

No arquivo Program.cs do projeto consumidor de cliente, chame o método de extensão AddRabbitMQClient em qualquer IHostApplicationBuilder para registrar um IConnection para uso por meio do contêiner de injeção de dependência. O método usa um parâmetro de nome de conexão.

C#
builder.AddRabbitMQClient(connectionName: "messaging");

Dica

O parâmetro connectionName deve corresponder ao nome usado ao adicionar o recurso de servidor RabbitMQ no projeto de host do aplicativo. Para obter mais informações, consulte Adicionar recurso do servidor RabbitMQ.

Em seguida, você pode recuperar a instância de IConnection usando a injeção de dependência. Por exemplo, para recuperar a conexão de um serviço de exemplo:

C#
public class ExampleService(IConnection connection)
{
    // Use connection...
}

Para obter mais informações sobre injeção de dependência, consulte .NET injeção de dependência.

Adicionar cliente chaveado RabbitMQ

Pode haver situações em que você deseja registrar várias instâncias de IConnection com nomes de conexão diferentes. Para registrar clientes chaveados de RabbitMQ, chame o método AddKeyedRabbitMQClient.

C#
builder.AddKeyedRabbitMQClient(name: "chat");
builder.AddKeyedRabbitMQClient(name: "queue");

Em seguida, você pode recuperar as instâncias de IConnection usando a injeção de dependência. Por exemplo, para recuperar a conexão de um serviço de exemplo:

C#
public class ExampleService(
    [FromKeyedServices("chat")] IConnection chatConnection,
    [FromKeyedServices("queue")] IConnection queueConnection)
{
    // Use connections...
}

Para obter mais informações sobre serviços chaveados, consulte .NET injeção de dependência: serviços chaveados.

Configuração

A integração .NET AspireRabbitMQ fornece várias opções para configurar a conexão com base nos requisitos e convenções do seu projeto.

Usar uma string de conexão

Ao usar uma cadeia de conexão da seção de configuração ConnectionStrings, você pode fornecer o nome da cadeia de conexão ao chamar o método AddRabbitMQClient:

C#
builder.AddRabbitMQClient(connectionName: "messaging");

Em seguida, a cadeia de conexão é recuperada da seção de configuração ConnectionStrings:

JSON
{
  "ConnectionStrings": {
    "messaging": "amqp://username:password@localhost:5672"
  }
}

Para obter mais informações sobre como formatar essa cadeia de conexão, consulte os documentos de especificação de URI RabbitMQ.

Usar provedores de configuração

A integração .NET AspireRabbitMQ dá suporte a Microsoft.Extensions.Configuration. Ele carrega a RabbitMQClientSettings da configuração usando a chave Aspire:RabbitMQ:Client. O snippet a seguir é um exemplo de um arquivo de appsettings.json que configura algumas das opções:

JSON
{
  "Aspire": {
    "RabbitMQ": {
      "Client": {
        "ConnectionString": "amqp://username:password@localhost:5672",
        "DisableHealthChecks": true,
        "DisableTracing": true,
        "MaxConnectRetryCount": 2
      }
    }
  }
}

Para obter o esquema JSON de integração completa do cliente RabbitMQ, consulte Aspire.RabbitMQ.Client/ConfigurationSchema.json.

Usar delegados embutidos

Além disso, você pode passar o delegado Action<RabbitMQClientSettings> configureSettings para configurar algumas ou todas as opções embutidas, por exemplo, para desabilitar verificações de integridade do código:

C#
builder.AddRabbitMQClient(
    "messaging",
    static settings => settings.DisableHealthChecks = true);

Você também pode configurar o IConnectionFactory usando o parâmetro delegado do método . Por exemplo, para definir o nome fornecido pelo cliente para conexões:

C#
builder.AddRabbitMQClient(
    "messaging",
    configureConnectionFactory:
        static factory => factory.ClientProvidedName = "MyApp");

Client verificações de integração de integridade

Por padrão, as integrações .NET.NET Aspire ativam verificações de integridade para todos os serviços. Para obter mais informações, consulte .NET.NET Aspire visão geral de integrações.

A integração .NET AspireRabbitMQ:

  • Adiciona a verificação de integridade quando RabbitMQClientSettings.DisableHealthChecks é false, que tenta se conectar e criar um canal no servidor RabbitMQ.
  • Integra-se ao endpoint HTTP /health, que especifica que todas as verificações de integridade registradas devem passar para que o aplicativo seja considerado preparado para receber tráfego.

Observabilidade e telemetria

.NET .NET Aspire integrações configuram automaticamente configurações de Log, Rastreamento e Métricas, que às vezes são conhecidas como os pilares da observabilidade. Para obter mais informações sobre a observabilidade e a telemetria de integração, consulte .NET.NET Aspire visão geral das integrações. Dependendo do serviço de backup, algumas integrações só podem dar suporte a alguns desses recursos. Por exemplo, algumas integrações dão suporte a registro em log e rastreamento, mas não a métricas. Os recursos de telemetria também podem ser desabilitados usando as técnicas apresentadas na seção Configuration.

Registro de Logs

A integração .NET AspireRabbitMQ usa as seguintes categorias de log:

  • RabbitMQ.Client

Rastreamento

A integração .NET AspireRabbitMQ emite as seguintes atividades de rastreamento usando OpenTelemetry:

  • Aspire.RabbitMQ.Client

Métricas

A integração .NET AspireRabbitMQ atualmente não dá suporte a métricas por padrão.

Consulte também