Hızlı Başlangıç: Java için Azure Kuyruk Depolama istemci kitaplığı

Java için Azure Kuyruk Depolama istemci kitaplığını kullanmaya başlayın. Azure Kuyruk Depolama, daha sonra almak ve işlemek üzere çok sayıda iletiyi depolamaya yönelik bir hizmettir. Paketi yüklemek için bu adımları izleyin ve temel görevler için örnek kodu deneyin.

API başvuru belgeleri | Kitaplık kaynak kodu | Paketi (Maven)Örnekler |

Java için Azure Kuyruk Depolama istemci kitaplığını kullanarak:

• Kuyruk oluştur
• Kuyruğa ileti ekleme
• Kuyruktaki iletilere göz atma
• Kuyruktaki iletiyi güncelleştirme
• Kuyruk uzunluğu alma
• Kuyruktan ileti alma
• Kuyruktan iletileri silme
• Bir kuyruk silme

Ön koşullar

• Java Development Kit (JDK) sürüm 8 veya üzeri
• Apache Maven
• Azure aboneliği - ücretsiz bir abonelik oluşturun
• Azure Depolama hesabı - depolama hesabı oluşturma

Ayarlama

Bu bölümde, Java için Azure Kuyruk Depolama istemci kitaplığıyla çalışmak üzere bir proje hazırlama işleminde size yol gösterilir.

Proje oluşturma

queues-quickstart adlı bir Java uygulaması oluşturun.

1. Bir konsol penceresinde (cmd, PowerShell veya Bash gibi) Maven kullanarak queues-quickstart adlı yeni bir konsol uygulaması oluşturun. "Merhaba, dünya!" oluşturmak için aşağıdaki mvn komutu yazın Java projesi.

   • PowerShell
   • Bash

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

