Guia de início rápido: enviar e receber mensagens de uma fila do Barramento de Serviço do Azure (.NET)

Neste guia de início rápido, você executará as seguintes etapas:

1. Criar um espaço de nomes do Service Bus com o Portal do Azure.

2. Criar uma fila do Service Bus com o portal do Azure.

3. Escreva um aplicativo de console .NET para enviar um conjunto de mensagens para a fila.

4. Escreva um aplicativo de console .NET para receber essas mensagens da fila.

   Nota

   Este início rápido fornece instruções passo a passo para implementar um cenário simples de enviar um lote de mensagens para uma fila do Service Bus e, em seguida, recebê-las. Para obter uma visão geral da biblioteca de cliente .NET, consulte Biblioteca de cliente do Barramento de Serviço do Azure para .NET. Para obter mais exemplos, consulte Exemplos .NET do Service Bus no GitHub.

Pré-requisitos

Se você é novo no serviço, consulte Visão geral do Service Bus antes de fazer este início rápido.

• Subscrição do Azure. Para usar os serviços do Azure, incluindo o Barramento de Serviço do Azure, você precisa de uma assinatura. Se não tiver uma conta existente do Azure, pode inscrever-se para uma avaliação gratuita.
• Visual Studio 2022. O aplicativo de exemplo faz uso de novos recursos que foram introduzidos no C# 10. Você ainda pode usar a biblioteca de cliente do Service Bus com versões anteriores do idioma C#, mas a sintaxe pode variar. Para usar a sintaxe mais recente, recomendamos que você instale o .NET 6.0 ou superior e defina a versão de idioma como latest. Se você estiver usando o Visual Studio, as versões anteriores ao Visual Studio 2022 não são compatíveis com as ferramentas necessárias para criar projetos C# 10.

Criar um espaço de nomes no portal do Azure

Para começar a utilizar as entidades de mensagens do Service Bus no Azure, tem de, primeiro, criar um espaço de nomes que seja exclusivo em todo o Azure. Um namespace fornece um contêiner de escopo para recursos do Service Bus (filas, tópicos, etc.) em seu aplicativo.

Para criar um espaço de nomes:

1. Inicie sessão no portal do Azure.

2. Navegue até a página Todos os serviços.

3. Na barra de navegação esquerda, selecione Integração na lista de categorias, passe o mouse sobre o Service Bus e selecione + o botão no bloco do Service Bus.

   

4. Na marca Basics da página Criar namespace, siga estas etapas:

   1. Em Assinatura, escolha uma assinatura do Azure na qual criar o namespace.

   2. Para Grupo de recursos, escolha um grupo de recursos existente no qual o namespace viverá ou crie um novo.

   3. Insira um nome para o namespace. O nome do namespace deve aderir às seguintes convenções de nomenclatura:

      • O nome deve ser exclusivo no Azure. O sistema verifica imediatamente a disponibilidade do nome.
      • O comprimento do nome é de pelo menos 6 e no máximo 50 caracteres.
      • O nome pode conter apenas letras, números hífenes "-".
      • O nome deve começar com uma letra e terminar com uma letra ou número.
      • O nome não termina com "-sb" ou "-mgmt".

   4. Em Local, escolha a região na qual seu namespace deve ser hospedado.

   5. Em Nível de preço, selecione o nível de preço (Básico, Standard ou Premium) para o namespace. Para este início rápido, selecione Padrão.

      Importante

      Se você quiser usar tópicos e assinaturas, escolha Standard ou Premium. Não há suporte para tópicos/assinaturas no nível de preço Básico.

      Se você selecionou o nível de preço Premium, especifique o número de unidades de mensagens. A camada premium fornece isolamento de recursos no nível de CPU e memória para que cada carga de trabalho seja executada isoladamente. Este contentor de recursos é designado por unidade de mensagens. Um namespace premium tem pelo menos uma unidade de mensagens. Você pode selecionar 1, 2, 4, 8 ou 16 unidades de mensagens para cada namespace Premium do Service Bus. Para obter mais informações, consulte Mensagens Premium do Service Bus.

   6. Selecione Rever + criar na parte inferior da página.

      

   7. Na página Rever + criar, reveja as definições e selecione Criar.

5. Quando a implantação do recurso for bem-sucedida, selecione Ir para o recurso na página de implantação.

   

6. Você vê a home page do namespace do barramento de serviço.

   

Criar uma fila no portal do Azure

1. Na página Namespace do Service Bus, selecione Filas no menu de navegação esquerdo.

2. Na página Filas, selecione + Fila na barra de ferramentas.

3. Insira um nome para a fila e deixe os outros valores com seus padrões.

4. Agora, selecione Criar.

   

Autenticar o aplicativo no Azure

Este início rápido mostra duas maneiras de se conectar ao Barramento de Serviço do Azure: sem senha e cadeia de conexão.

A primeira opção mostra como usar sua entidade de segurança no Microsoft Entra ID e RBAC (controle de acesso baseado em função) para se conectar a um namespace do Service Bus. Você não precisa se preocupar em ter uma cadeia de conexão codificada em seu código ou em um arquivo de configuração ou em um armazenamento seguro como o Azure Key Vault.

A segunda opção mostra como usar uma cadeia de conexão para se conectar a um namespace do Service Bus. Se você for novo no Azure, poderá achar a opção de cadeia de conexão mais fácil de seguir. Recomendamos o uso da opção sem senha em aplicativos e ambientes de produção do mundo real. Para obter mais informações, consulte Autenticação e autorização. Você também pode ler mais sobre autenticação sem senha na página de visão geral.

Iniciar o Visual Studio e entrar no Azure

Você pode autorizar o acesso ao namespace do barramento de serviço usando as seguintes etapas:

1. Inicie o Visual Studio. Se você vir a janela Introdução , selecione o link Continuar sem código no painel direito.

2. Selecione o botão Entrar no canto superior direito do Visual Studio.

   

3. Entre usando a conta do Microsoft Entra à qual você atribuiu uma função anteriormente.

   

Enviar mensagens para a fila

Esta seção mostra como criar um aplicativo de console .NET para enviar mensagens para uma fila do Service Bus.

Criar uma aplicação de consola

1. No Visual Studio, selecione o menu Arquivo ->Novo ->Projeto .

2. Na caixa de diálogo Criar um novo projeto, execute as seguintes etapas: Se não vir esta caixa de diálogo, selecione Ficheiro no menu, selecione Novo e, em seguida, selecione Projeto.

   1. Selecione C# para a linguagem de programação.

   2. Selecione Console para o tipo do aplicativo.

   3. Selecione Aplicativo de console na lista de resultados.

   4. Em seguida, selecione Seguinte.

      

3. Digite QueueSender para o nome do projeto, ServiceBusQueueQuickStart para o nome da solução e selecione Next.

   

4. Na página Informações adicionais, selecione Criar para criar a solução e o projeto.

Adicionar os pacotes NuGet ao projeto

Adicionar código para enviar mensagens para a fila

