Kurz: Práce s frontami Azure Queue Storage v .NET

Článek
08/08/2024

Azure Queue Storage implementuje cloudové fronty, které umožňují komunikaci mezi komponentami distribuované aplikace. Každá fronta udržuje seznam zpráv, které mohou být přidány komponentou odesílatele a zpracovány komponentou příjemce. Díky frontě se vaše aplikace může škálovat okamžitě, aby splňovala poptávku. Tento článek popisuje základní kroky pro práci s frontou Azure Queue Storage.

V tomto kurzu se naučíte:

Vytvoření účtu služby Azure Storage
Vytvoření aplikace
Přidání klientských knihoven Azure
Přidání podpory asynchronního kódu
Vytvořit frontu
Vložení zpráv do fronty
Vyřazení zpráv z fronty
Odstranění prázdné fronty
Kontrola argumentů příkazového řádku
Sestavte a spusťte aplikaci.

Požadavky

Získejte bezplatnou kopii editoru Visual Studio Code pro různé platformy.
Stáhněte a nainstalujte sadu .NET Core SDK verze 3.1 nebo novější.
Pokud nemáte aktuální předplatné Azure, vytvořte si před tím, než začnete, bezplatný účet .

Vytvoření účtu služby Azure Storage

Nejprve vytvořte účet Azure Storage.

Podrobný průvodce vytvořením účtu úložiště najdete v tématu Vytvoření účtu úložiště. Jedná se o samostatný krok, který provedete po vytvoření bezplatného účtu Azure v požadavcích.
Ujistěte se, že má váš uživatelský účet přiřazenou roli Přispěvatel dat fronty úložiště, vymezený na účet úložiště, nadřazenou skupinu prostředků nebo předplatné. Viz Ověření v Azure.

Vytvoření aplikace

Vytvořte aplikaci .NET Core s názvem QueueApp. Pro zjednodušení bude tato aplikace odesílat i přijímat zprávy prostřednictvím fronty.

V okně konzoly (například cmd, PowerShell nebo Azure CLI) pomocí dotnet new příkazu vytvořte novou konzolovou aplikaci s názvem QueueApp. Tento příkaz vytvoří jednoduchý projekt "hello world" C# s jedním zdrojovým souborem s názvem Program.cs.
```
dotnet new console -n QueueApp
```

Přepněte do nově vytvořené složky QueueApp a sestavte aplikaci, abyste ověřili, že je vše v pořádku.

cd QueueApp

dotnet build

Měly by se zobrazit výsledky podobné následujícímu výstupu:

C:\Tutorials>dotnet new console -n QueueApp
The template "Console Application" was created successfully.

Processing post-creation actions...
Running 'dotnet restore' on QueueApp\QueueApp.csproj...
  Restore completed in 155.63 ms for C:\Tutorials\QueueApp\QueueApp.csproj.

Restore succeeded.

C:\Tutorials>cd QueueApp

C:\Tutorials\QueueApp>dotnet build
Microsoft (R) Build Engine version 16.0.450+ga8dc7f1d34 for .NET Core
Copyright (C) Microsoft Corporation. All rights reserved.

  Restore completed in 40.87 ms for C:\Tutorials\QueueApp\QueueApp.csproj.
  QueueApp -> C:\Tutorials\QueueApp\bin\Debug\netcoreapp3.1\QueueApp.dll

Build succeeded.
    0 Warning(s)
    0 Error(s)

Time Elapsed 00:00:02.40

C:\Tutorials\QueueApp>_

Přidání klientských knihoven Azure

Přidejte do projektu klientské knihovny Azure Storage pomocí dotnet add package příkazu.

V okně konzoly spusťte následující příkaz ze složky projektu.
```
dotnet add package Azure.Storage.Queues
```

Přidání příkazů using