2. Projeyi oluşturma çıktısı aşağıdakine benzer olmalıdı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
   [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
   [INFO] Project created from Archetype in dir: C:\quickstarts\queues\queues-quickstart
   [INFO] ------------------------------------------------------------------------
   [INFO] BUILD SUCCESS
   [INFO] ------------------------------------------------------------------------
   [INFO] Total time:  6.394 s
   [INFO] Finished at: 2019-12-03T09:58:35-08:00
   [INFO] ------------------------------------------------------------------------
   

3. Yeni oluşturulan queues-quickstart dizinine geçin.

   cd queues-quickstart
   

Paketleri yükleme

pom.xml Dosyayı metin düzenleyicinizde açın.

Kitaplığın en son sürümüne bağımlılığı almak için azure-sdk-bom ekleyin. Aşağıdaki kod parçacığında yer tutucuyu {bom_version_to_target} sürüm numarasıyla değiştirin. azure-sdk-bom kullanmak, her bir bağımlılığın sürümünü belirtmenize gerek kalmamanızı sağlar. Ürün reçetesi hakkında daha fazla bilgi edinmek için bkz . Azure SDK ÜRÜN REÇETESI BENİOKU.

<dependencyManagement>
    <dependencies>
        <dependency>
            <groupId>com.azure</groupId>
            <artifactId>azure-sdk-bom</artifactId>
            <version>{bom_version_to_target}</version>
            <type>pom</type>
            <scope>import</scope>
        </dependency>
    </dependencies>
</dependencyManagement>

Ardından aşağıdaki bağımlılık öğelerini bağımlılık grubuna ekleyin. Azure hizmetlerine parolasız bağlantılar için azure-identity bağımlılığı gereklidir.

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

Uygulama çerçevesini ayarlama

Proje dizininden:

1. /src/main/java/com/queues/quickstart dizinine gidin
2. App.java dosyasını düzenleyicinizde açma
3. deyimini System.out.println("Hello, world"); silme
4. Yönerge ekleme import

Kod şu şekildedir:

package com.queues.quickstart;

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

public class App
{
    public static void main(String[] args) throws IOException
    {
        // Quickstart code goes here
    }
}

Azure'da kimlik doğrulaması

Çoğu Azure hizmeti için uygulama istekleri yetkilendirilmelidir. DefaultAzureCredential Azure Identity istemci kitaplığı tarafından sağlanan sınıfı kullanmak, kodunuzda Azure hizmetlerine parolasız bağlantılar uygulamak için önerilen yaklaşımdır.

Ayrıca parolaları, bağlantı dizesi veya diğer kimlik bilgilerini kullanarak Azure hizmetlerine yönelik istekleri doğrudan yetkilendirilebilirsiniz. Ancak bu yaklaşım dikkatli kullanılmalıdır. Geliştiriciler bu gizli dizileri güvenli olmayan bir konumda asla açığa çıkarmamak için dikkatli olmalıdır. Parolaya veya gizli anahtara erişim kazanan herkes kimlik doğrulaması yapabilir. DefaultAzureCredential parolasız kimlik doğrulamasına izin vermek için hesap anahtarı üzerinde gelişmiş yönetim ve güvenlik avantajları sunar. Her iki seçenek de aşağıdaki örnekte gösterilmiştir.

az storage account show --resource-group '<your-resource-group-name>' --name '<your-storage-account-name>' --query id

az role assignment create --assignee "<user@domain>" \
    --role "Storage Queue Data Contributor" \
    --scope "<your-resource-id>"

Get-AzResource -ResourceGroupName "<yourResourceGroupname>" -Name "<yourStorageAccountName>"

New-AzRoleAssignment -SignInName <user@domain> `
    -RoleDefinitionName "Storage Queue Data Contributor" `
    -Scope <yourStorageAccountId>

setx AZURE_STORAGE_CONNECTION_STRING "<yourconnectionstring>"

export AZURE_STORAGE_CONNECTION_STRING="<yourconnectionstring>"

Nesne modeli

Azure Kuyruk Depolama, çok sayıda iletiyi depolamaya yönelik bir hizmettir. Kuyruk iletisinin boyutu en fazla 64 KB olabilir. Kuyruk, depolama hesabının toplam kapasite sınırına kadar milyonlarca ileti içerebilir. Kuyruklar genellikle zaman uyumsuz olarak işlenmek üzere bir iş kapsamı oluşturmak için kullanılır. Kuyruk Depolama üç tür kaynak sunar:

• Depolama hesabı: Azure Depolama tüm erişimi bir depolama hesabı üzerinden yapılır. Depolama hesapları hakkında daha fazla bilgi için bkz. Depolama hesaba genel bakış
• Kuyruk: Kuyrukta bir dizi ileti vardır. Tüm iletiler bir kuyrukta olmalıdır. Kuyruk adının tamamen küçük harfli olması gerektiğini unutmayın. Kuyrukların adlandırılması hakkında daha fazla bilgi için bkz. Kuyrukları ve Meta Verileri Adlandırma.
• İleti: İleti, biçimi ne olursa olsun en çok 64 KB büyüklüktedir. İleti en fazla 7 gün kuyrukta kalabilir. Sürüm 2017-07-29 veya üzeri için maksimum yaşam süresi herhangi bir pozitif sayı veya iletinin süresinin dolmadığını belirten -1 olabilir. Bu parametre atlanırsa, varsayılan yaşam süresi yedi gündür.

Aşağıdaki diyagramda bu kaynaklar arasındaki ilişki gösterilmektedir.

Bu kaynaklarla etkileşime geçmek için aşağıdaki Java sınıflarını kullanın:

• QueueClientBuilderQueueClientBuilder: sınıfı bir QueueClient nesneyi yapılandırıp örneği oluşturur.
• QueueServiceClient: depolama QueueServiceClient hesabınızdaki tüm kuyrukları yönetmenize olanak tanır.
• QueueClient: sınıfı, QueueClient tek bir kuyruğu ve iletilerini yönetmenize ve işlemenize olanak tanır.
• QueueMessageItem: sınıfı, QueueMessageItem bir kuyrukta çağrılırken ReceiveMessages döndürülen tek tek nesneleri temsil eder.

Kod örnekleri

Bu örnek kod parçacıkları, Java için Azure Kuyruk Depolama istemci kitaplığıyla aşağıdaki eylemlerin nasıl yapılacağını gösterir:

• Erişimi yetkilendirme ve istemci nesnesi oluşturma
• Kuyruk oluşturma
• Kuyruğa ileti ekleme
• Kuyruktaki iletilere göz atma
• Kuyruktaki iletiyi güncelleştirme
• Kuyruk uzunluğunu alma
• Kuyruktan ileti alma ve silme
• Kuyruk silme

az login

az login

Connect-AzAccount

import com.azure.identity.*;

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

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

// Instantiate a QueueClient
// We'll use this client object to create and interact with the queue
// TODO: replace <storage-account-name> with the actual name
QueueClient queueClient = new QueueClientBuilder()
        .endpoint("https://<storage-account-name>.queue.core.windows.net/")
        .queueName(queueName)
        .credential(new DefaultAzureCredentialBuilder().build())
        .buildClient();

System.out.println("Azure Queue Storage client library - 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");

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

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

// Instantiate a QueueClient
// We'll use this client object to create and interact with the queue
QueueClient queueClient = new QueueClientBuilder()
        .connectionString(connectStr)
        .queueName(queueName)
        .buildClient();

Kuyruk oluştur

QueueClient nesnesini kullanarak, depolama hesabınızda kuyruk oluşturmak için yöntemini çağırıncreate.

Bu kodu yönteminin main sonuna ekleyin:

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

// Create the queue
queueClient.create();

Kuyruğa ileti ekleme

Aşağıdaki kod parçacığı yöntemini çağırarak sendMessage kuyruğa iletiler ekler. Ayrıca, bir çağrıdan döndürülen bir sendMessage kaydederSendMessageResult. Sonuç, programın ilerleyen bölümlerinde iletiyi güncelleştirmek için kullanılır.

Bu kodu yönteminin main sonuna ekleyin:

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");

Kuyruktaki iletilere göz atma

yöntemini çağırarak kuyruktaki iletilere peekMessages göz atın. Bu yöntem kuyruğun önünden bir veya daha fazla ileti alır, ancak iletinin görünürlüğünü değiştirmez.

Bu kodu yönteminin main sonuna ekleyin:

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()));