1. Substitua o conteúdo do pelo código a Program.cs seguir. As etapas importantes são descritas na seção a seguir, com informações adicionais nos comentários de código.

   • Sem senha
   • Cadeia de ligação

   • Cria um objeto ServiceBusClient usando o DefaultAzureCredential objeto. DefaultAzureCredential descobre e usa automaticamente as credenciais de sua entrada no Visual Studio para autenticar no Barramento de Serviço do Azure.
   • Invoca o método CreateSender no objeto ServiceBusClient para criar um objeto ServiceBusSender para a fila específica do Service Bus.
   • Cria um objeto ServiceBusMessageBatch usando o método ServiceBusSender.CreateMessageBatchAsync .
   • Adicione mensagens ao lote usando ServiceBusMessageBatch.TryAddMessage.
   • Envia o lote de mensagens para a fila do Service Bus usando o método ServiceBusSender.SendMessagesAsync .

   Importante

   Atualize os valores de espaço reservado (<NAMESPACE-NAME> e <QUEUE-NAME>) no trecho de código com nomes de seu namespace e fila do Service Bus.

   using Azure.Messaging.ServiceBus;
   using Azure.Identity;
   
   // name of your Service Bus queue
   // the client that owns the connection and can be used to create senders and receivers
   ServiceBusClient client;
   
   // the sender used to publish messages to the queue
   ServiceBusSender sender;
   
   // number of messages to be sent to the queue
   const int numOfMessages = 3;
   
   // The Service Bus client types are safe to cache and use as a singleton for the lifetime
   // of the application, which is best practice when messages are being published or read
   // regularly.
   //
   // Set the transport type to AmqpWebSockets so that the ServiceBusClient uses the port 443. 
   // If you use the default AmqpTcp, ensure that ports 5671 and 5672 are open.
   var clientOptions = new ServiceBusClientOptions
   { 
       TransportType = ServiceBusTransportType.AmqpWebSockets
   };
   //TODO: Replace the "<NAMESPACE-NAME>" and "<QUEUE-NAME>" placeholders.
   client = new ServiceBusClient(
       "<NAMESPACE-NAME>.servicebus.windows.net",
       new DefaultAzureCredential(),
       clientOptions);
   sender = client.CreateSender("<QUEUE-NAME>");
   
   // create a batch 
   using ServiceBusMessageBatch messageBatch = await sender.CreateMessageBatchAsync();
   
   for (int i = 1; i <= numOfMessages; i++)
   {
       // try adding a message to the batch
       if (!messageBatch.TryAddMessage(new ServiceBusMessage($"Message {i}")))
       {
           // if it is too large for the batch
           throw new Exception($"The message {i} is too large to fit in the batch.");
       }
   }
   
   try
   {
       // Use the producer client to send the batch of messages to the Service Bus queue
       await sender.SendMessagesAsync(messageBatch);
       Console.WriteLine($"A batch of {numOfMessages} messages has been published to the queue.");
   }
   finally
   {
       // Calling DisposeAsync on client types is required to ensure that network
       // resources and other unmanaged objects are properly cleaned up.
       await sender.DisposeAsync();
       await client.DisposeAsync();
   }
   
   Console.WriteLine("Press any key to end the application");
   Console.ReadKey();
   

2. Crie o projeto e certifique-se de que não há erros.

3. Execute o programa e aguarde a mensagem de confirmação.

   A batch of 3 messages has been published to the queue
   

   Importante

   Na maioria dos casos, levará um ou dois minutos para que a atribuição de função se propague no Azure. Em casos raros, pode demorar até oito minutos. Se você receber erros de autenticação quando executar o código pela primeira vez, aguarde alguns momentos e tente novamente.

4. No portal do Azure, siga estas etapas:

   1. Navegue até o namespace do Service Bus.

   2. Na página Visão geral, selecione a fila no painel inferior central.

      

   3. Observe os valores na seção Essenciais .

      

   Observe os seguintes valores:

   • O valor de contagem de mensagens ativas para a fila agora é 3. Cada vez que você executa esse aplicativo de remetente sem recuperar as mensagens, esse valor aumenta em 3.
   • O tamanho atual da fila aumenta cada vez que o aplicativo adiciona mensagens à fila.
   • No gráfico Mensagens na seção Métricas inferior, você pode ver que há três mensagens de entrada para a fila.

Receber mensagens da fila

Nesta seção, você cria um aplicativo de console .NET que recebe mensagens da fila.

Criar um projeto para o recetor

1. Na janela Gerenciador de Soluções, clique com o botão direito do mouse na solução ServiceBusQueueQuickStart, aponte para Adicionar e selecione Novo Projeto.
2. Selecione Aplicativo de console e selecione Avançar.
3. Digite QueueReceiver para o nome do projeto e selecione Criar.
4. Na janela Gerenciador de Soluções, clique com o botão direito do mouse em QueueReceiver e selecione Definir como um Projeto de Inicialização.

