Inviare messaggi a un argomento del bus di servizio di Azure e ricevere messaggi dalle sottoscrizioni dell'argomento (Java)

In questa guida di avvio rapido viene scritto codice Java con il pacchetto azure-messaging-servicebus per inviare messaggi a un argomento del bus di servizio di Azure e quindi ricevere messaggi dalle sottoscrizioni di tale argomento.

Nota

Questo avvio rapido fornisce istruzioni dettagliate per un semplice scenario di invio di un batch di messaggi a un argomento di Bus di servizio e ricezione di tali messaggi da una sottoscrizione dell'argomento. È possibile trovare esempi di Java predefiniti per il Bus di servizio di Azure nel repository Azure SDK per Java su GitHub.

Suggerimento

Se si lavora con le risorse di Bus di servizio di Azure in un'applicazione Spring, è consigliabile prendere in considerazione Spring Cloud Azure come alternativa. Spring Cloud Azure è un progetto open source che offre l'integrazione perfetta di Spring con i servizi di Azure. Per altre informazioni su Spring Cloud Azure e per un esempio relativo all'uso del Bus di servizio, vedere Spring Cloud Stream con il Bus di servizio di Azure.

Prerequisiti

Creare uno spazio dei nomi nel portale di Azure

Per iniziare a usare le entità di messaggistica del bus di servizio in Azure, prima di tutto è necessario creare uno spazio dei nomi con un nome univoco in Azure. Uno spazio dei nomi fornisce un contenitore di ambito per le risorse del Bus di servizio (code, argomenti, ecc.) all'interno dell'applicazione.

Per creare uno spazio dei nomi:

  1. Accedere al portale di Azure.

  2. Andare alla pagina Tutti i servizi.

  3. Nella barra di spostamento a sinistra selezionare Integrazione nell'elenco delle categorie, passare il puntatore del mouse sul Bus di servizio quindi selezionare il pulsante + nel riquadro Bus di servizio.

    Immagine che mostra la selezione di Crea una risorsa, Integrazione quindi Bus di servizio nel menu.

  4. Nel tag Dati principali della pagina Crea spazio dei nomi seguire questa procedura:

    1. Per Sottoscrizione scegliere una sottoscrizione di Azure in cui creare lo spazio dei nomi.

    2. Per Gruppo di risorse scegliere un gruppo di risorse esistente in cui risiederà lo spazio dei nomi oppure crearne uno nuovo.

    3. Immettere un nome per lo spazio dei nomi. Il nome dello spazio dei nomi deve rispettare le seguenti convenzioni di denominazione:

      • Il nome deve essere univoco in Azure. Verrà effettuato immediatamente un controllo sulla disponibilità del nome.
      • La lunghezza del nome deve essere compresa tra 6 e 50 caratteri.
      • Il nome può contenere solo lettere, numeri e trattini "-".
      • Il nome deve iniziare con una lettera e terminare con una lettera o un numero.
      • Il nome non termina con "-sb" o "-mgmt".
    4. Per Localitàscegliere l'area in cui deve essere ospitato lo spazio dei nomi.

    5. In Piano tariffario, selezionare il piano tariffario (Basic, Standard o Premium) per lo spazio dei nomi. Per questo avvio rapido selezionare Standard.

      Importante

      Se si vogliono usare argomenti e sottoscrizioni, scegliere Standard o Premium. Argomenti e sottoscrizioni non sono supportati nel piano tariffario Basic.

      Se è stato selezionato il piano tariffario Premium, specificare il numero di unità di messaggistica. Il piano Premium fornisce l'isolamento delle risorse a livello di CPU e memoria in modo che ogni carico di lavoro venga eseguito in isolamento. Questo contenitore di risorse viene chiamato unità di messaggistica. Uno spazio dei nomi Premium ha almeno un'unità di messaggistica. È possibile acquistare 1, 2, 4, 8 o 16 unità di messaggistica per ogni spazio dei nomi Premium del Bus di servizio. Per altre informazioni, vedere Messaggistica Premium del bus di servizio.

    6. Selezionare Rivedi e crea nella parte inferiore della pagina.

      Immagine che mostra la pagina Creare uno spazio dei nomi

    7. Nella pagina Rivedi + crea controllare le impostazioni e selezionare Crea.

  5. Al termine della distribuzione della risorsa, selezionare Vai alla risorsa nella pagina di distribuzione.

    Immagine che mostra la pagina distribuzione riuscita con il link Vai alla risorsa.

  6. Viene visualizzata la home page dello spazio dei nomi del bus di servizio.

    Immagine che mostra la home page dello spazio dei nomi del Bus di servizio creato.

