Prise en main des files d’attente Service BusGet started with Service Bus queues

Dans ce tutoriel, vous créez des applications console .NET Core afin d’échanger des messages avec une file d’attente Service Bus.In this tutorial, you create .NET Core console applications to send messages to and receive messages from a Service Bus queue.

PrérequisPrerequisites

Envoyer des messages à la file d’attenteSend messages to the queue

Pour envoyer des messages à la file d’attente, écrivez une application de console C# à l’aide de Visual Studio.To send messages to the queue, write a C# console application using Visual Studio.

Création d’une application consoleCreate a console application

Ouvrez Visual Studio et créez un projet Application de console (.NET Core) pour C#.Launch Visual Studio and create a new Console App (.NET Core) project for C#. Cet exemple nomme l’application CoreSenderApp.This example names the app CoreSenderApp.

Ajout du package NuGet Service BusAdd the Service Bus NuGet package

  1. Cliquez avec le bouton droit sur le projet créé et sélectionnez Gérer les packages NuGet.Right-click the newly created project and select Manage NuGet Packages.

  2. Sélectionnez Parcourir.Select Browse. Recherchez et sélectionnez Microsoft.Azure.ServiceBus .Search for and select Microsoft.Azure.ServiceBus.

  3. Sélectionnez Installer pour procéder à l’installation, puis fermez le gestionnaire de package NuGet.Select Install to complete the installation, then close the NuGet Package Manager.

    Sélectionner un package NuGet

Écrire du code pour envoyer des messages à la file d’attenteWrite code to send messages to the queue

  1. Dans Program.cs, ajoutez les instructions using suivantes en haut de la définition de l’espace de noms, avant la déclaration de classe :In Program.cs, add the following using statements at the top of the namespace definition, before the class declaration:

    using System.Text;
    using System.Threading;
    using System.Threading.Tasks;
    using Microsoft.Azure.ServiceBus;
    
  2. Dans la classe Program, déclarez les variables suivantes :In the Program class, declare the following variables:

    const string ServiceBusConnectionString = "<your_connection_string>";
    const string QueueName = "<your_queue_name>";
    static IQueueClient queueClient;
    

    Entrez votre chaîne de connexion pour l’espace de noms en tant que variable ServiceBusConnectionString.Enter your connection string for the namespace as the ServiceBusConnectionString variable. Entrez le nom de votre file d’attente.Enter your queue name.

  3. Remplacez la méthode Main() par la méthode asynchrone Main suivante.Replace the Main() method with the following async Main method. Elle appelle la méthode SendMessagesAsync que vous ajouterez à l’étape suivante pour envoyer des messages à la file d’attente.It calls the SendMessagesAsync method that you will add in the next step to send messages to the queue.

    public static async Task Main(string[] args)
    {    
        const int numberOfMessages = 10;
        queueClient = new QueueClient(ServiceBusConnectionString, QueueName);
    
        Console.WriteLine("======================================================");
        Console.WriteLine("Press ENTER key to exit after sending all the messages.");
        Console.WriteLine("======================================================");
    
        // Send messages.
        await SendMessagesAsync(numberOfMessages);
    
        Console.ReadKey();
    
        await queueClient.CloseAsync();
    }
    
  4. Juste après la méthode MainAsync(), ajoutez la méthode SendMessagesAsync() suivante qui effectue l’opération d’envoi du nombre de message spécifié par numberOfMessagesToSend (la valeur est actuellement définie sur 10) :Directly after the MainAsync() method, add the following SendMessagesAsync() method that does the work of sending the number of messages specified by numberOfMessagesToSend (currently set to 10):

    static async Task SendMessagesAsync(int numberOfMessagesToSend)
    {
        try
        {
            for (var i = 0; i < numberOfMessagesToSend; i++)
            {
                // Create a new message to send to the queue.
                string messageBody = $"Message {i}";
                var message = new Message(Encoding.UTF8.GetBytes(messageBody));
    
                // Write the body of the message to the console.
                Console.WriteLine($"Sending message: {messageBody}");
    
                // Send the message to the queue.
                await queueClient.SendAsync(message);
            }
        }
        catch (Exception exception)
        {
            Console.WriteLine($"{DateTime.Now} :: Exception: {exception.Message}");
        }
    }
    

