Snabbstart: Azure Queue Storage klientbibliotek v12 för Python

Artikel
11/24/2021
8 minuter för att läsa

Kom igång med Azure Queue Storage-klientbiblioteket v12 för Python. Azure Queue Storage är en tjänst för att lagra ett stort antal meddelanden för senare hämtning och bearbetning. Följ de här stegen för att installera paketet och prova exempelkoden för grundläggande uppgifter.

Använd Azure Queue Storage-klientbiblioteket v12 för Python för att:

Skapa en kö
Lägga till meddelanden i en kö
Titta på meddelanden i en kö
Uppdatera ett meddelande i en kö
Ta emot meddelanden från en kö
Ta bort meddelanden från en kö
Ta bort en kö

Ytterligare resurser:

Förutsättningar

Azure-prenumeration – skapa en kostnadsfritt
Azure Storage konto – skapa ett lagringskonto
Python för ditt operativsystem – 2.7 eller 3.6+

Inrätta

Det här avsnittet går igenom hur du förbereder ett projekt för att arbeta med Azure Queue Storage-klientbiblioteket v12 för Python.

Skapa projektet

Skapa ett Python-program med namnet queues-quickstart-v12 .

I ett konsolfönster (till exempel cmd, PowerShell eller Bash) skapar du en ny katalog för projektet.
```
mkdir queues-quickstart-v12
```
Växla till den nyligen skapade queues-quickstart-v12 katalogen.
```
cd queues-quickstart-v12
```

Installera paketet

Installera Azure Blob Storage-klientbiblioteket för Python-paketet med hjälp av pip install kommandot .

pip install azure-storage-queue

Det här kommandot installerar Azure Queue Storage-klientbiblioteket för Python-paketet och alla bibliotek som det är beroende av. I det här fallet är det bara Azure-kärnbiblioteket för Python.

Konfigurera appramverket

Öppna en ny textfil i kodredigeraren
Lägga till import instruktioner

Skapa strukturen för programmet, inklusive mycket grundläggande undantagshantering

Här är koden:

import os, uuid
from azure.storage.queue import QueueServiceClient, QueueClient, QueueMessage

try:
    print("Azure Queue storage v12 - Python quickstart sample")
    # Quick start code goes here
except Exception as ex:
    print('Exception:')
    print(ex)

Spara den nya filen queues-quickstart-v12.py som i queues-quickstart-v12 katalogen .

Kopiera dina autentiseringsuppgifter från Azure-portalen

När exempelprogrammet gör en begäran till Azure Storage måste det auktoriserats. Om du vill auktorisera en begäran lägger du till autentiseringsuppgifterna för ditt lagringskonto i programmet som en anslutningssträng. Följ dessa steg om du vill visa autentiseringsuppgifterna för ditt lagringskonto:

Logga in på Azure-portalen.
Leta rätt på ditt lagringskonto.
I menyfönstret för lagringskontot går du till Säkerhet + nätverk och väljer Åtkomstnycklar. Här kan du visa kontoåtkomstnycklarna och den fullständiga anslutningssträngen för varje nyckel.
I fönstret Åtkomstnycklar väljer du Visa nycklar.
Leta upp värdet för Anslutningssträng i avsnittet key1. Välj ikonen Kopiera till Urklipp för att kopiera anslutningssträngen. Du lägger till anslutningssträngens värde i en miljövariabel i nästa avsnitt.

Konfigurera anslutningssträngen för lagring

När du har kopierat anslutningssträngen skriver du den till en ny miljövariabel på den lokala dator som kör programmet. Konfigurera miljövariabeln genom att öppna ett konsolfönster och följa anvisningarna för ditt operativsystem. Ersätt <yourconnectionstring> med den faktiska anslutningssträngen.

Windows

setx AZURE_STORAGE_CONNECTION_STRING "<yourconnectionstring>"

När du har lagt till miljövariabeln i Windows måste du starta en ny instans av kommandofönstret.

Linux

export AZURE_STORAGE_CONNECTION_STRING="<yourconnectionstring>"

macOS

export AZURE_STORAGE_CONNECTION_STRING="<yourconnectionstring>"

Starta om program

När du har lagt till miljövariabeln startar du om alla program som körs och behöver läsa miljövariabeln. Du kan till exempel starta om utvecklingsmiljön eller redigeringsredigeraren innan du fortsätter.

Objektmodell