Kuyruktaki iletiyi güncelleştirme

yöntemini çağırarak iletinin içeriğini güncelleştirin updateMessage . Bu yöntem, iletinin görünürlük zaman aşımını ve içeriğini değiştirebilir. İleti içeriğinin boyutu 64 KB'a kadar olan UTF-8 kodlanmış bir dize olmalıdır. İletinin yeni içeriğinin yanı sıra, kodda daha önce kaydedilmiş olan öğesini kullanarak SendMessageResult ileti kimliğini ve pop alındı bilgisini geçirin. İleti kimliği ve pop alındı bilgisi, hangi iletinin güncelleştirilecek olduğunu belirler.

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));

Kuyruk uzunluğu alma

Bir kuyruktaki ileti sayısı ile ilgili bir tahmin alabilirsiniz.

yöntemi, getProperties şu anda kuyrukta olan iletilerin sayısı da dahil olmak üzere çeşitli değerler döndürür. İletiler isteğinizden sonra eklenebileceği veya kaldırılabildiği için sayı yaklaşıktır. yöntemi, getApproximateMessageCount Queue Depolama çağrılmadan getPropertiesçağrısı tarafından alınan son değeri döndürür.

QueueProperties properties = queueClient.getProperties();
long messageCount = properties.getApproximateMessagesCount();

System.out.println(String.format("Queue length: %d", messageCount));

Kuyruktan ileti alma ve silme

yöntemini çağırarak receiveMessages daha önce eklenen iletileri indirin. Örnek kod ayrıca iletileri alındıktan ve işlendikten sonra kuyruktan siler. Bu durumda, işlem yalnızca konsolda iletiyi görüntüler.

Uygulama, iletileri alıp silmeden önce çağırarak System.console().readLine(); kullanıcı girişi için duraklatılır. Azure portalınızda kaynakların silinmeden önce doğru oluşturulduğunu doğrulayın. Açıkça silinmeyen tüm iletiler sonunda bunları işlemek için başka bir şans için kuyrukta yeniden görünür hale gelir.

Bu kodu yönteminin main sonuna ekleyin:

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());
    }
);

yöntemini çağırırken receiveMessages isteğe bağlı olarak, kuyruktan alınacak ileti sayısı olan için maxMessagesbir değer belirtebilirsiniz. Varsayılan değer 1 iletidir ve en fazla 32 iletidir. Ayrıca, zaman aşımı dönemi için visibilityTimeoutdiğer işlemlerden gelen iletileri gizleyen bir değeri de belirtebilirsiniz. Varsayılan değer 30 saniyedir.

Bir kuyruk silme

Aşağıdaki kod, yöntemini kullanarak Delete kuyruğu silerek uygulamanın oluşturduğu kaynakları temizler.

Bu kodu yönteminin main sonuna ekleyin:

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");

Kodu çalıştırma

Bu uygulama bir Azure kuyruğuna üç ileti oluşturur ve ekler. Kod, kuyruktaki iletileri listeler, ardından kuyruğu silmeden önce alır ve siler.

Konsol pencerenizde uygulama dizininize gidin, ardından uygulamayı derleyip çalıştırın.

mvn compile

Ardından paketi derleyin.

mvn package

Uygulamayı çalıştırmak için aşağıdaki mvn komutu kullanın.

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

Uygulamanın çıkışı aşağıdaki örneğe benzer:

Azure Queue Storage client library - 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

Uygulama iletileri almadan önce duraklatıldığında Azure portalında depolama hesabınızı denetleyin. İletilerin kuyrukta olduğunu doğrulayın.

İletileri Enter almak ve silmek için tuşuna basın. İstendiğinde Enter , kuyruğu silmek ve tanıtımı tamamlamak için tuşuna yeniden basın.

Sonraki adımlar

Bu hızlı başlangıçta, Java kodunu kullanarak kuyruk oluşturmayı ve buna ileti eklemeyi öğrendiniz. Ardından iletileri göz atıp almayı ve silmeyi öğrendiniz. Son olarak, ileti kuyruğu silmeyi öğrendinsiniz.

Öğreticiler, örnekler, hızlı başlangıçlar ve diğer belgeler için şu adresi ziyaret edin:

• Kullanım dışı bırakılan Java sürüm 8 SDK'larını kullanan ilgili kod örnekleri için bkz . Java sürüm 8'i kullanan kod örnekleri.
• Diğer Azure Kuyruk Depolama örnek uygulamaları için bkz. Java için Azure Kuyruk Depolama istemci kitaplığı - örnekler.