Adicionar os pacotes NuGet ao projeto

Adicionar o código para receber mensagens da fila

Nesta seção, você adiciona código para recuperar mensagens da fila.

1. Dentro da Program classe, adicione o seguinte código:

   • Sem senha
   • Cadeia de ligação

   using System.Threading.Tasks;
   using Azure.Identity;
   using Azure.Messaging.ServiceBus;
   
   // the client that owns the connection and can be used to create senders and receivers
   ServiceBusClient client;
   
   // the processor that reads and processes messages from the queue
   ServiceBusProcessor processor;
   

2. Anexe os seguintes métodos ao final da Program classe.

   // handle received messages
   async Task MessageHandler(ProcessMessageEventArgs args)
   {
       string body = args.Message.Body.ToString();
       Console.WriteLine($"Received: {body}");
   
       // complete the message. message is deleted from the queue. 
       await args.CompleteMessageAsync(args.Message);
   }
   
   // handle any errors when receiving messages
   Task ErrorHandler(ProcessErrorEventArgs args)
   {
       Console.WriteLine(args.Exception.ToString());
       return Task.CompletedTask;
   }
   

3. Anexe o código a seguir ao final da Program classe. As etapas importantes são descritas na seção a seguir, com informações adicionais nos comentários de código.

   • Sem senha
   • Cadeia de ligação

   • Cria um objeto ServiceBusClient usando o DefaultAzureCredential objeto. DefaultAzureCredential descobre e usa automaticamente as credenciais de sua entrada no Visual Studio para autenticar no Barramento de Serviço do Azure.
   • Invoca o método CreateProcessor no ServiceBusClient objeto para criar um objeto ServiceBusProcessor para a fila especificada do Service Bus.
   • Especifica manipuladores para os eventos ProcessMessageAsync e ProcessErrorAsync do objeto ServiceBusProcessor .
   • Inicia o processamento de mensagens invocando o StartProcessingAsync no ServiceBusProcessor objeto.
   • Quando o usuário pressiona uma tecla para encerrar o processamento, invoca o StopProcessingAsync no ServiceBusProcessor objeto.

   Importante

   Atualize os valores de espaço reservado (<NAMESPACE-NAME> e <QUEUE-NAME>) no trecho de código com nomes de seu namespace e fila do Service Bus.

   // The Service Bus client types are safe to cache and use as a singleton for the lifetime
   // of the application, which is best practice when messages are being published or read
   // regularly.
   //
   // Set the transport type to AmqpWebSockets so that the ServiceBusClient uses port 443. 
   // If you use the default AmqpTcp, make sure that ports 5671 and 5672 are open.
   
   // TODO: Replace the <NAMESPACE-NAME> placeholder
   var clientOptions = new ServiceBusClientOptions()
   {
       TransportType = ServiceBusTransportType.AmqpWebSockets
   };
   client = new ServiceBusClient(
       "<NAMESPACE-NAME>.servicebus.windows.net",
       new DefaultAzureCredential(),
       clientOptions);
   
   // create a processor that we can use to process the messages
   // TODO: Replace the <QUEUE-NAME> placeholder
   processor = client.CreateProcessor("<QUEUE-NAME>", new ServiceBusProcessorOptions());
   
   try
   {
       // add handler to process messages
       processor.ProcessMessageAsync += MessageHandler;
   
       // add handler to process any errors
       processor.ProcessErrorAsync += ErrorHandler;
   
       // start processing 
       await processor.StartProcessingAsync();
   
       Console.WriteLine("Wait for a minute and then press any key to end the processing");
       Console.ReadKey();
   
       // stop processing 
       Console.WriteLine("\nStopping the receiver...");
       await processor.StopProcessingAsync();
       Console.WriteLine("Stopped receiving messages");
   }
   finally
   {
       // Calling DisposeAsync on client types is required to ensure that network
       // resources and other unmanaged objects are properly cleaned up.
       await processor.DisposeAsync();
       await client.DisposeAsync();
   }
   