Azure Queue Storage är en tjänst för lagring av ett stort antal meddelanden. Ett kömeddelande kan vara upp till 64 KB stort. En kö kan innehålla miljontals meddelanden, upp till den totala kapacitetsgränsen för ett lagringskonto. Köer används ofta för att skapa eftersläpande uppgifter för att bearbeta asynkront. Queue Storage erbjuder tre typer av resurser:

Lagringskontot
En kö i lagringskontot
Meddelanden i kön

Följande diagram visar relationen mellan de här resurserna.

Diagram över arkitekturen för Queue Storage

Använd följande Python-klasser för att interagera med dessa resurser:

QueueServiceClient: QueueServiceClient gör att du kan hantera alla köer i ditt lagringskonto.
QueueClient: Med QueueClient klassen kan du hantera och ändra en enskild kö och dess meddelanden.
QueueMessage: Klassen QueueMessage representerar de enskilda objekt som returneras vid anrop till en receive_messages kö.

Kodexempel

De här exempelkodfragmenten visar hur du gör följande med Azure Queue Storage klientbiblioteket för Python:

Hämta anslutningssträngen
Skapa en kö
Lägga till meddelanden i en kö
Titta på meddelanden i en kö
Uppdatera ett meddelande i en kö
Ta emot meddelanden från en kö
Ta bort meddelanden från en kö
Ta bort en kö

Hämta anslutningssträngen

Följande kod hämtar anslutningssträngen för lagringskontot. Anslutningssträngen lagras miljövariabeln som skapades i avsnittet Konfigurera lagringsanslutningssträngen.

Lägg till den här koden i try -blocket:

    # Retrieve the connection string for use with the application. The storage
    # connection string is stored in an environment variable on the machine
    # running the application called AZURE_STORAGE_CONNECTION_STRING. If the
    # environment variable is created after the application is launched in a
    # console or with Visual Studio, the shell or application needs to be
    # closed and reloaded to take the environment variable into account.
    connect_str = os.getenv('AZURE_STORAGE_CONNECTION_STRING')

Skapa en kö

Bestäm ett namn för den nya kön. Följande kod lägger till ett UUID-värde i könamnet för att säkerställa att det är unikt.

Viktigt

Könamn får bara innehålla gemener, siffror och bindestreck och måste börja med en bokstav eller en siffra. Varje bindestreck måste föregås och följas av ett tecken som inte är ett bindestreck. Namnet måste också vara mellan 3 och 63 tecken långt. Mer information finns i Namngivning av köer och metadata.

Skapa en instans av QueueClient klassen . Anropa sedan metoden create_queue för att skapa kön i ditt lagringskonto.

Lägg till den här koden i slutet av try blocket:

    # Create a unique name for the queue
    queue_name = "quickstartqueues-" + str(uuid.uuid4())

    print("Creating queue: " + queue_name)

    # Instantiate a QueueClient which will be
    # used to create and manipulate the queue
    queue_client = QueueClient.from_connection_string(connect_str, queue_name)

    # Create the queue
    queue_client.create_queue()

Lägga till meddelanden i en kö

Följande kodfragment lägger till meddelanden i kön genom att anropa send_message metoden . Den sparar också det som QueueMessage returneras från det tredje send_message anropet. saved_messageanvänds för att uppdatera meddelandeinnehållet senare i programmet.

Lägg till den här koden i slutet av try blocket:

    print("\nAdding messages to the queue...")

    # Send several messages to the queue
    queue_client.send_message(u"First message")
    queue_client.send_message(u"Second message")
    saved_message = queue_client.send_message(u"Third message")

Titta på meddelanden i en kö

Granska meddelandena i kön genom att anropa peek_messages metoden . Den här metoden hämtar ett eller flera meddelanden framför kön men ändrar inte meddelandets synlighet.

Lägg till den här koden i slutet av try blocket:

    print("\nPeek at the messages in the queue...")

    # Peek at messages in the queue
    peeked_messages = queue_client.peek_messages(max_messages=5)

    for peeked_message in peeked_messages:
        # Display the message
        print("Message: " + peeked_message.content)

Uppdatera ett meddelande i en kö

