Краткое руководство: Отправка и получение сообщений из очереди Azure Service Bus (.NET)

В этом кратком руководстве вы выполните следующие шаги:

1. Создание пространства имен служебной шины с помощью портала Azure.

2. Создание очереди служебной шины с помощью портала Azure.

3. Напишите консольное приложение .NET для отправки набора сообщений в очередь.

4. Напишите консольное приложение .NET для получения этих сообщений из очереди.

   В этом кратком руководстве приведены пошаговые инструкции по реализации простого сценария отправки пакета сообщений в очередь Service Bus, а затем их получения. Общие сведения о клиентской библиотеке Служебной шины Azure для .NET см. в этой статье. Для получения дополнительных примеров см. Service Bus .NET samples на GitHub.

Предварительные условия

Если вы впервые используете эту службу, ознакомьтесь с обзором Service Bus, прежде чем приступить к этому краткому руководству.

• Подписка Azure. Чтобы использовать службы Azure, включая Служебную шину Azure, вам потребуется подписка. Если у вас нет существующей учетной записи Azure, вы можете зарегистрироваться и получить бесплатную пробную версию.
• Visual Studio 2022 или более поздней версии. Пример приложения использует новые функции, представленные в C# 10. Вы все еще можете использовать библиотеку клиента Service Bus с предыдущими версиями языка C#, но синтаксис может отличаться. Чтобы использовать последний синтаксис, рекомендуется установить .NET 6.0 или более позднюю версию и установить версию языка на latest. Если вы используете Visual Studio, версии до Visual Studio 2022 несовместимы с инструментами, необходимыми для сборки проектов C# 10.

Создание пространства имен на портале Azure

Чтобы начать использование сущностей обмена сообщениями служебной шины в Azure, создайте пространство имен с уникальным именем в Azure. Пространство имен предоставляет контейнер области для ресурсов Service Bus, таких как очереди и темы в вашем приложении.

Чтобы создать пространство имен:

1. Войдите на портал Azure.

2. Выберите всплывающее меню в левом верхнем углу и перейдите на страницу "Все службы".

3. На панели навигации слева выберите "Интеграция".

4. Прокрутите вниз до служб обмена сообщениями, наведите указатель мыши на служебную шину и нажмите кнопку "Создать".

   

5. На вкладке "Основы" страницы"Создание пространства имен " выполните следующие действия:

   1. Выберите подписку Azure, в которой будет создано пространство имен.

   2. Для группы ресурсов выберите существующую группу ресурсов или создайте новую.

   3. Введите название пространства имён, соответствующее следующим соглашениям об именовании:

      • Это имя должно быть уникальным в пределах Azure. Система немедленно проверяет, доступно ли имя.
      • Длина имени составляет не менее 6 и не более 50 символов.
      • Имя может содержать только буквы, цифры и дефисы -.
      • Имя должно начинаться с буквы и заканчиваться буквой или цифрой.
      • Имя не заканчивается на -sb или -mgmt.

   4. Для расположения выберите регион для размещения пространства имен.

   5. Для параметра Ценовая категория выберите ценовую категорию ("Базовый", "Стандартный" или "Премиум") для пространства имен. Для работы с этим кратким руководством выберите вариант Стандартный.

      Если выбрать уровень "Премиум" , можно включить георепликацию для пространства имен. Функция георепликации гарантирует, что метаданные и данные пространства имен постоянно реплицируются из основного региона в один или несколько дополнительных регионов.

      Внимание

      Чтобы использовать разделы и подписки, выберите категорию "Стандартный" или "Премиум". Ценовая категория "Базовый" не поддерживает разделы и подписки.

      Если выбрана ценовая категория Премиум, укажите число единиц обмена сообщениями. В категории "Премиум" обеспечивается изоляция ресурсов на уровне ЦП и памяти, так что рабочая нагрузка выполняется изолированно от других. Этот контейнер ресурсов называется как единица обмена сообщениями. Пространству имен ценовой категории "Премиум" выделяется по крайней мере одна единица обмена сообщениями. Вы можете выбрать 1, 2, 4, 8 или 16 единиц обмена сообщениями для каждого пространства имен служебной шины Premium. Дополнительные сведения см. в разделе Премиум-уровень обмена сообщениями в служебной шине.

   6. Нажмите Review + create внизу страницы.

      

   7. На странице "Просмотр и создание " просмотрите параметры и нажмите кнопку "Создать".