4. A classe concluída Program deve corresponder ao seguinte código:

   • Sem senha
   • Cadeia de ligação

   using System.Threading.Tasks;
   using Azure.Messaging.ServiceBus;
   using Azure.Identity;
   
   // the client that owns the connection and can be used to create senders and receivers
   ServiceBusClient client;
   
   // the processor that reads and processes messages from the queue
   ServiceBusProcessor processor;
   
   // The Service Bus client types are safe to cache and use as a singleton for the lifetime
   // of the application, which is best practice when messages are being published or read
   // regularly.
   //
   // Set the transport type to AmqpWebSockets so that the ServiceBusClient uses port 443.
   // If you use the default AmqpTcp, make sure that ports 5671 and 5672 are open.
   
   // TODO: Replace the <NAMESPACE-NAME> and <QUEUE-NAME> placeholders
   var clientOptions = new ServiceBusClientOptions() 
   {
       TransportType = ServiceBusTransportType.AmqpWebSockets
   };
   client = new ServiceBusClient("<NAMESPACE-NAME>.servicebus.windows.net", 
       new DefaultAzureCredential(), clientOptions);
   
   // create a processor that we can use to process the messages
   // TODO: Replace the <QUEUE-NAME> placeholder
   processor = client.CreateProcessor("<QUEUE-NAME>", new ServiceBusProcessorOptions());
   
   try
   {
       // add handler to process messages
       processor.ProcessMessageAsync += MessageHandler;
   
       // add handler to process any errors
       processor.ProcessErrorAsync += ErrorHandler;
   
       // start processing 
       await processor.StartProcessingAsync();
   
       Console.WriteLine("Wait for a minute and then press any key to end the processing");
       Console.ReadKey();
   
       // stop processing 
       Console.WriteLine("\nStopping the receiver...");
       await processor.StopProcessingAsync();
       Console.WriteLine("Stopped receiving messages");
   }
   finally
   {
       // Calling DisposeAsync on client types is required to ensure that network
       // resources and other unmanaged objects are properly cleaned up.
       await processor.DisposeAsync();
       await client.DisposeAsync();
   }
   
   // handle received messages
   async Task MessageHandler(ProcessMessageEventArgs args)
   {
       string body = args.Message.Body.ToString();
       Console.WriteLine($"Received: {body}");
   
       // complete the message. message is deleted from the queue. 
       await args.CompleteMessageAsync(args.Message);
   }
   
   // handle any errors when receiving messages
   Task ErrorHandler(ProcessErrorEventArgs args)
   {
       Console.WriteLine(args.Exception.ToString());
       return Task.CompletedTask;
   }
   

5. Crie o projeto e certifique-se de que não há erros.

6. Execute o aplicativo recetor. Você deve ver as mensagens recebidas. Pressione qualquer tecla para parar o recetor e o aplicativo.

   Wait for a minute and then press any key to end the processing
   Received: Message 1
   Received: Message 2
   Received: Message 3
   
   Stopping the receiver...
   Stopped receiving messages
   

7. Consulte novamente o portal. Aguarde alguns minutos e atualize a página se não vir 0 mensagens ativas .

   • Os valores Contagem de mensagens ativas e Tamanho atual agora são 0.

   • No gráfico Mensagens na seção Métricas inferior, você pode ver que há três mensagens de entrada e três de saída para a fila.

     

Clean up resources (Limpar recursos)

Navegue até o namespace do Service Bus no portal do Azure e selecione Excluir no portal do Azure para excluir o namespace e a fila nele.

Consulte também

Consulte a seguinte documentação e exemplos:

• Biblioteca de cliente do Barramento de Serviço do Azure para .NET - Leiame
• Exemplos no GitHub
• Referência da API .NET
• Abstraia as preocupações com a infraestrutura com estruturas de nível superior, como o NServiceBus

Próximos passos