Uppdatera innehållet i ett meddelande genom att anropa update_message metoden . Den här metoden kan ändra tidsgränsen och innehållet för ett meddelandes synlighet. Meddelandeinnehållet måste vara en UTF-8-kodad sträng som är upp till 64 kB stor. Tillsammans med det nya innehållet skickar du in värden från meddelandet som sparades tidigare i koden. Värdena saved_message identifierar vilket meddelande som ska uppdateras.

    print("\nUpdating the third message in the queue...")

    # Update a message using the message saved when calling send_message earlier
    queue_client.update_message(saved_message, pop_receipt=saved_message.pop_receipt, \
        content="Third message has been updated")

Ta emot meddelanden från en kö

Ladda ned tidigare tillagda meddelanden genom att anropa receive_messages metoden .

Lägg till den här koden i slutet av try blocket:

    print("\nReceiving messages from the queue...")

    # Get messages from the queue
    messages = queue_client.receive_messages(messages_per_page=5)

Ta bort meddelanden från en kö

Ta bort meddelanden från kön när de har tagits emot och bearbetats. I det här fallet visar bearbetningen bara meddelandet på konsolen.

Appen pausar för användarindata genom att input anropa innan den bearbetar och tar bort meddelandena. Kontrollera i Azure Portal att resurserna har skapats korrekt innan de tas bort. Meddelanden som inte uttryckligen tas bort blir så småningom synliga i kön igen för en annan möjlighet att bearbeta dem.

Lägg till den här koden i slutet av try blocket:

    print("\nPress Enter key to 'process' messages and delete them from the queue...")
    input()

    for msg_batch in messages.by_page():
            for msg in msg_batch:
                # "Process" the message
                print(msg.content)
                # Let the service know we're finished with
                # the message and it can be safely deleted.
                queue_client.delete_message(msg)

Ta bort en kö

Följande kod rensar de resurser som appen skapade genom att ta bort kön med hjälp av delete_queue metoden .

Lägg till den här koden i slutet try av blocket och spara filen:

    print("\nPress Enter key to delete the queue...")
    input()

    # Clean up
    print("Deleting queue...")
    queue_client.delete_queue()

    print("Done")

Kör koden

Den här appen skapar och lägger till tre meddelanden i en Azure-kö. Koden listar meddelandena i kön och hämtar och tar sedan bort dem innan de slutligen tar bort kön.

I konsolfönstret navigerar du till katalogen som innehåller queues-quickstart-v12.py filen och använder sedan följande kommando för att köra python appen.

python queues-quickstart-v12.py

Appens utdata liknar följande exempel:

Azure Queue Storage client library v12 - Python quickstart sample
Creating queue: quickstartqueues-cac365be-7ce6-4065-bd65-3756ea052cb8

Adding messages to the queue...

Peek at the messages in the queue...
Message: First message
Message: Second message
Message: Third message

Updating the third message in the queue...

Receiving messages from the queue...

Press Enter key to 'process' messages and delete them from the queue...

First message
Second message
Third message has been updated

Press Enter key to delete the queue...

Deleting queue...
Done

När appen pausar innan du tar emot meddelanden kontrollerar du ditt lagringskonto i Azure Portal. Kontrollera att meddelandena finns i kön.

Tryck på Enter tangenten för att ta emot och ta bort meddelandena. När du uppmanas till det trycker Enter du på tangenten igen för att ta bort kön och avsluta demonstrationen.

Nästa steg

I den här snabbstarten har du lärt dig hur du skapar en kö och lägger till meddelanden i den med hjälp av Python-kod. Sedan lärde du dig att granska, hämta och ta bort meddelanden. Slutligen lärde du dig hur du tar bort en meddelandekö.

Självstudier, exempel, snabbstarter och annan dokumentation finns här:

Azure för Python-utvecklare

Mer information finns i Azure Storage för Python.
Fler Azure Queue Storage-exempelappar finns i Azure Queue Storage-klientbiblioteket v12 för Python – exempel.

Snabbstart: Azure Queue Storage klientbibliotek v12 för Python

Betygsätta din upplevelse

Förutsättningar

Inrätta

Skapa projektet

Installera paketet

Konfigurera appramverket

Kopiera dina autentiseringsuppgifter från Azure-portalen

Konfigurera anslutningssträngen för lagring

Windows

Linux

macOS

Starta om program

Objektmodell

Kodexempel

Hämta anslutningssträngen

Skapa en kö

Lägga till meddelanden i en kö

Titta på meddelanden i en kö

Uppdatera ett meddelande i en kö

Ta emot meddelanden från en kö

Ta bort meddelanden från en kö

Ta bort en kö

Kör koden

Nästa steg