Z příkazového řádku v adresáři projektu zadejte code . visual Studio Code v aktuálním adresáři. Nechte okno příkazového řádku otevřené. Později bude k dispozici více příkazů. Pokud se zobrazí výzva k přidání prostředků C# potřebných k sestavení a ladění, klikněte na tlačítko Ano .
Program.cs Otevřete zdrojový soubor a přidejte následující obory názvů hned za using System; příkaz. Tato aplikace používá typy z těchto oborů názvů pro připojení ke službě Azure Storage a práci s frontami.
```
using System.Threading.Tasks;
using Azure.Storage.Queues;
using Azure.Storage.Queues.Models;
```
Uložte soubor Program.cs.

Přidání podpory asynchronního kódu

Vzhledem k tomu, že aplikace používá cloudové prostředky, kód běží asynchronně.

Aktualizujte metodu Main tak, aby běžela asynchronně. Nahraďte void vrácenou async Task hodnotou.
```
static async Task Main(string[] args)
```
Uložte soubor Program.cs.

Vytvořit frontu

Před voláním do rozhraní API Azure musíte zajistit, abyste byli ověřeni pomocí stejného účtu Microsoft Entra, ke kterému jste přiřadili roli. Po ověření můžete vytvořit a autorizovat QueueClient objekt pomocí DefaultAzureCredential přístupu k datům fronty v účtu úložiště. DefaultAzureCredential automaticky zjistí a použije účet, ke který jste se přihlásili. Informace o tom, jak se přihlásit a pak vytvořit QueueClient objekt, najdete v tématu Autorizace přístupu a vytvoření objektu klienta.

Vložení zpráv do fronty

Vytvořte novou metodu pro odeslání zprávy do fronty.

Do třídy přidejte následující InsertMessageAsync metodu Program .

Tato metoda se předává odkaz na frontu. Vytvoří se nová fronta, pokud ještě neexistuje, zavoláním CreateIfNotExistsAsync. Potom přidá do fronty newMessage voláním SendMessageAsync.
```
static async Task InsertMessageAsync(QueueClient theQueue, string newMessage)
{
    if (null != await theQueue.CreateIfNotExistsAsync())
    {
        Console.WriteLine("The queue was created.");
    }

    await theQueue.SendMessageAsync(newMessage);
}
```
Volitelné: Ve výchozím nastavení je maximální doba přenosu zprávy nastavená na sedm dní. Pro zprávu time-to-live můžete zadat libovolné kladné číslo. Následující fragment kódu přidá zprávu, která nikdy nevyprší .

Pokud chcete přidat zprávu, která nevyprší platnost, použijte Timespan.FromSeconds(-1) ve svém hovoru SendMessageAsync.
```
await theQueue.SendMessageAsync(newMessage, default, TimeSpan.FromSeconds(-1), default);
```
Uložte soubor.

Zpráva fronty musí být ve formátu kompatibilním s požadavkem XML s kódováním UTF-8. Zpráva může mít velikost až 64 kB. Pokud zpráva obsahuje binární data, zakódujte zprávu kódováním Base64.

Vyřazení zpráv z fronty

Vytvořte novou metodu pro načtení zprávy z fronty. Po úspěšném přijetí zprávy je důležité ji odstranit z fronty, aby se nezpracovala vícekrát.

Přidejte do třídy Program novou metodu volanouRetrieveNextMessageAsync.

Tato metoda obdrží zprávu z fronty voláním ReceiveMessagesAsync, předáním 1 prvního parametru načíst pouze další zprávu ve frontě. Po přijetí zprávy ji odstraňte z fronty voláním DeleteMessageAsync.

Při odeslání zprávy do fronty s verzí sady SDK před v12 se automaticky zakóduje Base64. Od verze 12 se tato funkce odebrala. Při načtení zprávy pomocí sady SDK v12 se automaticky dekóduje Base64. Obsah musíte explicitně dekódovat sami.