Creare un argomento usando il portale di Azure

  1. Nella pagina Spazio dei nomi del bus di servizio scegliere Argomenti dal menu a sinistra.

  2. Selezionare + Argomento sulla barra degli strumenti.

  3. Immettere un nome per l'argomento. Lasciare invariati i valori predefiniti delle altre opzioni.

  4. Seleziona Crea.

    Immagine che mostra la pagina Crea argomento.

Creare una sottoscrizione all'argomento

  1. Selezionare l'argomento creato nella sezione precedente.

    Immagine che mostra la selezione dell'argomento nell'elenco di argomenti.

  2. Nella pagina Argomento di Bus di servizio selezionare + Sottoscrizione nella barra degli strumenti.

    Immagine che mostra il pulsante Aggiungi sottoscrizione.

  3. Nella pagina Crea sottoscrizione procedere come segue:

    1. Immettere S1 per il nome della sottoscrizione.

    2. Immettere 3 per Numero massimo di recapito.

    3. Successivamente, selezionare Crea per creare la sottoscrizione.

      Immagine che mostra la pagina Crea sottoscrizione.

Autenticare l'app in Azure

Questo avvio rapido illustra due modi per connettersi al Bus di servizio di Azure: senza password e stringa di connessione.

La prima opzione mostra come usare l'entità di sicurezza in Microsoft Entra ID e il controllo degli accessi in base al ruolo (RBAC) per connettersi a uno spazio dei nomi del Bus di servizio. Non è necessario preoccuparsi di avere una stringa di connessione hardcoded nel codice, in un file di configurazione o in un'archiviazione sicura come Azure Key Vault.

La seconda opzione mostra come usare una stringa di connessione per connettersi a uno spazio dei nomi del Bus di servizio. Se non si ha familiarità con Azure, l'opzione della stringa di connessione può essere più semplice da seguire. È consigliabile usare l'opzione senza password in applicazioni e ambienti di produzione reali. Per altre informazioni, consultare Autenticazione e autorizzazione. Per altre informazioni sull'autenticazione senza password, vedere la pagina di panoramica.

Assegnare ruoli all'utente di Microsoft Entra

Quando si sviluppa in locale, assicurarsi che l'account utente che si connette al Bus di servizio di Azure disponga delle autorizzazioni corrette. Per inviare e ricevere messaggi, è necessario il ruolo Proprietario dei dati del Bus di servizio di Azure. Per assegnare a se stessi questo ruolo, è necessario il ruolo Amministratore accesso utenti o un altro ruolo che include l'azione Microsoft.Authorization/roleAssignments/write. È possibile assegnare ruoli controllo degli accessi in base al ruolo di Azure a un utente usando il portale di Azure, l'interfaccia della riga di comando di Azure o Azure PowerShell. Altre informazioni sugli ambiti disponibili per le assegnazioni di ruolo sono disponibili nella pagina panoramica dell'ambito .

L'esempio seguente assegna il ruolo Azure Service Bus Data Owner all'account utente, che fornisce l'accesso completo alle risorse del Bus di servizio di Azure. In uno scenario reale, seguire il Principio dei privilegi minimi per concedere agli utenti solo le autorizzazioni minime necessarie per un ambiente di produzione più sicuro.

Ruoli predefiniti di Azure per il Bus di servizio di Azure

Per il Bus di servizio di Azure, la gestione degli spazi dei nomi e di tutte le risorse correlate tramite il portale di Azure e l'API Gestione risorse di Azure è già protetto mediante il modello RBAC di Azure. Azure fornisce i ruoli predefiniti di Azure seguenti per autorizzare l'accesso a uno spazio dei nomi del Bus di servizio:

Per creare un ruolo personalizzato, vedere Diritti necessari per le operazioni del Bus di servizio.

Aggiungere l'utente di Microsoft Entra al ruolo Proprietario del Bus di servizio di Azure

Aggiungere il nome utente di Microsoft Entra al ruolo Proprietario dei dati del Bus di servizio di Azure a livello di spazio dei nomi del Bus di servizio. Consentirà a un'app in esecuzione nel contesto dell'account utente di inviare messaggi a una coda o a un argomento e di ricevere messaggi da una coda o da una sottoscrizione di un argomento.

Importante

Nella maggior parte dei casi, la propagazione dell'assegnazione di ruolo in Azure richiederà almeno due minuti. In rari casi, possono essere necessari fino a otto minuti. Se si ricevono errori di autenticazione quando si esegue il codice per la prima volta, attendere alcuni istanti e riprovare.

  1. Se la pagina Spazio dei nomi del Bus di servizio non è aperta nel portale di Azure, individuare lo spazio dei nomi del Bus di servizio usando la barra di ricerca principale o lo spostamento a sinistra.

  2. Nella pagina di panoramica selezionare Controllo di accesso (IAM) nel menu a sinistra.

  3. Nella pagina Controllo di accesso (IAM), selezionare la scheda Assegnazioni di ruolo.

  4. Selezionare + Aggiungi dal menu in alto e quindi Aggiungi assegnazione di ruolo dal menu a discesa risultante.

    Screenshot che mostra come assegnare un ruolo.

  5. Usare la casella di ricerca per filtrare i risultati in base al ruolo desiderato. Per questo esempio, cercare Azure Service Bus Data Owner e selezionare il risultato corrispondente. Scegliere quindi Avanti.

  6. In Assegna accesso a selezionare Utente, gruppo o entità servizio e quindi scegliere + Seleziona membri.

  7. Nella finestra di dialogo cercare il nome utente di Microsoft Entra (in genere l'indirizzo di posta elettronica user@domain) e quindi scegliere Selezionare nella parte inferiore della finestra di dialogo.

  8. Selezionare Rivedi e assegna per passare alla pagina finale e quindi Rivedi e assegna di nuovo per completare il processo.

Inviare messaggi a un argomento

In questa sezione viene creato un progetto di console Java, quindi verrà aggiunto codice per inviare messaggi all'argomento creato.

Creare un progetto di console Java

Creare un progetto Java usando Eclipse o un altro strumento a scelta.

Configurare l'applicazione per l'uso del bus di servizio

Aggiungere riferimenti alle librerie di Azure Core e del Bus di servizio di Azure.

Se si usa Eclipse e si crea un'applicazione console Java, convertire il progetto Java in Maven: fare clic con il pulsante destro del mouse sul progetto nella finestra Esplora pacchetti, selezionare Configura ->Converti in progetto Maven. Aggiungere quindi dipendenze a queste due librerie, come illustrato nell'esempio seguente.

Aggiornare il file pom.xml per aggiungere dipendenze al Bus di servizio di Azure e ai pacchetti di identità di Azure.

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

Aggiungere il codice per inviare messaggi all'argomento

  1. Aggiungere le istruzioni import seguenti nell'argomento del file Java.

    import com.azure.messaging.servicebus.*;
    import com.azure.identity.*;
    
    import java.util.concurrent.TimeUnit;
    import java.util.Arrays;
    import java.util.List;
    
  2. Nella classe definire le variabili per contenere la stringa di connessione (non necessaria per lo scenario senza password), il nome dell'argomento e il nome della sottoscrizione.

    static String topicName = "<TOPIC NAME>";
    static String subName = "<SUBSCRIPTION NAME>";
    

    Importante

    Sostituire <TOPIC NAME> con il nome dell'argomento e <SUBSCRIPTION NAME> con il nome della sottoscrizione dell'argomento.

  3. Aggiungere un metodo denominato sendMessage nella classe per inviare un messaggio all'argomento.

    Importante

    Sostituire NAMESPACENAME con il nome dello spazio dei nomi del bus di servizio.

    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);
    }
    
    
  4. Aggiungere un metodo denominato createMessages nella classe per creare un elenco di messaggi. In genere, questi messaggi provengono da parti diverse dell'applicazione. In questo caso verrà creato un elenco di messaggi di esempio.

    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);
    }
    
  5. Aggiungere un metodo denominato sendMessageBatch per inviare messaggi all'argomento creato. Questo metodo crea un oggetto ServiceBusSenderClient per l'argomento, richiama il metodo createMessages per ottenere l'elenco di messaggi, prepara uno o più batch e li invia all'argomento.

    Importante

    Sostituire NAMESPACENAME con il nome dello spazio dei nomi del bus di servizio.

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

Ricevere messaggi da una sottoscrizione

In questa sezione si aggiunge il codice per recuperare i messaggi dalla sottoscrizione dell'argomento.

  1. Aggiungere un metodo denominato receiveMessages per ricevere messaggi dalla sottoscrizione. Questo metodo crea un oggetto ServiceBusProcessorClient per la sottoscrizione specificando un gestore per l'elaborazione di messaggi e un altro per la gestione degli errori. Quindi avvia il processore, aspetta alcuni secondi, stampa i messaggi ricevuti e infine arresta e chiude il processore.

    Importante

    • Sostituire NAMESPACENAME con il nome dello spazio dei nomi del bus di servizio.
    • Sostituire ServiceBusTopicTest in ServiceBusTopicTest::processMessage nel codice con il nome della 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();
    }
    
  2. Aggiungere il metodo processMessage per elaborare un messaggio ricevuto dalla sottoscrizione del Bus di servizio.

    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());
    }
    
  3. Aggiungere il metodo processError per gestire i messaggi di errore.

    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());
        }
    }
    
  4. Aggiornare il metodo main per richiamare i metodi sendMessage, sendMessageBatch e receiveMessages e per generare InterruptedException.

    public static void main(String[] args) throws InterruptedException {
        sendMessage();
        sendMessageBatch();
        receiveMessages();
    }
    

Eseguire l'app

Eseguire il programma per visualizzare l'output simile all'output seguente:

  1. Se si usa Eclipse, fare clic con il pulsante destro del mouse sul progetto, scegliere Esporta, espandere Java, selezionare Esegui file JAR eseguibile e seguire la procedura per creare un file JAR eseguibile.

  2. Se si è connessi al computer usando un account utente differente dall'account utente aggiunto al ruolo Proprietario dati del Bus di servizio di Azure, seguire questa procedura. In caso contrario, ignorare questo passaggio e procedere per eseguire il file Jar nel passaggio successivo.

    1. Installare l'interfaccia della riga di comando di Azure nel computer.

    2. Eseguire il comando seguente dell'interfaccia della riga di comando per accedere ad Azure. Usare lo stesso account utente aggiunto al ruolo Proprietario dati del Bus di servizio di Azure.

      az login
      
  3. Eseguire il file Jar usando il comando seguente.

    java -jar <JAR FILE NAME>
    
  4. Nella finestra della console è visualizzato l'output seguente.

    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
    

Nella pagina Panoramica dello spazio dei nomi del bus di servizio nel portale di Azure è possibile visualizzare il numero di messaggi in ingresso e in uscita. Aspettare circa un minuto quindi aggiornare la pagina per vedere i valori più recenti.

Numero di messaggi in ingresso e in uscita

Passare alla scheda Argomenti nel riquadro centrale inferiore, quindi selezionare l'argomento per visualizzare la relativa pagina Argomento del bus di servizio. In questa pagina verranno visualizzati quattro messaggi in ingresso e quattro messaggi in uscita nel grafico Messaggi.

Messaggi in ingresso e in uscita

Se si imposta come commento la chiamata receiveMessages nel metodo main e si esegue di nuovo l'app, nella pagina Argomento del bus di servizio verranno visualizzati 8 messaggi in ingresso (4 nuovi) ma solo quattro messaggi in uscita.

Pagina dell'argomento aggiornata

Se in questa pagina si seleziona una sottoscrizione si passa alla pagina Sottoscrizione del bus di servizio. In questa pagina è possibile visualizzare il numero di messaggi attivi, il numero di messaggi non recapitabili e altro ancora. In questo esempio sono presenti quattro messaggi attivi che il ricevitore non ha ancora ricevuto.

Numero di messaggi attivi

Passaggi successivi

Vedere la documentazione e gli esempi seguenti: