Začínáme s frontami služby Service BusGet started with Service Bus queues

V tomto kurzu vytvoříte konzolové aplikace .NET Core k odesílání a příjem zpráv z fronty Service Bus.In this tutorial, you create .NET Core console applications to send messages to and receive messages from a Service Bus queue.

PožadavkyPrerequisites

  1. Visual Studio 2017 s aktualizací Update 3 (verze 15.3, 26730.01) nebo novější.Visual Studio 2017 Update 3 (version 15.3, 26730.01) or later.
  2. NET Core SDK verze 2.0 nebo novější.NET Core SDK, version 2.0 or later.
  3. Předplatné Azure.An Azure subscription. K dokončení tohoto kurzu potřebujete mít účet Azure.To complete this tutorial, you need an Azure account. Můžete si aktivovat váš výhody pro předplatitele MSDN nebo si zaregistrovat bezplatný účet.You can activate your MSDN subscriber benefits or sign up for a free account.
  4. Pokud nemáte k dispozici pro práci s frontou, postupujte podle kroků v použijte Azure portal můžete vytvořit frontu služby Service Bus článku můžete vytvořit frontu.If you don't have a queue to work with, follow steps in the Use Azure portal to create a Service Bus queue article to create a queue.
    1. Přečtěte si rychlé přehled služby Service Bus fronty.Read the quick overview of Service Bus queues.
    2. Vytvoření služby Service Bus obor názvů.Create a Service Bus namespace.
    3. Získejte připojovací řetězec.Get the connection string.
    4. Vytvoření služby Service Bus fronty.Create a Service Bus queue.

Zasílání zpráv do frontySend messages to the queue

Abychom mohli do fronty odesílat zprávy, napíšeme v sadě Visual Studio konzolovou aplikaci v jazyce C#.To send messages to the queue, write a C# console application using Visual Studio.

Vytvoření konzolové aplikaceCreate a console application

Spusťte sadu Visual Studio a vytvořte nový projekt Konzolová aplikace (.NET Core) .Launch Visual Studio and create a new Console App (.NET Core) project.

Přidání balíčku Service Bus NuGetAdd the Service Bus NuGet package

  1. Klikněte pravým tlačítkem na nově vytvořený projekt a vyberte možnost Spravovat balíčky NuGet.Right-click the newly created project and select Manage NuGet Packages.

  2. Klikněte na kartu Procházet, vyhledejte Microsoft.Azure.ServiceBus a pak vyberte položku Microsoft.Azure.ServiceBus.Click the Browse tab, search for Microsoft.Azure.ServiceBus, and then select the Microsoft.Azure.ServiceBus item. Klikněte na Instalovat a dokončete instalaci, pak zavřete dialogové okno.Click Install to complete the installation, then close this dialog box.

    Výběr balíčku NuGet

Napsání kódu pro odesílání zpráv do frontyWrite code to send messages to the queue

  1. V souboru Program.cs přidejte následující příkazy using do horní části definice oboru názvů před deklaraci třídy: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. V rámci třídy Program deklarujte následující proměnné.Within the Program class, declare the following variables. Nastavte proměnnou ServiceBusConnectionString na připojovací řetězec, který jste získali při vytváření oboru názvů, a proměnnou QueueName nastavte na název, který jste použili při vytváření fronty:Set the ServiceBusConnectionString variable to the connection string that you obtained when creating the namespace, and set QueueName to the name that you used when creating the queue:

    const string ServiceBusConnectionString = "<your_connection_string>";
    const string QueueName = "<your_queue_name>";
    static IQueueClient queueClient;
    
  3. Nahraďte výchozí obsah metody Main() následujícím řádkem kódu:Replace the default contents of Main() with the following line of code:

    MainAsync().GetAwaiter().GetResult();
    
  4. Přímo za metodu Main() přidejte následující asynchronní metodu MainAsync(), která volá metodu pro odeslání zpráv:Directly after Main(), add the following asynchronous MainAsync() method that calls the send messages method:

    static async Task MainAsync()
    {
        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();
    }
    
  5. Přímo za metodu MainAsync() přidejte následující metodu SendMessagesAsync(), která provádí odeslání určitého počtu zpráv zadaného v proměnné numberOfMessagesToSend (aktuálně nastavená na hodnotu 10):Directly after the MainAsync() method, add the following SendMessagesAsync() method that performs 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}");
        }
    }
    
  6. Soubor Program.cs by měl vypadat takhle.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;
    
            static void Main(string[] args)
            {
                MainAsync().GetAwaiter().GetResult();
            }
    
            static async Task MainAsync()
            {
                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}");
                }
            }
        }
    }
    
  7. Spusťte program a podívejte se na web Azure Portal: klikněte na název vaší fronty v okně Přehled oboru názvů.Run the program, and check the Azure portal: click the name of your queue in the namespace Overview window. Zobrazí se obrazovka Základy fronty.The queue Essentials screen is displayed. Všimněte si, že hodnota Počet aktivních zpráv pro frontu je teď 10.Notice that the Active Message Count value for the queue is now 10. Pokaždé, když spustíte aplikaci odesílatele bez načtení zpráv (jak je popsáno v další části), se tato hodnota zvýší o 10.Each time you run the sender application without retrieving the messages (as described in the next section), this value increases by 10. Všimněte si také, že aktuální velikost fronty navyšuje hodnotu Aktuální v okně Základy pokaždé, když aplikace do dané fronty přidá zprávy.Also note that the current size of the queue increments the Current value in the Essentials window each time the app adds messages to the queue.

    Velikost zpráv

Přijetí zpráv z frontyReceive messages from the queue

Pokud chcete přijímat zprávy, které jste odeslali, vytvořte další konzolovou aplikaci .NET Core a nainstalujte Microsoft.Azure.ServiceBus balíček NuGet, podobně jako předtím u aplikace odesílatele.To receive the messages you sent, create another .NET Core console application and install the Microsoft.Azure.ServiceBus NuGet package, similar to the previous sender application.

Napsání kódu pro příjem zpráv z frontyWrite code to receive messages from the queue

  1. V souboru Program.cs přidejte následující příkazy using do horní části definice oboru názvů před deklaraci třídy: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. V rámci třídy Program deklarujte následující proměnné.Within the Program class, declare the following variables. Nastavte proměnnou ServiceBusConnectionString na připojovací řetězec, který jste získali při vytváření oboru názvů, a proměnnou QueueName nastavte na název, který jste použili při vytváření fronty:Set the ServiceBusConnectionString variable to the connection string that you obtained when creating the namespace, and set QueueName to the name that you used when creating the queue:

    const string ServiceBusConnectionString = "<your_connection_string>";
    const string QueueName = "<your_queue_name>";
    static IQueueClient queueClient;
    
  3. Nahraďte výchozí obsah metody Main() následujícím řádkem kódu:Replace the default contents of Main() with the following line of code:

    MainAsync().GetAwaiter().GetResult();
    
  4. Přímo za metodu Main() přidejte následující asynchronní metodu MainAsync(), která volá metodu RegisterOnMessageHandlerAndReceiveMessages():Directly after Main(), add the following asynchronous MainAsync() method that calls the RegisterOnMessageHandlerAndReceiveMessages() method:

    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 the queue message handler and receive messages in a loop
        RegisterOnMessageHandlerAndReceiveMessages();
    
        Console.ReadKey();
    
        await queueClient.CloseAsync();
    }
    
  5. Přímo za metodu MainAsync() přidejte následující metodu, která registruje popisovač zprávy a přijímá zprávy odeslané aplikací odesílatele:Directly after the MainAsync() method, add the following method that 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);
    }
    
  6. Přímo za předchozí metodu přidejte následující metodu ProcessMessagesAsync() pro zpracování přijatých zpráv: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.
    }
    
  7. Nakonec přidejte následující metodu, která zpracovává případné výjimky, ke kterým může dojít: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;
    }    
    
  8. Soubor Program.cs by měl vypadat takhle: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;
            }
        }
    }
    
  9. Spusťte program a znovu se podívejte na portál.Run the program, and check the portal again. Všimněte si, že hodnoty Počet aktivních zpráv a Aktuální jsou teď 0.Notice that the Active Message Count and Current values are now 0.

    Délka fronty

Blahopřejeme!Congratulations! Vytvořili jste frontu, do této fronty jste odeslali sadu zpráv a ze stejné fronty jste tyto zprávy přijali.You have now created a queue, sent a set of messages to that queue, and received those messages from the same queue.

Poznámka

Můžete spravovat prostředky služby Service Bus s Service Bus Exploreru.You can manage Service Bus resources with Service Bus Explorer. Service Bus Exploreru umožňuje uživatelům připojit k oboru názvů služby Service Bus a správě entit pro zasílání zpráv snadno způsobem.The Service Bus Explorer allows users to connect to a Service Bus namespace and administer messaging entities in an easy manner. Tento nástroj nabízí pokročilé funkce, například funkce importu/exportu nebo možnost otestovat tématu, fronty, předplatná, služby pro přenos přes, notification hubs a centra událostí.The tool provides advanced features like import/export functionality or the ability to test topic, queues, subscriptions, relay services, notification hubs and events hubs.

Další postupNext steps

Podívejte se na naše úložiště GitHub s ukázkami, které předvádějí některé pokročilejší funkce zasílání zpráv služby Service Bus.Check out our GitHub repository with samples that demonstrate some of the more advanced features of Service Bus messaging.