static async Task<string> RetrieveNextMessageAsync(QueueClient theQueue)
{
    if (await theQueue.ExistsAsync())
    {
        QueueProperties properties = await theQueue.GetPropertiesAsync();

        if (properties.ApproximateMessagesCount > 0)
        {
            QueueMessage[] retrievedMessage = await theQueue.ReceiveMessagesAsync(1);
            string theMessage = retrievedMessage[0].Body.ToString();
            await theQueue.DeleteMessageAsync(retrievedMessage[0].MessageId, retrievedMessage[0].PopReceipt);
            return theMessage;
        }

        return null;
    }

    return null;
}

Uložte soubor.

Odstranění prázdné fronty

Osvědčeným postupem na konci projektu je zjistit, jestli stále potřebujete prostředky, které jste vytvořili. Prostředky, které necháte spuštěné, vás stojí peníze. Pokud fronta existuje, ale je prázdná, požádejte uživatele, jestli ji chce odstranit.

Rozbalte metodu RetrieveNextMessageAsync tak, aby obsahovala výzvu k odstranění prázdné fronty.

static async Task<string> RetrieveNextMessageAsync(QueueClient theQueue)
{
    if (await theQueue.ExistsAsync())
    {
        QueueProperties properties = await theQueue.GetPropertiesAsync();

        if (properties.ApproximateMessagesCount > 0)
        {
            QueueMessage[] retrievedMessage = await theQueue.ReceiveMessagesAsync(1);
            string theMessage = retrievedMessage[0].Body.ToString();
            await theQueue.DeleteMessageAsync(retrievedMessage[0].MessageId, retrievedMessage[0].PopReceipt);
            return theMessage;
        }
        else
        {
            Console.Write("The queue is empty. Attempt to delete it? (Y/N) ");
            string response = Console.ReadLine();

            if (response.ToUpper() == "Y")
            {
                await theQueue.DeleteIfExistsAsync();
                return "The queue was deleted.";
            }
            else
            {
                return "The queue was not deleted.";
            }
        }
    }
    else
    {
        return "The queue does not exist. Add a message to the command line to create the queue and store the message.";
    }
}

Uložte soubor.

Kontrola argumentů příkazového řádku

Pokud jsou do aplikace předány nějaké argumenty příkazového řádku, předpokládejme, že se jedná o zprávu, která se má přidat do fronty. Spojte argumenty dohromady a vytvořte řetězec. Přidejte tento řetězec do fronty zpráv voláním InsertMessageAsync metody, kterou jsme přidali dříve.

Pokud neexistují žádné argumenty příkazového řádku, zkuste operaci načtení. RetrieveNextMessageAsync Voláním metody načtěte další zprávu ve frontě.

Nakonec počkejte na vstup uživatele před ukončením voláním Console.ReadLine.

Rozbalte metodu Main , abyste zkontrolovali argumenty příkazového řádku a čekali na vstup uživatele. V následujícím fragmentu kódu nezapomeňte zástupný symbol nahradit {storageAccountName} názvem vašeho účtu úložiště.

static async Task Main(string[] args)
{
   QueueClient queue = new QueueClient(
      new Uri($"https://{storageAccountName}.queue.core.windows.net/mystoragequeue"),
      new DefaultAzureCredential());

   if (args.Length > 0)
   {
      string value = String.Join(" ", args);
      await InsertMessageAsync(queue, value);
      Console.WriteLine($"Sent: {value}");
   }
   else
   {
      string value = await RetrieveNextMessageAsync(queue);
      Console.WriteLine($"Received: {value}");
   }

   Console.Write("Press Enter...");
   Console.ReadLine();
}

Uložte soubor.

Celý kód

Tady je úplný výpis kódu pro tento projekt.

using System;
using System.Threading.Tasks;
using Azure.Storage.Queues;
using Azure.Storage.Queues.Models;
using Azure.Identity;

namespace QueueApp
{
    class Program
    {
        static async Task Main(string[] args)
        {
            QueueClient queue = new QueueClient(
               new Uri($"https://{storageAccountName}.queue.core.windows.net/mystoragequeue"),
               new DefaultAzureCredential());

            if (args.Length > 0)
            {
                string value = String.Join(" ", args);
                await InsertMessageAsync(queue, value);
                Console.WriteLine($"Sent: {value}");
            }
            else
            {
                string value = await RetrieveNextMessageAsync(queue);
                Console.WriteLine($"Received: {value}");
            }

            Console.Write("Press Enter...");
            Console.ReadLine();
        }

        static async Task InsertMessageAsync(QueueClient theQueue, string newMessage)
        {
            if (null != await theQueue.CreateIfNotExistsAsync())
            {
                Console.WriteLine("The queue was created.");
            }

            await theQueue.SendMessageAsync(newMessage);
        }

        static async Task<string> RetrieveNextMessageAsync(QueueClient theQueue)
        {
            if (await theQueue.ExistsAsync())
            {
                QueueProperties properties = await theQueue.GetPropertiesAsync();

                if (properties.ApproximateMessagesCount > 0)
                {
                    QueueMessage[] retrievedMessage = await theQueue.ReceiveMessagesAsync(1);
                    string theMessage = retrievedMessage[0].Body.ToString();
                    await theQueue.DeleteMessageAsync(retrievedMessage[0].MessageId, retrievedMessage[0].PopReceipt);
                    return theMessage;
                }
                else
                {
                    Console.Write("The queue is empty. Attempt to delete it? (Y/N) ");
                    string response = Console.ReadLine();

                    if (response.ToUpper() == "Y")
                    {
                        await theQueue.DeleteIfExistsAsync();
                        return "The queue was deleted.";
                    }
                    else
                    {
                        return "The queue was not deleted.";
                    }
                }
            }
            else
            {
                return "The queue does not exist. Add a message to the command line to create the queue and store the message.";
            }
        }
    }
}

Sestavte a spusťte aplikaci.

Z příkazového řádku v adresáři projektu spusťte následující příkaz dotnet, který projekt sestaví.
```
dotnet build
```

Po úspěšném sestavení projektu spusťte následující příkaz, který přidá první zprávu do fronty.

dotnet run First queue message

Měli byste vidět tento výstup:

C:\Tutorials\QueueApp>dotnet run First queue message
The queue was created.
Sent: First queue message
Press Enter..._

Spusťte aplikaci bez argumentů příkazového řádku pro příjem a odebrání první zprávy ve frontě.
```
dotnet run
```

Pokračujte ve spouštění aplikace, dokud se neodeberou všechny zprávy. Pokud ji spustíte ještě jednou, zobrazí se zpráva, že fronta je prázdná, a zobrazí se výzva k odstranění fronty.

C:\Tutorials\QueueApp>dotnet run First queue message
The queue was created.
Sent: First queue message
Press Enter...

C:\Tutorials\QueueApp>dotnet run Second queue message
Sent: Second queue message
Press Enter...

C:\Tutorials\QueueApp>dotnet run Third queue message
Sent: Third queue message
Press Enter...

C:\Tutorials\QueueApp>dotnet run
Received: First queue message
Press Enter...

C:\Tutorials\QueueApp>dotnet run
Received: Second queue message
Press Enter...

C:\Tutorials\QueueApp>dotnet run
Received: Third queue message
Press Enter...

C:\Tutorials\QueueApp>dotnet run
The queue is empty. Attempt to delete it? (Y/N) Y
Received: The queue was deleted.
Press Enter...

C:\Tutorials\QueueApp>_

Další kroky

V tomto kurzu jste se naučili, jak:

Vytvořit frontu
Přidání a odebrání zpráv z fronty
Odstranění fronty Azure Queue Storage

Další informace najdete v rychlých startech služby Azure Queue Storage.

Rychlý start front pro portál

Související ukázky kódu s využitím zastaralých sad .NET verze 11.x najdete v ukázkách kódu pomocí .NET verze 11.x.

Sdílet prostřednictvím