Compartilhar via

Início Rápido: biblioteca de clientes do Armazenamento de Filas do Azure para Java

  • Artigo

Introdução à biblioteca de clientes do Armazenamento de Filas do Azure para Java. O Armazenamento de Filas do Azure é um serviço usado para armazenar grandes quantidades de mensagens para recuperação e processamento posteriores. Siga estas etapas para instalar o pacote e experimentar o código de exemplo para tarefas básicas.

Documentação de referência da API | Código-fonte da biblioteca | Pacote (Maven) | Exemplos

Use a biblioteca de clientes do Armazenamento de Filas do Azure para Java para:

  • Criar uma fila
  • Adicionar mensagens a uma fila
  • Espiar mensagens em uma fila
  • Atualizar uma mensagem em uma fila
  • Obter o tamanho da fila
  • Receber mensagens de uma fila
  • Excluir mensagens de uma fila
  • Excluir uma fila

Pré-requisitos

Configurando

Esta seção fornece instruções sobre como preparar um projeto para funcionar com a biblioteca de clientes do Armazenamento de Filas do Azure para Java.

Criar o projeto

Crie um aplicativo Java chamado queues-quickstart.

  1. Em uma janela do console (como cmd, PowerShell ou Bash), use o Maven para criar um aplicativo do console com o nome queues-quickstart. Digite o comando mvn a seguir para criar um projeto "Olá, Mundo!" em Java.

    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. O resultado da geração do projeto deve ser algo similar a:

    [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. Alterne para o diretório queues-quickstart criado recentemente.

    cd queues-quickstart

Instalar os pacotes

Abra o arquivo pom.xml no seu editor de texto.

Adicione azure-sdk-bom para usar uma dependência da última versão da biblioteca. No snippet a seguir, substitua o espaço reservado {bom_version_to_target} pelo número de versão. O uso do azure-sdk-bom elimina a necessidade de especificação da versão de cada dependência individual. Para saber mais sobre o BOM, confira o LEIAME do BOM do SDK do Azure.

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

Em seguida, adicione os elementos de dependência a seguir ao grupo de dependências. A dependência azure-identity é necessária para conexões sem senha com os serviços do Azure.

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

Configurar o framework de aplicativos

No diretório do projeto:

  1. Navegue até o diretório /src/main/java/com/queues/quickstart
  2. Abra o arquivo App.java em seu editor
  3. Exclua a instrução System.out.println("Hello, world");
  4. Adicione diretivas import

O código é o seguinte:

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

Autenticar no Azure

As solicitações do aplicativo para a maioria dos serviços do Azure precisam ser autorizadas. O uso da classe DefaultAzureCredential fornecida pela biblioteca de clientes de Identidade do Azure é a abordagem recomendada para implementar conexões sem senha com os serviços do Azure no seu código.

Você também pode autorizar solicitações para serviços do Azure usando senhas, cadeias de conexão ou outras credenciais diretamente. No entanto, essa abordagem deve ser usada com cautela. Os desenvolvedores devem ser diligentes para nunca expor esses segredos em um local não seguro. Qualquer pessoa que tenha acesso à senha ou à chave secreta poderá se autenticar. DefaultAzureCredential oferece benefícios aprimorados de gerenciamento e segurança sobre a chave de conta para permitir a autenticação sem senha. Ambas as opções são demonstradas no exemplo a seguir.

DefaultAzureCredential é uma classe fornecida pela biblioteca de clientes da Identidade do Azure para Java. Para saber mais sobre DefaultAzureCredential, confira a Visão geral do DefaultAzureCredential. DefaultAzureCredential dá suporte a vários métodos de autenticação e determina quais métodos devem ser usados no runtime. Essa abordagem permite que seu aplicativo use diferentes métodos de autenticação em ambientes diferentes (local versus produção) sem implementar código específico do ambiente.

Por exemplo, seu aplicativo pode autenticar usando suas credenciais de entrada da CLI do Azure ao desenvolver localmente e, em seguida, usar uma identidade gerenciada depois de ser implantado no Azure. Nenhuma alteração de código é necessária para essa transição.

Ao desenvolver localmente, verifique se a conta de usuário que está acessando os dados da fila tem as permissões corretas. Você precisará do Colaborador de dados da fila de armazenamento para ler e gravar os dados da fila. Para atribuir essa função a si mesmo, você precisará receber a atribuição da função Administrador de Acesso do Usuário ou de outra função que inclua a ação Microsoft.Authorization/roleAssignments/write. É possível atribuir funções RBAC do Azure a um usuário usando o portal do Azure, a CLI do Azure ou o Azure PowerShell. Você pode saber mais sobre os escopos disponíveis para atribuições de função na página de visão geral do escopo.

Nesse cenário, você atribuirá permissões à sua conta de usuário, no escopo da conta de armazenamento, para seguir o Princípio do Privilégio Mínimo. Essa prática fornece aos usuários apenas as permissões mínimas necessárias e cria ambientes de produção mais seguros.

O exemplo a seguir atribuirá a função de Colaborador de dados da fila de armazenamento à sua conta de usuário, que fornece acesso de leitura e gravação aos dados da fila na sua conta de armazenamento.

Importante

Na maioria dos casos, levará um ou dois minutos para a atribuição de função se propagar no Azure, mas em casos raros pode levar até oito minutos. Se você receber erros de autenticação ao executar o código pela primeira vez, aguarde alguns instantes e tente novamente.

  1. No portal do Azure, localize sua conta de armazenamento usando a barra de pesquisa principal ou a navegação à esquerda.

  2. Na página de visão geral da conta de armazenamento, selecione Controle de acesso (IAM) no menu à esquerda.

  3. Na página Controle de acesso (IAM), selecione a guia Atribuições de função.

  4. Selecione + Adicionar no menu superior e, em seguida, Adicionar atribuição de função no menu suspenso resultante.

A screenshot showing how to assign a role.

  1. Use a caixa de pesquisa para filtrar os resultados para a função desejada. Para este exemplo, pesquise o Colaborador de dados da fila de armazenamento, e selecione o resultado correspondente e, em seguida, escolha Avançar.

  2. Em Atribuir acesso a, selecione Usuário, grupo ou entidade de serviço e, em seguida, selecione + Selecionar membros.

  3. No diálogo, pesquise seu nome de usuário do Microsoft Entra (geralmente, seu endereço de email usuário@domínio) e escolha Selecionar na parte inferior do diálogo.

  4. Selecione Revisar + atribuir para ir para a página final e, em seguida, Revisar + atribuir novamente para concluir o processo.

Modelo de objeto

O armazenamento de Filas do Azure é um serviço usado para armazenar grandes quantidades de mensagens. Uma mensagem da fila pode ter até 64 KB. Uma fila pode conter milhões de mensagens, até o limite da capacidade total de uma conta de armazenamento. As filas são normalmente usadas para criar uma lista de pendências de trabalho para processamento assíncrono. O Armazenamento de Filas oferece três tipos de recursos:

  • Conta de armazenamento: todo o acesso ao Armazenamento do Azure é feito por meio de uma conta de armazenamento. Para saber mais sobre as contas de armazenamento, consulte Visão geral da conta de armazenamento
  • Fila: uma fila contém um conjunto de mensagens. Todas as mensagens devem estar em uma fila. Observe que o nome da fila deve estar em letras minúsculas. Para saber mais sobre filas de nomenclatura, confira Nomenclatura de filas e metadados.
  • Mensagem: uma mensagem, em qualquer formato, de até 64 KB. Uma mensagem pode ficar na fila por no máximo 7 dias. Para a versão 2017-07-29 ou posterior, a vida útil máxima pode ser qualquer número positivo ou -1, indicando que a mensagem não expira. Se esse parâmetro for omitido, a vida útil padrão será de sete dias.

O diagrama a seguir mostra a relação entre esses recursos.

Diagram of Queue storage architecture

Use as seguintes classes Java para interagir com esses recursos:

  • QueueClientBuilder: A classe QueueClientBuilder configura e instancia um objeto QueueClient.
  • QueueServiceClient: O QueueServiceClient permite que você gerencie todas as filas em sua conta de armazenamento.
  • QueueClient: A classe QueueClient permite que você gerencie e manipule uma fila individual e as mensagens dela.
  • QueueMessageItem: A classe QueueMessageItem representa os objetos individuais retornados ao chamar ReceiveMessages em uma fila.

Exemplos de código

Esses snippets de código de exemplo mostram como executar seguintes ações com a biblioteca de clientes do Armazenamento de Filas do Azure para Java:

Autorizar acesso e criar um objeto de cliente

Verifique se você está autenticado com a mesma conta do Microsoft Entra à qual atribuiu a função. Você pode se autenticar por meio da CLI do Azure, do Visual Studio Code ou do Azure PowerShell.

Entre no Azure por meio da CLI do Azure usando o seguinte comando:

az login

Depois de autenticado, você pode criar e autorizar um objeto QueueClient usando DefaultAzureCredential para acessar dados da fila na conta de armazenamento. DefaultAzureCredential descobrirá e usará automaticamente a conta com a qual você entrou na etapa anterior.

Para autorizar o uso de DefaultAzureCredential, verifique se você adicionou a dependência azure-identity em pom.xml, conforme descrito em Instalar os pacotes. Além disso, adicione uma diretiva de importação para com.azure.identity no arquivo App.java:

import com.azure.identity.*;

Decida um nome para a fila e crie uma instância da classe QueueClient usando DefaultAzureCredential para autorização. Usaremos esse objeto cliente para criar e interagir com o recurso de fila de espera na conta de armazenamento.

Importante

Os nomes de fila podem conter apenas letras minúsculas, números e hifens e precisam começar com uma letra ou um número. Cada hífen deve ser precedido e seguido por um caractere que não seja um hífen. O nome também precisa ter entre 3 e 63 caracteres. Para obter mais informações sobre como nomear filas, confira Nomeando filas e metadados.

Adicione esse código dentro do método main e substitua o valor do espaço reservado <storage-account-name>:

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

Observação

As mensagens enviadas usando a classe QueueClient devem estar em um formato que possa ser incluído em uma solicitação XML com codificação UTF-8. Opcionalmente, você pode definir a opção MessageEncoding como BASE64 para lidar com mensagens sem conformidade.

Criar uma fila

Usando o objeto QueueClient, chame o método create para criar a fila na sua conta de armazenamento.

Adicione este código ao final do método main:

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

// Create the queue
queueClient.create();

Adicionar mensagens a uma fila

O snippet de código a seguir adiciona mensagens à fila chamando o método sendMessage. Ele também salva um SendMessageResult retornado de uma chamada sendMessage. O resultado é usado para atualizar a mensagem posteriormente no programa.

Adicione este código ao final do método main:

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

Espiar mensagens em uma fila

Espie as mensagens na fila chamando o método peekMessages. Esse método recupera uma ou mais mensagens do início da fila, mas não altera a visibilidade da mensagem.

Adicione este código ao final do método main:

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

Atualizar uma mensagem em uma fila

Atualize o conteúdo de uma mensagem chamando o método updateMessage. Esse método pode alterar o conteúdo e o tempo limite da visibilidade de uma mensagem. O conteúdo da mensagem precisa ser uma cadeia de caracteres codificada em UTF-8 com até 64 KB. Junto com o novo conteúdo da mensagem, passe a ID da mensagem e o recebimento pop usando o SendMessageResult que foi salvo anteriormente no código. A ID da mensagem e o recebimento pop identificam qual mensagem atualizar.

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

Obter o tamanho da fila

Você pode obter uma estimativa do número de mensagens em uma fila.

O método getProperties retorna vários valores, incluindo o número de mensagens atualmente em uma fila. A contagem é aproximada apenas porque as mensagens podem ser adicionadas ou removidas depois da sua solicitação. O método getApproximateMessageCount retorna o último valor recuperado pela chamada a getProperties, sem chamar o Armazenamento de Filas.

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

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

Receber e excluir mensagens de uma fila

Baixe as mensagens adicionadas anteriormente chamando o método receiveMessages. O código de exemplo também exclui mensagens da fila depois que elas são recebidas e processadas. Nesse caso, o processamento só exibe a mensagem no console.

O aplicativo pausa para a entrada do usuário chamando System.console().readLine(); antes de receber e excluir as mensagens. Verifique no portal do Azure se os recursos foram criados corretamente antes de serem excluídos. As mensagens que não forem explicitamente excluídas acabarão se tornando visíveis na fila novamente para outra oportunidade de processamento.

Adicione este código ao final do método main:

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

Ao chamar o método receiveMessages , você pode, opcionalmente, especificar um valor para maxMessages, que é o número de mensagens a serem recuperadas da fila. O padrão é 1 mensagem e o máximo são 32 mensagens. Você também pode especificar um valor para o visibilityTimeout, o que ocultará as mensagens de outras operações durante o período do tempo limite. O padrão é 30 segundos.

Excluir uma fila

O código a seguir limpa os recursos que o aplicativo criou ao excluir a fila usando o método Delete.

Adicione este código ao final do método main:

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

Executar o código

Esse aplicativo cria e adiciona três mensagens a uma fila do Azure. O código lista as mensagens na fila e, em seguida, recupera essas mensagens e as exclui, antes de excluir a fila.

Na janela do console, navegue até seu diretório de aplicativo e compile e execute o aplicativo.

mvn compile

Em seguida, compile o pacote.

mvn package

Use o comando mvn a seguir para executar o aplicativo.

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

A saída do aplicativo é semelhante ao seguinte exemplo:

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

Quando o aplicativo pausar antes de receber mensagens, verifique sua conta de armazenamento no portal do Azure. Verifique se as mensagens estão na fila.

Pressione a tecla Enter para receber e excluir as mensagens. Quando solicitado, pressione a tecla Enter novamente para excluir a fila e concluir a demonstração.

Próximas etapas

Neste guia de início rápido, você aprendeu a criar uma fila e a adicionar mensagens a ela usando código Java. Em seguida, você aprendeu a espiar, recuperar e excluir mensagens. Por fim, você aprendeu a excluir uma fila de mensagens.

Para acessar tutoriais, amostras, inícios rápidos e outras documentações, visite:

Azure para desenvolvedores de nuvem do Java