Voici à quoi doit ressembler votre fichier Program.cs.Here is what your Program.cs file should look like.

namespace CoreSenderApp
{
    using System;
    using System.Text;
    using System.Threading;
    using System.Threading.Tasks;
    using Microsoft.Azure.ServiceBus;

    class Program
    {
        // Connection String for the namespace can be obtained from the Azure portal under the 
        // 'Shared Access policies' section.
        const string ServiceBusConnectionString = "<your_connection_string>";
        const string QueueName = "<your_queue_name>";
        static IQueueClient queueClient;

        public static async Task Main(string[] args)
        {    
            const int numberOfMessages = 10;
            queueClient = new QueueClient(ServiceBusConnectionString, QueueName);
    
            Console.WriteLine("======================================================");
            Console.WriteLine("Press ENTER key to exit after sending all the messages.");
            Console.WriteLine("======================================================");
    
            // Send messages.
            await SendMessagesAsync(numberOfMessages);
    
            Console.ReadKey();
    
            await queueClient.CloseAsync();
        }

        static async Task SendMessagesAsync(int numberOfMessagesToSend)
        {
            try
            {
                for (var i = 0; i < numberOfMessagesToSend; i++)
                {
                    // Create a new message to send to the queue
                    string messageBody = $"Message {i}";
                    var message = new Message(Encoding.UTF8.GetBytes(messageBody));

                    // Write the body of the message to the console
                    Console.WriteLine($"Sending message: {messageBody}");

                    // Send the message to the queue
                    await queueClient.SendAsync(message);
                }
            }
            catch (Exception exception)
            {
                Console.WriteLine($"{DateTime.Now} :: Exception: {exception.Message}");
            }
        }
    }
}

Exécutez le programme et vérifiez le Portail Azure.Run the program and check the Azure portal.

Sélectionnez le nom de votre file d’attente dans la fenêtre Vue d’ensemble de l’espace de noms pour afficher la section Fondamentaux de la file d’attente.Select the name of your queue in the namespace Overview window to display queue Essentials.

Messages reçus avec nombre et taille

La valeur Nombre de messages actifs pour la file d’attente doit à présent être de 10.The Active message count value for the queue is now 10. Chaque fois que vous exécutez cette application d’expéditeur sans récupérer les messages, cette valeur augmente de 10.Each time you run this sender app without retrieving the messages, this value increases by 10.

La taille actuelle de la file d’attente incrémente la valeur ACTUEL dans Fondamentaux chaque fois que l’application ajoute des messages à la file d’attente.The current size of the queue increments the CURRENT value in Essentials each time the app adds messages to the queue.

La section suivante décrit comment récupérer ces messages.The next section describes how to retrieve these messages.

Recevoir les messages d'une file d'attenteReceive messages from the queue

Pour recevoir les messages que vous avez envoyés, créez un autre application Application console (.NET Core) .To receive the messages you sent, create another Console App (.NET Core) application. Installez le package NuGet Microsoft.Azure.ServiceBus, comme vous l’avez fait pour l’application d’expéditeur.Install the Microsoft.Azure.ServiceBus NuGet package, as you did for the sender application.