6. После успешного развертывания ресурса выберите "Перейти к ресурсу " на странице развертывания.

   

7. Вы увидите главную страницу пространства имен служебной шины.

   

Создание очереди на портале Azure

1. На странице пространства имен служебная шина разверните сущности в меню навигации слева и выберите "Очереди".

2. На странице Очереди, на панели инструментов выберите + Очередь.

3. Введите имя очереди. Оставьте другие значения своими значениями по умолчанию.

4. Нажмите кнопку "Создать".

   

Проверка подлинности приложения в Azure

В этой статье показаны два способа подключения к шине обслуживания Azure: без пароля и строка подключения.

Первый вариант показывает, как использовать учетные данные безопасности в Microsoft Entra ID и ролевое управление доступом (RBAC) для подключения к пространству имен Service Bus. Вам не нужно беспокоиться о жёстко закодированной строке подключения в вашем коде, в файле конфигурации или в безопасном хранилище, таком как Azure Key Vault.

Второй вариант показывает, как использовать строку подключения для подключения к пространству имен Service Bus. Если вы не знакомы с Azure, вам может быть проще работать с вариантом строки подключения. Мы рекомендуем использовать параметр без пароля в реальных приложениях и рабочих средах. Дополнительные сведения см. в разделе Проверка подлинности и авторизация Service Bus. Дополнительные сведения о проверке подлинности без пароля см. в статье "Проверка подлинности приложений .NET".

Запуск Visual Studio

Отправка сообщений в очередь

В этом разделе показано, как можно создать консольное приложение .NET, чтобы отправлять сообщения в очередь Service Bus.

Создайте консольное приложение

1. В Visual Studio выберите "Файл ->Создать ->Проект".

2. В диалоговом окне Создать проект выполните следующие действия: (если это диалоговое окно не отображается, щелкните в меню пункт Файл, затем последовательно выберите Создать и Проект).

   1. Выберите язык программирования C#.

   2. Для типа приложения выберите значение Консоль.

   3. Выберите консольное приложение из списка результатов.

   4. Затем выберите Далее.

      

3. Введите QueueSender в качестве имени проекта, ServiceBusQueueQuickStart в качестве имени решения, после чего нажмите Далее.

   

4. На странице Дополнительная информация выберите Создать для создания решения и проекта.

Добавление пакетов NuGet в проект

Добавление кода для отправки сообщений в очередь

1. Замените все содержимое Program.cs следующим кодом: Важные шаги описаны в следующем разделе с дополнительными сведениями в комментариях кода.

   • Без пароля
   • Строка соединения

   • Создает объект ServiceBusClient с помощью DefaultAzureCredential объекта. DefaultAzureCredential автоматически обнаруживает и использует учетные данные вашей учетной записи входа в Visual Studio для аутентификации в Azure Service Bus.
   • Вызов метода CreateSender для ServiceBusClient. Это позволяет создать объект ServiceBusSender для указанной очереди Служебной шины.
   • Создание объекта ServiceBusMessageBatch с использованием метода ServiceBusSender.CreateMessageBatchAsync.
   • Добавление сообщений в пакет с помощью ServiceBusMessageBatch.TryAddMessage.
   • Отправка пакета сообщений в очередь Служебной шины Microsoft Azure с помощью метода ServiceBusSender.SendMessagesAsync.

   Внимание

   Обновите значения заполнителей (<NAMESPACE-NAME> и <QUEUE-NAME>) в фрагменте кода, подставив имена пространства имен и очереди вашей шины обслуживания.

   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. Выполните сборку проекта и убедитесь, что она прошла без ошибок.

3. Выполните программу и дождитесь подтверждающего сообщения.

   A batch of 3 messages has been published to the queue
   

   Внимание

   В большинстве случаев для распространения назначения ролей в Azure требуется минута или две. В редких случаях может потребоваться до восьми минут. Если при первом запуске кода возникают ошибки аутентификации, подождите несколько минут и повторите попытку.

