Enviar mensagens para um tópico do Barramento de Serviço do Azure e receber mensagens de assinaturas para o tópico (Java)
Neste início rápido, você escreve código Java usando o pacote azure-messaging-servicebus para enviar mensagens para um tópico do Barramento de Serviço do Azure e, em seguida, receber mensagens de assinaturas desse tópico.
Nota
Este início rápido fornece instruções passo a passo para um cenário simples de enviar um lote de mensagens para um tópico do Service Bus e receber essas mensagens de uma assinatura do tópico. Você pode encontrar exemplos Java pré-criados para o Barramento de Serviço do Azure no repositório do SDK do Azure para Java no GitHub.
Gorjeta
Se você estiver trabalhando com recursos do Barramento de Serviço do Azure em um aplicativo Spring, recomendamos que considere o Spring Cloud Azure como uma alternativa. O Spring Cloud Azure é um projeto de código aberto que fornece integração perfeita do Spring com os serviços do Azure. Para saber mais sobre o Spring Cloud Azure e ver um exemplo usando o Service Bus, consulte Spring Cloud Stream com o Azure Service Bus.
Pré-requisitos
- Uma subscrição do Azure. Para concluir este tutorial, precisa de uma conta do Azure. Você pode ativar seus benefícios de assinante do Visual Studio ou MSDN ou se inscrever para uma conta gratuita.
- Instale o SDK do Azure para Java. Se estiver a utilizar o Eclipse, pode instalar o Kit de Ferramentas do Azure para Eclipse que inclui o SDK do Azure para Java. Em seguida, você pode adicionar as Bibliotecas do Microsoft Azure para Java ao seu projeto. Se estiver a utilizar o IntelliJ, consulte Instalar o Kit de Ferramentas do Azure para IntelliJ.
Criar um espaço de nomes no portal do Azure
Para começar a utilizar as entidades de mensagens do Service Bus no Azure, tem de, primeiro, criar um espaço de nomes que seja exclusivo em todo o Azure. Um namespace fornece um contêiner de escopo para recursos do Service Bus (filas, tópicos, etc.) em seu aplicativo.
Para criar um espaço de nomes:
Inicie sessão no portal do Azure.
Navegue até a página Todos os serviços.
Na barra de navegação esquerda, selecione Integração na lista de categorias, passe o mouse sobre o Service Bus e selecione + o botão no bloco do Service Bus.
Na marca Basics da página Criar namespace, siga estas etapas:
Em Assinatura, escolha uma assinatura do Azure na qual criar o namespace.
Para Grupo de recursos, escolha um grupo de recursos existente no qual o namespace viverá ou crie um novo.
Insira um nome para o namespace. O nome do namespace deve aderir às seguintes convenções de nomenclatura:
- O nome deve ser exclusivo no Azure. O sistema verifica imediatamente a disponibilidade do nome.
- O comprimento do nome é de pelo menos 6 e no máximo 50 caracteres.
- O nome pode conter apenas letras, números hífenes "-".
- O nome deve começar com uma letra e terminar com uma letra ou número.
- O nome não termina com "-sb" ou "-mgmt".
Em Local, escolha a região na qual seu namespace deve ser hospedado.
Em Nível de preço, selecione o nível de preço (Básico, Standard ou Premium) para o namespace. Para este início rápido, selecione Padrão.
Importante
Se você quiser usar tópicos e assinaturas, escolha Standard ou Premium. Não há suporte para tópicos/assinaturas no nível de preço Básico.
Se você selecionou o nível de preço Premium, especifique o número de unidades de mensagens. A camada premium fornece isolamento de recursos no nível de CPU e memória para que cada carga de trabalho seja executada isoladamente. Este contentor de recursos é designado por unidade de mensagens. Um namespace premium tem pelo menos uma unidade de mensagens. Você pode selecionar 1, 2, 4, 8 ou 16 unidades de mensagens para cada namespace Premium do Service Bus. Para obter mais informações, consulte Mensagens Premium do Service Bus.
Selecione Rever + criar na parte inferior da página.
Na página Rever + criar, reveja as definições e selecione Criar.
Quando a implantação do recurso for bem-sucedida, selecione Ir para o recurso na página de implantação.
Você vê a home page do namespace do barramento de serviço.
Criar um tópico com o portal do Azure
Na página Namespace do Service Bus, selecione Tópicos no menu à esquerda.
Selecione + Tópico na barra de ferramentas.
Insira um nome para o tópico. Deixe as outras opções com os valores predefinidos.
Selecione Criar.
Criar uma subscrição para o tópico
Selecione o tópico que você criou na seção anterior.
Na página Tópico do Service Bus, selecione + Assinatura na barra de ferramentas.
Na página Criar subscrição, siga estes passos:
Digite S1 para o nome da assinatura.
Digite 3 para Contagem máxima de entregas.
Em seguida, selecione Criar para criar a assinatura.
Autenticar o aplicativo no Azure
Este início rápido mostra duas maneiras de se conectar ao Barramento de Serviço do Azure: sem senha e cadeia de conexão.
A primeira opção mostra como usar sua entidade de segurança no Microsoft Entra ID e RBAC (controle de acesso baseado em função) para se conectar a um namespace do Service Bus. Você não precisa se preocupar em ter uma cadeia de conexão codificada em seu código ou em um arquivo de configuração ou em um armazenamento seguro como o Azure Key Vault.
A segunda opção mostra como usar uma cadeia de conexão para se conectar a um namespace do Service Bus. Se você for novo no Azure, poderá achar a opção de cadeia de conexão mais fácil de seguir. Recomendamos o uso da opção sem senha em aplicativos e ambientes de produção do mundo real. Para obter mais informações, consulte Autenticação e autorização. Você também pode ler mais sobre autenticação sem senha na página de visão geral.
Atribuir funções ao usuário do Microsoft Entra
Ao desenvolver localmente, verifique se a conta de usuário que se conecta ao Barramento de Serviço do Azure tem as permissões corretas. Você precisará da função Proprietário de Dados do Barramento de Serviço do Azure para enviar e receber mensagens. Para atribuir essa função a si mesmo, você precisará da função de Administrador de Acesso de Usuário ou de outra função que inclua a Microsoft.Authorization/roleAssignments/write
ação. Você pode atribuir funções do RBAC do Azure a um usuário usando o portal do Azure, a CLI do Azure ou o Azure PowerShell. Saiba mais sobre os escopos disponíveis para atribuições de função na página de visão geral do escopo.
O exemplo a seguir atribui a Azure Service Bus Data Owner
função à sua conta de usuário, que fornece acesso total aos recursos do Barramento de Serviço do Azure. Em um cenário real, siga o Princípio do Menor Privilégio para dar aos usuários apenas as permissões mínimas necessárias para um ambiente de produção mais seguro.
Funções internas do Azure para o Barramento de Serviço do Azure
Para o Barramento de Serviço do Azure, o gerenciamento de namespaces e todos os recursos relacionados por meio do portal do Azure e da API de gerenciamento de recursos do Azure já está protegido usando o modelo RBAC do Azure. O Azure fornece as seguintes funções internas do Azure para autorizar o acesso a um namespace do Service Bus:
- Proprietário de Dados do Barramento de Serviço do Azure: habilita o acesso a dados ao namespace do Barramento de Serviço e suas entidades (filas, tópicos, assinaturas e filtros). Um membro dessa função pode enviar e receber mensagens de filas ou tópicos/assinaturas.
- Remetente de Dados do Barramento de Serviço do Azure: use essa função para conceder acesso de envio ao namespace do Barramento de Serviço e suas entidades.
- Recetor de Dados do Barramento de Serviço do Azure: use essa função para conceder acesso de recebimento ao namespace do Barramento de Serviço e suas entidades.
Se você quiser criar uma função personalizada, consulte Direitos necessários para operações do Service Bus.
Adicionar usuário do Microsoft Entra à função de Proprietário do Barramento de Serviço do Azure
Adicione seu nome de usuário do Microsoft Entra à função Proprietário de Dados do Barramento de Serviço do Azure no nível do namespace do Barramento de Serviço. Ele permitirá que um aplicativo em execução no contexto da sua conta de usuário envie mensagens para uma fila ou um tópico e receba mensagens de uma fila ou da assinatura de um tópico.
Importante
Na maioria dos casos, levará um ou dois minutos para que a atribuição de função se propague no Azure. Em casos raros, pode demorar até oito minutos. Se você receber erros de autenticação quando executar o código pela primeira vez, aguarde alguns momentos e tente novamente.
Se você não tiver a página Namespace do Service Bus aberta no portal do Azure, localize seu namespace do Service Bus usando a barra de pesquisa principal ou a navegação à esquerda.
Na página de visão geral, selecione Controle de acesso (IAM) no menu à esquerda.
Na página Controle de acesso (IAM), selecione a guia Atribuições de função.
Selecione + Adicionar no menu superior e, em seguida, Adicionar atribuição de função no menu suspenso resultante.
Use a caixa de pesquisa para filtrar os resultados para a função desejada. Para este exemplo, procure
Azure Service Bus Data Owner
e selecione o resultado correspondente. Em seguida, escolha Avançar.Em Atribuir acesso a, selecione Utilizador, grupo ou entidade de serviço e, em seguida, selecione + Selecionar membros.
Na caixa de diálogo, procure seu nome de usuário do Microsoft Entra (geralmente seu endereço de e-mail user@domain ) e escolha Selecionar na parte inferior da caixa de diálogo.
Selecione Rever + atribuir para ir para a página final e, em seguida , Rever + atribuir novamente para concluir o processo.
Enviar mensagens para um tópico
Nesta seção, você cria um projeto de console Java e adiciona código para enviar mensagens ao tópico criado.
Criar um projeto de console Java
Crie um projeto Java usando o Eclipse ou uma ferramenta de sua escolha.
Configurar seu aplicativo para usar o Service Bus
Adicione referências às bibliotecas do Azure Core e do Azure Service Bus.
Se você estiver usando o Eclipse e tiver criado um aplicativo de console Java, converta seu projeto Java em um Maven: clique com o botão direito do mouse no projeto na janela Package Explorer , selecione Configure ->Convert to Maven project. Em seguida, adicione dependências a essas duas bibliotecas, conforme mostrado no exemplo a seguir.
Atualize o pom.xml
arquivo para adicionar dependências aos pacotes do Barramento de Serviço do Azure e do Azure Identity.
<dependencies>
<dependency>
<groupId>com.azure</groupId>
<artifactId>azure-messaging-servicebus</artifactId>
<version>7.13.3</version>
</dependency>
<dependency>
<groupId>com.azure</groupId>
<artifactId>azure-identity</artifactId>
<version>1.8.0</version>
<scope>compile</scope>
</dependency>
</dependencies>
Adicionar código para enviar mensagens ao tópico
Adicione as seguintes
import
instruções no tópico do arquivo Java.import com.azure.messaging.servicebus.*; import com.azure.identity.*; import java.util.concurrent.TimeUnit; import java.util.Arrays; import java.util.List;
Na classe, defina variáveis para manter a cadeia de conexão (não necessária para o cenário sem senha), nome do tópico e nome da assinatura.
static String topicName = "<TOPIC NAME>"; static String subName = "<SUBSCRIPTION NAME>";
Importante
Substitua
<TOPIC NAME>
pelo nome do tópico e<SUBSCRIPTION NAME>
pelo nome da assinatura do tópico.Adicione um método nomeado
sendMessage
na classe para enviar uma mensagem para o tópico.Importante
Substitua
NAMESPACENAME
pelo nome do espaço de nomes do Service Bus.static void sendMessage() { // create a token using the default Azure credential DefaultAzureCredential credential = new DefaultAzureCredentialBuilder() .build(); ServiceBusSenderClient senderClient = new ServiceBusClientBuilder() .fullyQualifiedNamespace("NAMESPACENAME.servicebus.windows.net") .credential(credential) .sender() .topicName(topicName) .buildClient(); // send one message to the topic senderClient.sendMessage(new ServiceBusMessage("Hello, World!")); System.out.println("Sent a single message to the topic: " + topicName); }
Adicione um método nomeado
createMessages
na classe para criar uma lista de mensagens. Normalmente, você recebe essas mensagens de diferentes partes do seu aplicativo. Aqui, criamos uma lista de exemplos de mensagens.static List<ServiceBusMessage> createMessages() { // create a list of messages and return it to the caller ServiceBusMessage[] messages = { new ServiceBusMessage("First message"), new ServiceBusMessage("Second message"), new ServiceBusMessage("Third message") }; return Arrays.asList(messages); }
Adicione um método chamado
sendMessageBatch
método para enviar mensagens para o tópico que você criou. Esse método cria umServiceBusSenderClient
para o tópico, invoca ocreateMessages
método para obter a lista de mensagens, prepara um ou mais lotes e envia os lotes para o tópico.Importante
Substitua
NAMESPACENAME
pelo nome do espaço de nomes do Service Bus.static void sendMessageBatch() { // create a token using the default Azure credential DefaultAzureCredential credential = new DefaultAzureCredentialBuilder() .build(); ServiceBusSenderClient senderClient = new ServiceBusClientBuilder() .fullyQualifiedNamespace("NAMESPACENAME.servicebus.windows.net") .credential(credential) .sender() .topicName(topicName) .buildClient(); // Creates an ServiceBusMessageBatch where the ServiceBus. ServiceBusMessageBatch messageBatch = senderClient.createMessageBatch(); // create a list of messages List<ServiceBusMessage> listOfMessages = createMessages(); // We try to add as many messages as a batch can fit based on the maximum size and send to Service Bus when // the batch can hold no more messages. Create a new batch for next set of messages and repeat until all // messages are sent. for (ServiceBusMessage message : listOfMessages) { if (messageBatch.tryAddMessage(message)) { continue; } // The batch is full, so we create a new batch and send the batch. senderClient.sendMessages(messageBatch); System.out.println("Sent a batch of messages to the topic: " + topicName); // create a new batch messageBatch = senderClient.createMessageBatch(); // Add that message that we couldn't before. if (!messageBatch.tryAddMessage(message)) { System.err.printf("Message is too large for an empty batch. Skipping. Max size: %s.", messageBatch.getMaxSizeInBytes()); } } if (messageBatch.getCount() > 0) { senderClient.sendMessages(messageBatch); System.out.println("Sent a batch of messages to the topic: " + topicName); } //close the client senderClient.close(); }
Receber mensagens de uma subscrição
Nesta seção, você adiciona código para recuperar mensagens de uma assinatura para o tópico.
Adicione um método chamado
receiveMessages
para receber mensagens da assinatura. Esse método cria umServiceBusProcessorClient
para a assinatura, especificando um manipulador para processar mensagens e outro para lidar com erros. Em seguida, ele inicia o processador, aguarda por alguns segundos, imprime as mensagens recebidas e, em seguida, para e fecha o processador.Importante
- Substitua
NAMESPACENAME
pelo nome do espaço de nomes do Service Bus. - Substitua
ServiceBusTopicTest
ServiceBusTopicTest::processMessage
no código pelo nome da sua classe.
// handles received messages static void receiveMessages() throws InterruptedException { DefaultAzureCredential credential = new DefaultAzureCredentialBuilder() .build(); // Create an instance of the processor through the ServiceBusClientBuilder ServiceBusProcessorClient processorClient = new ServiceBusClientBuilder() .fullyQualifiedNamespace("NAMESPACENAME.servicebus.windows.net") .credential(credential) .processor() .topicName(topicName) .subscriptionName(subName) .processMessage(context -> processMessage(context)) .processError(context -> processError(context)) .buildProcessorClient(); System.out.println("Starting the processor"); processorClient.start(); TimeUnit.SECONDS.sleep(10); System.out.println("Stopping and closing the processor"); processorClient.close(); }
- Substitua
Adicione o
processMessage
método para processar uma mensagem recebida da assinatura do Service Bus.private static void processMessage(ServiceBusReceivedMessageContext context) { ServiceBusReceivedMessage message = context.getMessage(); System.out.printf("Processing message. Session: %s, Sequence #: %s. Contents: %s%n", message.getMessageId(), message.getSequenceNumber(), message.getBody()); }
Adicione o
processError
método para manipular mensagens de erro.private static void processError(ServiceBusErrorContext context) { System.out.printf("Error when receiving messages from namespace: '%s'. Entity: '%s'%n", context.getFullyQualifiedNamespace(), context.getEntityPath()); if (!(context.getException() instanceof ServiceBusException)) { System.out.printf("Non-ServiceBusException occurred: %s%n", context.getException()); return; } ServiceBusException exception = (ServiceBusException) context.getException(); ServiceBusFailureReason reason = exception.getReason(); if (reason == ServiceBusFailureReason.MESSAGING_ENTITY_DISABLED || reason == ServiceBusFailureReason.MESSAGING_ENTITY_NOT_FOUND || reason == ServiceBusFailureReason.UNAUTHORIZED) { System.out.printf("An unrecoverable error occurred. Stopping processing with reason %s: %s%n", reason, exception.getMessage()); } else if (reason == ServiceBusFailureReason.MESSAGE_LOCK_LOST) { System.out.printf("Message lock lost for message: %s%n", context.getException()); } else if (reason == ServiceBusFailureReason.SERVICE_BUSY) { try { // Choosing an arbitrary amount of time to wait until trying again. TimeUnit.SECONDS.sleep(1); } catch (InterruptedException e) { System.err.println("Unable to sleep for period of time"); } } else { System.out.printf("Error source %s, reason %s, message: %s%n", context.getErrorSource(), reason, context.getException()); } }
Atualize o
main
método para invocarsendMessage
,sendMessageBatch
ereceiveMessages
métodos e lançarInterruptedException
.public static void main(String[] args) throws InterruptedException { sendMessage(); sendMessageBatch(); receiveMessages(); }
Executar a aplicação
Execute o programa para ver a saída semelhante à seguinte saída:
Se você estiver usando o Eclipse, clique com o botão direito do mouse no projeto, selecione Exportar, expanda Java, selecione Arquivo JAR executável e siga as etapas para criar um arquivo JAR executável.
Se você estiver conectado à máquina usando uma conta de usuário diferente da conta de usuário adicionada à função de Proprietário de Dados do Barramento de Serviço do Azure, siga estas etapas. Caso contrário, ignore esta etapa e passe a executar o arquivo Jar na próxima etapa.
Instale a CLI do Azure em sua máquina.
Execute o seguinte comando da CLI para entrar no Azure. Use a mesma conta de usuário que você adicionou à função de Proprietário de Dados do Barramento de Serviço do Azure.
az login
Execute o arquivo Jar usando o seguinte comando.
java -jar <JAR FILE NAME>
Você verá a seguinte saída na janela do console.
Sent a single message to the topic: mytopic Sent a batch of messages to the topic: mytopic Starting the processor Processing message. Session: e0102f5fbaf646988a2f4b65f7d32385, Sequence #: 1. Contents: Hello, World! Processing message. Session: 3e991e232ca248f2bc332caa8034bed9, Sequence #: 2. Contents: First message Processing message. Session: 56d3a9ea7df446f8a2944ee72cca4ea0, Sequence #: 3. Contents: Second message Processing message. Session: 7bd3bd3e966a40ebbc9b29b082da14bb, Sequence #: 4. Contents: Third message
Na página Visão geral do namespace do Service Bus no portal do Azure, você pode ver a contagem de mensagens de entrada e saída. Aguarde cerca de um minuto e, em seguida, atualize a página para ver os valores mais recentes.
Alterne para a guia Tópicos no painel central inferior e selecione o tópico para ver a página Tópico do Service Bus do seu tópico. Nesta página, você verá quatro mensagens de entrada e quatro de saída no gráfico Mensagens .
Se você comentar a receiveMessages
main
chamada no método e executar o aplicativo novamente, na página Tópico do Service Bus, verá 8 mensagens de entrada (4 novas), mas quatro mensagens de saída.
Nesta página, se selecionar uma subscrição, acede à página Subscrição do Service Bus. Você pode ver a contagem de mensagens ativas, a contagem de mensagens mortas e muito mais nesta página. Neste exemplo, há quatro mensagens ativas que o destinatário ainda não recebeu.
Próximos passos
Consulte a seguinte documentação e exemplos: