Snabbstart: Azure Queue Storage klientbibliotek v12 för Java

Artikel
11/25/2021
9 minuter för att läsa

Kom igång med Azure Queue Storage klientbiblioteket v12 för Java. 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 Java för att:

Skapa en kö
Lägga till meddelanden i en kö
Granska meddelanden i en kö
Uppdatera ett meddelande i en kö
Ta emot och ta bort meddelanden från en kö
Ta bort en kö

Ytterligare resurser:

Förutsättningar

Java Development Kit (JDK) version 8 eller senare
Apache Maven
Azure-prenumeration – skapa en kostnadsfritt
Azure Storage konto – skapa ett lagringskonto

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 Java.

Skapa projektet

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

I ett konsolfönster (till exempel cmd, PowerShell eller Bash) använder du Maven för att skapa en ny konsolapp med namnet queues-quickstart-v12 . Skriv följande kommando mvn för att skapa ett "hello world"-Java-projekt.

PowerShell
Bash

mvn archetype:generate `
    --define interactiveMode=n `
    --define groupId=com.queues.quickstart `
    --define artifactId=queues-quickstart-v12 `
    --define archetypeArtifactId=maven-archetype-quickstart `
    --define archetypeVersion=1.4

mvn archetype:generate \
    --define interactiveMode=n \
    --define groupId=com.queues.quickstart \
    --define artifactId=queues-quickstart-v12 \
    --define archetypeArtifactId=maven-archetype-quickstart \
    --define archetypeVersion=1.4

Utdata från att generera projektet bör se ut ungefär så här:

[INFO] Scanning for projects...
[INFO]
[INFO] ------------------< org.apache.maven:standalone-pom >-------------------
[INFO] Building Maven Stub Project (No POM) 1
[INFO] --------------------------------[ pom ]---------------------------------
[INFO]
[INFO] >>> maven-archetype-plugin:3.1.2:generate (default-cli) > generate-sources @ standalone-pom >>>
[INFO]
[INFO] <<< maven-archetype-plugin:3.1.2:generate (default-cli) < generate-sources @ standalone-pom <<<
[INFO]
[INFO]
[INFO] --- maven-archetype-plugin:3.1.2:generate (default-cli) @ standalone-pom ---
[INFO] Generating project in Batch mode
[INFO] ----------------------------------------------------------------------------
[INFO] Using following parameters for creating project from Archetype: maven-archetype-quickstart:1.4
[INFO] ----------------------------------------------------------------------------
[INFO] Parameter: groupId, Value: com.queues.quickstart
[INFO] Parameter: artifactId, Value: queues-quickstart-v12
[INFO] Parameter: version, Value: 1.0-SNAPSHOT
[INFO] Parameter: package, Value: com.queues.quickstart
[INFO] Parameter: packageInPathFormat, Value: com/queues/quickstart
[INFO] Parameter: version, Value: 1.0-SNAPSHOT
[INFO] Parameter: package, Value: com.queues.quickstart
[INFO] Parameter: groupId, Value: com.queues.quickstart
[INFO] Parameter: artifactId, Value: queues-quickstart-v12
[INFO] Project created from Archetype in dir: C:\quickstarts\queues\queues-quickstart-v12
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time:  6.394 s
[INFO] Finished at: 2019-12-03T09:58:35-08:00
[INFO] ------------------------------------------------------------------------

Växla till den nyligen skapade queues-quickstart-v12 katalogen.
```
cd queues-quickstart-v12
```

Installera paketet

Öppna filen pom.xml i textredigeraren. Lägg till följande beroendeelement i gruppen med beroenden.

<dependency>
  <groupId>com.azure</groupId>
  <artifactId>azure-storage-queue</artifactId>
  <version>12.0.1</version>
</dependency>

Konfigurera appramverket

Från projektkatalogen:

Gå till katalogen /src/main/java/com/queues/quickstart
Öppna filen App.java i redigeringsredigeraren
Ta bort System.out.println("Hello, world"); instruktionen
Lägga till import direktiv

Här är koden:

package com.queues.quickstart;

/**
 * Azure Queue Storage client library v12 quickstart
 */
import com.azure.storage.queue.*;
import com.azure.storage.queue.models.*;
import java.io.*;
import java.time.*;

public class App
{
    public static void main( String[] args ) throws IOException
    {
    }
}

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 en eftersläpning för arbete som ska bearbetas 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 Java-klasser för att interagera med dessa resurser:

QueueClientBuilder: Klassen QueueClientBuilder konfigurerar och instansierar ett QueueClient -objekt.
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.
QueueMessageItem: Klassen QueueMessageItem representerar de enskilda objekt som returneras vid anrop till en ReceiveMessages kö.

Kodexempel

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

Hämta anslutningssträngen
Skapa en kö
Lägga till meddelanden i en kö
Granska meddelanden i en kö
Uppdatera ett meddelande i en kö
Ta emot och 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 anslutningssträngen för lagring.

Lägg till den här koden i main metoden :

System.out.println("Azure Queue Storage client library v12 - Java quickstart sample\n");

// 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.
String connectStr = System.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 GUID-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 om namngivning av köer finns i Namngivning av köer och metadata.

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

Lägg till den här koden i slutet av main metoden:

// Create a unique name for the queue
String queueName = "quickstartqueues-" + java.util.UUID.randomUUID();

System.out.println("Creating queue: " + queueName);

// Instantiate a QueueClient which will be
// used to create and manipulate the queue
QueueClient queueClient = new QueueClientBuilder()
                                .connectionString(connectStr)
                                .queueName(queueName)
                                .buildClient();

// Create the queue
queueClient.create();

Lägga till meddelanden i en kö

Följande kodfragment lägger till meddelanden i kö genom att anropa sendMessage metoden . Den sparar också ett som SendMessageResult returneras från ett sendMessage anrop. Resultatet används för att uppdatera meddelandet senare i programmet.

Lägg till den här koden i slutet av main metoden:

System.out.println("\nAdding messages to the queue...");

// Send several messages to the queue
queueClient.sendMessage("First message");
queueClient.sendMessage("Second message");

// Save the result so we can update this message later
SendMessageResult result = queueClient.sendMessage("Third message");

Granska meddelanden i en kö

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

Lägg till den här koden i slutet av main metoden:

System.out.println("\nPeek at the messages in the queue...");

// Peek at messages in the queue
queueClient.peekMessages(10, null, null).forEach(
    peekedMessage -> System.out.println("Message: " + peekedMessage.getMessageText()));

Uppdatera ett meddelande i en kö

Uppdatera innehållet i ett meddelande genom att anropa updateMessage 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 nytt innehåll för meddelandet skickar du meddelande-ID:t och popup-kvittot med hjälp av SendMessageResult som sparades tidigare i koden. Meddelande-ID:t och popup-kvittot identifierar vilket meddelande som ska uppdateras.

System.out.println("\nUpdating the third message in the queue...");

// Update a message using the result that
// was saved when sending the message
queueClient.updateMessage(result.getMessageId(),
                          result.getPopReceipt(),
                          "Third message has been updated",
                          Duration.ofSeconds(1));

Ta emot och ta bort meddelanden från en kö

Ladda ned tidigare tillagda meddelanden genom att anropa receiveMessages metoden . Exempelkoden tar även 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 anropa System.console().readLine(); innan den tar emot 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 main metoden:

System.out.println("\nPress Enter key to receive messages and delete them from the queue...");
System.console().readLine();

// Get messages from the queue
queueClient.receiveMessages(10).forEach(
    // "Process" the message
    receivedMessage -> {
        System.out.println("Message: " + receivedMessage.getMessageText());

        // Let the service know we're finished with
        // the message and it can be safely deleted.
        queueClient.deleteMessage(receivedMessage.getMessageId(), receivedMessage.getPopReceipt());
    }
);

Ta bort en kö

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

Lägg till den här koden i slutet av main metoden:

System.out.println("\nPress Enter key to delete the queue...");
System.console().readLine();

// Clean up
System.out.println("Deleting queue: " + queueClient.getQueueName());
queueClient.delete();

System.out.println("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 programkatalogen och skapar och kör sedan programmet.

mvn compile

Skapa sedan paketet.

mvn package

Använd följande mvn kommando för att köra appen.

mvn exec:java -Dexec.mainClass="com.queues.quickstart.App" -Dexec.cleanupDaemonThreads=false

Appens utdata liknar följande exempel:

Azure Queue Storage client library v12 - Java quickstart sample

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...

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

Message: First message
Message: Second message
Message: Third message has been updated

Press Enter key to delete the queue...

Deleting queue: quickstartqueues-fbf58f33-4d5a-41ac-ac0e-1a05d01c7003
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 Java-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 Java-molnutvecklare

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

Snabbstart: Azure Queue Storage klientbibliotek v12 för Java

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ö

Granska meddelanden i en kö

Uppdatera ett meddelande i en kö

Ta emot och ta bort meddelanden från en kö

Ta bort en kö

Kör koden

Nästa steg