4. На портале Azure выполните следующие действия:

   1. Перейдите к пространству имен вашего Service Bus.

   2. На странице Обзор выберите очередь в центральной области снизу.

      

   3. Обратите внимание на значения в разделе "Параметры ".

      

   Обратите внимание на следующие значения:

   • Значение счетчика Активных сообщений для очереди теперь равно 3. Всякий раз, когда вы запускаете это приложение-отправитель без получения сообщений, это значение увеличивается на 3.
   • Текущий размер очереди увеличивается каждый раз, когда приложение добавляет сообщения в очередь.
   • На диаграмме Сообщения в нижнем разделе Показатели вы можете увидеть, что в очереди есть три входящих сообщения.

Получение сообщений из очереди

В этом разделе описано, как создать консольное приложение .NET, которое получает сообщения из очереди.

Создание проекта для получателя

1. В окне Обозревателя решений щелкните правой кнопкой мыши решение ServiceBusQueueQuickStart, выберите Добавить и выберите Новый проект.
2. Выберите Консольное приложение и нажмите Далее.
3. Введите QueueReceiver в поле Название проекта и выберите Создать.
4. В окне Обозреватель решений щелкните правой кнопкой мыши QueueReceiver и выберите Установить как запускаемый проект.

Добавление пакетов NuGet в проект

Добавьте код для получения сообщений из очереди

В этом разделе вы добавите код для получения сообщений из очереди.

1. Program В классе добавьте следующий код:

   • Без пароля
   • Строка соединения

   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. Добавьте следующие методы в конец Program класса.

   // 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. Добавьте следующий код в конец Program класса. Важные шаги описаны в следующем разделе с дополнительными сведениями в комментариях кода.

   • Без пароля
   • Строка соединения

   • Создает объект ServiceBusClient с помощью DefaultAzureCredential объекта. DefaultAzureCredential автоматически обнаруживает и использует учетные данные входа в Visual Studio для аутентификации в Службе шины Azure.
   • Вызов метода CreateProcessor для объекта ServiceBusClient. Это позволяет создать объект ServiceBusProcessor для указанной очереди служебной шины.
   • Указание обработчиков для событий ProcessMessageAsync и ProcessErrorAsync объекта ServiceBusProcessor.
   • Запуск обработки сообщений путем вызова StartProcessingAsync для объекта ServiceBusProcessor.
   • Вызов StopProcessingAsync для объекта ServiceBusProcessor при нажатии пользователем кнопки для завершения обработки.

   Внимание

   Обновите значения заполнителей (<NAMESPACE-NAME> и <QUEUE-NAME>) в фрагменте кода именами вашего пространства имен 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. Завершенный Program класс должен соответствовать следующему коду:

   • Без пароля
   • Строка соединения

   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. Выполните сборку проекта и убедитесь, что она прошла без ошибок.

6. Запустите приложение получателя. Вы должны увидеть полученные сообщения. Нажмите любую клавишу, чтобы остановить работу приемника и приложения.

   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. Снова просмотрите сведения на портале. Подождите несколько минут и обновите страницу, если вы не видите 0 для Активных сообщений.

   • Значения Активных сообщений и Текущий размер теперь равны 0.

   • На диаграмме Сообщения в разделе Метрики в нижней части страницы можно увидеть, что в очередь поступило три входящих и три исходящих сообщения.

     

Дополнительная информация:

Ознакомьтесь со следующими примерами и документацией:

• Библиотека клиента Служебной шины Azure для .NET - файл Readme
• Примеры на GitHub
• Справочник по API .NET
• Абстрагируйте вопросы инфраструктуры, используя такие высокоуровневые фреймворки, как NServiceBus

Очистка ресурсов

Перейдите к пространству имен службы шины на портале Azure и выберите Удалить на портале Azure, чтобы удалить пространство имен и очередь в нём.

Связанный контент

См. Начало работы с темами и подписками в Azure Service Bus (.NET).