Écrire du code pour recevoir des messages de la file d’attenteWrite code to receive messages from the queue

  1. Dans Program.cs, ajoutez les instructions using suivantes en haut de la définition de l’espace de noms, avant la déclaration de classe :In Program.cs, add the following using statements at the top of the namespace definition, before the class declaration:

    using System.Text;
    using System.Threading;
    using System.Threading.Tasks;
    using Microsoft.Azure.ServiceBus;
    
  2. Dans la classe Program, déclarez les variables suivantes :In the Program class, declare the following variables:

    const string ServiceBusConnectionString = "<your_connection_string>";
    const string QueueName = "<your_queue_name>";
    static IQueueClient queueClient;
    

    Entrez votre chaîne de connexion pour l’espace de noms en tant que variable ServiceBusConnectionString.Enter your connection string for the namespace as the ServiceBusConnectionString variable. Entrez le nom de votre file d’attente.Enter your queue name.

  3. Remplacez le contenu par défaut de Main() par la ligne de code suivante :Replace the default contents of Main() with the following line of code:

    public static async Task Main(string[] args)
    {    
        queueClient = new QueueClient(ServiceBusConnectionString, QueueName);
    
        Console.WriteLine("======================================================");
        Console.WriteLine("Press ENTER key to exit after receiving all the messages.");
        Console.WriteLine("======================================================");
    
        // Register the queue message handler and receive messages in a loop
        RegisterOnMessageHandlerAndReceiveMessages();
    
        Console.ReadKey();
    
        await queueClient.CloseAsync();
    }
    
  4. Juste après la méthode MainAsync(), ajoutez la méthode suivante, qui enregistre le gestionnaire de messages et reçoit les messages envoyés par l’application d’expéditeur :Directly after the MainAsync() method, add the following method, which registers the message handler and receives the messages sent by the sender application:

    static void RegisterOnMessageHandlerAndReceiveMessages()
    {
        // Configure the message handler options in terms of exception handling, number of concurrent messages to deliver, etc.
        var messageHandlerOptions = new MessageHandlerOptions(ExceptionReceivedHandler)
        {
            // Maximum number of concurrent calls to the callback ProcessMessagesAsync(), set to 1 for simplicity.
            // Set it according to how many messages the application wants to process in parallel.
            MaxConcurrentCalls = 1,
    
            // Indicates whether the message pump should automatically complete the messages after returning from user callback.
            // False below indicates the complete operation is handled by the user callback as in ProcessMessagesAsync().
            AutoComplete = false
        };
    
        // Register the function that processes messages.
        queueClient.RegisterMessageHandler(ProcessMessagesAsync, messageHandlerOptions);
    }
    
  5. Juste après la méthode précédente, ajoutez la méthode ProcessMessagesAsync() suivante pour traiter les messages reçus :Directly after the previous method, add the following ProcessMessagesAsync() method to process the received messages:

    static async Task ProcessMessagesAsync(Message message, CancellationToken token)
    {
        // Process the message.
        Console.WriteLine($"Received message: SequenceNumber:{message.SystemProperties.SequenceNumber} Body:{Encoding.UTF8.GetString(message.Body)}");
    
        // Complete the message so that it is not received again.
        // This can be done only if the queue Client is created in ReceiveMode.PeekLock mode (which is the default).
        await queueClient.CompleteAsync(message.SystemProperties.LockToken);
    
        // Note: Use the cancellationToken passed as necessary to determine if the queueClient has already been closed.
        // If queueClient has already been closed, you can choose to not call CompleteAsync() or AbandonAsync() etc.
        // to avoid unnecessary exceptions.
    }
    
  6. Enfin, ajoutez la méthode suivante pour gérer les exceptions qui peuvent se produire :Finally, add the following method to handle any exceptions that might occur:

    // Use this handler to examine the exceptions received on the message pump.
    static Task ExceptionReceivedHandler(ExceptionReceivedEventArgs exceptionReceivedEventArgs)
    {
        Console.WriteLine($"Message handler encountered an exception {exceptionReceivedEventArgs.Exception}.");
        var context = exceptionReceivedEventArgs.ExceptionReceivedContext;
        Console.WriteLine("Exception context for troubleshooting:");
        Console.WriteLine($"- Endpoint: {context.Endpoint}");
        Console.WriteLine($"- Entity Path: {context.EntityPath}");
        Console.WriteLine($"- Executing Action: {context.Action}");
        return Task.CompletedTask;
    }
    

Voici à quoi doit ressembler votre fichier Program.cs :Here is what your Program.cs file should look like:

namespace CoreReceiverApp
{
    using System;
    using System.Text;
    using System.Threading;
    using System.Threading.Tasks;
    using Microsoft.Azure.ServiceBus;

    class Program
    {
        // Connection String for the namespace can be obtained from the Azure portal under the 
        // 'Shared Access policies' section.
        const string ServiceBusConnectionString = "<your_connection_string>";
        const string QueueName = "<your_queue_name>";
        static IQueueClient queueClient;

        static void Main(string[] args)
        {
            MainAsync().GetAwaiter().GetResult();
        }

        static async Task MainAsync()
        {
            queueClient = new QueueClient(ServiceBusConnectionString, QueueName);

            Console.WriteLine("======================================================");
            Console.WriteLine("Press ENTER key to exit after receiving all the messages.");
            Console.WriteLine("======================================================");

            // Register QueueClient's MessageHandler and receive messages in a loop
            RegisterOnMessageHandlerAndReceiveMessages();
 
            Console.ReadKey();

            await queueClient.CloseAsync();
        }

        static void RegisterOnMessageHandlerAndReceiveMessages()
        {
            // Configure the MessageHandler Options in terms of exception handling, number of concurrent messages to deliver etc.
            var messageHandlerOptions = new MessageHandlerOptions(ExceptionReceivedHandler)
            {
                // Maximum number of Concurrent calls to the callback `ProcessMessagesAsync`, set to 1 for simplicity.
                // Set it according to how many messages the application wants to process in parallel.
                MaxConcurrentCalls = 1,

                // Indicates whether MessagePump should automatically complete the messages after returning from User Callback.
                // False below indicates the Complete will be handled by the User Callback as in `ProcessMessagesAsync` below.
                AutoComplete = false
            };

            // Register the function that will process messages
            queueClient.RegisterMessageHandler(ProcessMessagesAsync, messageHandlerOptions);
        }

        static async Task ProcessMessagesAsync(Message message, CancellationToken token)
        {
            // Process the message
            Console.WriteLine($"Received message: SequenceNumber:{message.SystemProperties.SequenceNumber} Body:{Encoding.UTF8.GetString(message.Body)}");

            // Complete the message so that it is not received again.
            // This can be done only if the queueClient is created in ReceiveMode.PeekLock mode (which is default).
            await queueClient.CompleteAsync(message.SystemProperties.LockToken);

            // Note: Use the cancellationToken passed as necessary to determine if the queueClient has already been closed.
            // If queueClient has already been Closed, you may chose to not call CompleteAsync() or AbandonAsync() etc. calls 
            // to avoid unnecessary exceptions.
        }

        static Task ExceptionReceivedHandler(ExceptionReceivedEventArgs exceptionReceivedEventArgs)
        {
            Console.WriteLine($"Message handler encountered an exception {exceptionReceivedEventArgs.Exception}.");
            var context = exceptionReceivedEventArgs.ExceptionReceivedContext;
            Console.WriteLine("Exception context for troubleshooting:");
            Console.WriteLine($"- Endpoint: {context.Endpoint}");
            Console.WriteLine($"- Entity Path: {context.EntityPath}");
            Console.WriteLine($"- Executing Action: {context.Action}");
            return Task.CompletedTask;
        }
    }
}

Réexécutez le programme et vérifiez le portail.Run the program, and check the portal again. Les valeurs Nombre de messages actifs et ACTUEL sont à présent de 0.The Active message count and CURRENT values are now 0.

File d’attente après la réception des messages

Félicitations !Congratulations! Vous avez maintenant créé une file d’attente, envoyé un ensemble de messages à cette dernière et reçu ces messages de la même file d’attente.You've now created a queue, sent a set of messages to that queue, and received those messages from the same queue.

Notes

Vous pouvez gérer les ressources Service Bus à l'aide de Service Bus Explorer.You can manage Service Bus resources with Service Bus Explorer. Service Bus Explorer permet aux utilisateurs de se connecter facilement à un espace de noms Service Bus et de gérer les entités de messagerie.The Service Bus Explorer allows users to easily connect to a Service Bus namespace and administer messaging entities. L’outil fournit des fonctionnalités avancées telles que la fonction importer/exporter ou la possibilité de tester des rubriques, des files d’attente, des abonnements, des services de relais, des hubs de notification et des hubs d’événements.The tool provides advanced features like import/export functionality or the ability to test topics, queues, subscriptions, relay services, notification hubs, and event hubs.

Étapes suivantesNext steps

Consultez les référentiels GitHub accompagnés d’exemples qui illustrent certaines des fonctionnalités les plus avancées de la messagerie Service Bus.Check out our GitHub repository with samples that demonstrate some of the more advanced features of Service Bus messaging.