Come usare le code del bus di servizio con JavaHow to use Service Bus queues with Java

Questo articolo illustra come usare le code del bus di servizio.This article describes how to use Service Bus queues. Gli esempi sono scritti in Java e usano Azure SDK per Java.The samples are written in Java and use the Azure SDK for Java. Gli scenari presentati includono la creazione di code, l'invio e la ricezione di messaggi e l'eliminazione di code.The scenarios covered include creating queues, sending and receiving messages, and deleting queues.

Informazioni sulle code del bus di servizioWhat are Service Bus queues?

Le code del bus di servizio supportano un modello di comunicazione con messaggistica negoziata .Service Bus queues support a brokered messaging communication model. Quando si usano le code, i componenti di un'applicazione distribuita non comunicano direttamente l'uno con l'altro, ma scambiano messaggi tramite una coda, che agisce da intermediario (broker).When using queues, components of a distributed application do not communicate directly with each other; instead they exchange messages via a queue, which acts as an intermediary (broker). Un producer di messaggi (mittente) invia un messaggio alla coda e quindi prosegue con la relativa elaborazione.A message producer (sender) hands off a message to the queue and then continues its processing. In modo asincrono, il consumer di messaggi (ricevitore) recupera il messaggio dalla coda e lo elabora.Asynchronously, a message consumer (receiver) pulls the message from the queue and processes it. Il producer non deve attendere la risposta del consumer per continuare a elaborare e inviare ulteriori messaggi.The producer does not have to wait for a reply from the consumer in order to continue to process and send further messages. Le code consentono un recapito dei messaggi di tipo FIFO (First In, First Out) a uno o più consumer concorrenti.Queues offer First In, First Out (FIFO) message delivery to one or more competing consumers. In base a questo metodo, in genere i messaggi vengono ricevuti ed elaborati nell'ordine temporale in cui sono stati aggiunti alla coda e ogni messaggio viene ricevuto ed elaborato da un solo consumer.That is, messages are typically received and processed by the receivers in the order in which they were added to the queue, and each message is received and processed by only one message consumer.

Concetti relativi alle code

Le code del bus di servizio sono una tecnologia di carattere generale che può essere usata in numerosi scenari:Service Bus queues are a general-purpose technology that can be used for a wide variety of scenarios:

  • Comunicazione tra ruoli Web e di lavoro in un'applicazione Azure multilivello.Communication between web and worker roles in a multi-tier Azure application.
  • Comunicazione tra app locali e app ospitate in Azure in una soluzione ibrida.Communication between on-premises apps and Azure-hosted apps in a hybrid solution.
  • Comunicazione tra componenti di un'applicazione distribuita in esecuzione in locale in organizzazioni diverse o in reparti diversi della stessa organizzazione.Communication between components of a distributed application running on-premises in different organizations or departments of an organization.

L'uso delle code consente la scalabilità delle applicazioni e garantisce maggiore resilienza all'architettura.Using queues enables you to scale your applications more easily, and enable more resiliency to your architecture.

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.To begin using Service Bus messaging entities in Azure, you must first create a namespace with a name that is unique across Azure. Uno spazio dei nomi fornisce un contenitore di ambito per fare riferimento alle risorse del bus di servizio all'interno dell'applicazione.A namespace provides a scoping container for addressing Service Bus resources within your application.

Per creare uno spazio dei nomi:To create a namespace:

  1. Accedere al portale di Azure.Log on to the Azure portal.
  2. Nel riquadro di spostamento sinistro del portale fare clic su Nuovo, quindi su Enterprise Integration e infine su Bus di servizio.In the left navigation pane of the portal, click New, then click Enterprise Integration, and then click Service Bus.
  3. Nella finestra di dialogo Crea spazio dei nomi immettere un nome per lo spazio dei nomi.In the Create namespace dialog, enter a namespace name. Verrà effettuato immediatamente un controllo sulla disponibilità del nome.The system immediately checks to see if the name is available.
  4. Dopo aver verificato che il nome dello spazio dei nomi sia disponibile, scegliere il piano tariffario, ovvero Basic, Standard o Premium.After making sure the namespace name is available, choose the pricing tier (Basic, Standard, or Premium).
  5. Nel campo Sottoscrizione scegliere una sottoscrizione di Azure in cui creare lo spazio dei nomi.In the Subscription field, choose an Azure subscription in which to create the namespace.
  6. Nel campo Gruppo di risorse scegliere un gruppo di risorse esistente nel quale risiederà lo spazio dei nomi oppure crearne uno nuovo.In the Resource group field, choose an existing resource group in which the namespace will live, or create a new one.
  7. In Localitàscegliere il paese o l'area in cui deve essere ospitato lo spazio dei nomi.In Location, choose the country or region in which your namespace should be hosted.

    Crea spazio dei nomi

  8. Fare clic su Crea.Click Create. A questo punto, lo spazio dei nomi verrà creato e abilitato nel sistema.The system now creates your namespace and enables it. Potrebbero essere necessari alcuni minuti per consentire al sistema di effettuare il provisioning delle risorse per lo spazio dei nomi creato.You might have to wait several minutes as the system provisions resources for your account.

Ottenere le credenziali di gestioneObtain the management credentials

Con la creazione di un nuovo spazio dei nomi verrà generata automaticamente una regola di firma di accesso condiviso iniziale con una coppia di chiavi primaria e secondaria associata che concede il controllo completo di tutti gli aspetti dello spazio dei nomi.Creating a new namespace will automatically generate an initial Shared Access Signature (SAS) rule with an associated pair of primary and secondary keys that grants full control over all aspects of the namespace. Vedere Autenticazione e autorizzazione del bus di servizio per informazioni su come creare altre regole con diritti più limitati per mittenti e destinatari normali.Refer to Service Bus authentication and authorization for how to create further rules with more constrained rights for regular senders and receivers. Per copiare la regola iniziale seguire questa procedura:To copy the initial rule, follow these steps:

  1. Nell'elenco degli spazi dei nomi fare clic sul nome dello spazio dei nomi appena creato.In the list of namespaces, click the newly created namespace name.
  2. Nel pannello dello spazio dei nomi fare clic su Criteri di accesso condivisi.In the namespace blade, click Shared access policies.
  3. Nel pannello Criteri di accesso condivisi fare clic su RootManageSharedAccessKey.In the Shared access policies blade, click RootManageSharedAccessKey.

    connection-info

  4. Nel pannello Criteri: RootManageSharedAccessKey fare clic sul pulsante Copia accanto a Stringa di connessione - chiave primaria per copiare la stringa di connessione negli Appunti e usarla in un secondo momento.In the Policy: RootManageSharedAccessKey blade, click the copy button next to Connection string–primary key, to copy the connection string to your clipboard for later use. Incollare questo valore nel Blocco note o in un'altra posizione temporanea.Paste this value into Notepad or some other temporary location.

    connection-string

  5. Ripetere il passaggio precedente e copiare e incollare il valore della chiave primaria in un percorso temporaneo per usarlo in seguito.Repeat the previous step, copying and pasting the value of Primary key to a temporary location for later use.

Configurare l'applicazione per l'uso del bus di servizioConfigure your application to use Service Bus

Assicurarsi di aver installato Azure SDK per Java prima di compilare questo esempio.Make sure you have installed the Azure SDK for Java before building this sample. Se si usa Eclipse, è possibile installare Azure Toolkit for Eclipse che include Azure SDK per Java.If you are using Eclipse, you can install the Azure Toolkit for Eclipse that includes the Azure SDK for Java. È quindi possibile aggiungere le librerie di Microsoft Azure per Java al progetto:You can then add the Microsoft Azure Libraries for Java to your project:

Aggiungere le seguenti istruzioni import all'inizio del file Java:Add the following import statements to the top of the Java file:

// Include the following imports to use Service Bus APIs
import com.microsoft.windowsazure.services.servicebus.*;
import com.microsoft.windowsazure.services.servicebus.models.*;
import com.microsoft.windowsazure.core.*;
import javax.xml.datatype.*;

Creare una codaCreate a queue

Per eseguire operazioni di gestione per le code del bus di servizio, è possibile usare la classe ServiceBusContract.Management operations for Service Bus queues can be performed via the ServiceBusContract class. Un oggetto ServiceBusContract è costruito con una configurazione appropriata che incapsula il token di firma di accesso condiviso con le autorizzazioni necessarie a gestirlo. La classe ServiceBusContract rappresenta l'unico punto di comunicazione con Azure.A ServiceBusContract object is constructed with an appropriate configuration that encapsulates the SAS token with permissions to manage it, and the ServiceBusContract class is the sole point of communication with Azure.

La classe ServiceBusService definisce i metodi per creare, enumerare ed eliminare le code.The ServiceBusService class provides methods to create, enumerate, and delete queues. L'esempio seguente illustra come usare un oggetto ServiceBusService per creare una coda denominata TestQueue con uno spazio dei nomi denominato HowToSample:The example below shows how a ServiceBusService object can be used to create a queue named TestQueue, with a namespace named HowToSample:

Configuration config =
    ServiceBusConfiguration.configureWithSASAuthentication(
            "HowToSample",
            "RootManageSharedAccessKey",
            "SAS_key_value",
            ".servicebus.windows.net"
            );

ServiceBusContract service = ServiceBusService.create(config);
QueueInfo queueInfo = new QueueInfo("TestQueue");
try
{
    CreateQueueResult result = service.createQueue(queueInfo);
}
catch (ServiceException e)
{
    System.out.print("ServiceException encountered: ");
    System.out.println(e.getMessage());
    System.exit(-1);
}

In QueueInfo sono disponibili metodi che consentono di ottimizzare le proprietà della coda, ad esempio il valore TTL predefinito da applicare ai messaggi inviati alla coda.There are methods on QueueInfo that allow properties of the queue to be tuned (for example: to set the default time-to-live (TTL) value to be applied to messages sent to the queue). Il seguente esempio illustra come creare una coda denominata TestQueue con una dimensione massima pari a 5 GB:The following example shows how to create a queue named TestQueue with a maximum size of 5GB:

long maxSizeInMegabytes = 5120;
QueueInfo queueInfo = new QueueInfo("TestQueue");
queueInfo.setMaxSizeInMegabytes(maxSizeInMegabytes);
CreateQueueResult result = service.createQueue(queueInfo);

Si noti che è possibile usare il metodo listQueues su oggetti ServiceBusContract per verificare se in uno spazio dei nomi servizio esiste già una coda con il nome specificato.Note that you can use the listQueues method on ServiceBusContract objects to check if a queue with a specified name already exists within a service namespace.

Inviare messaggi a una codaSend messages to a queue

Per inviare un messaggio a una coda del bus di servizio, l'applicazione ottiene un oggetto ServiceBusContract.To send a message to a Service Bus queue, your application obtains a ServiceBusContract object. Il seguente codice illustra come inviare un messaggio per la coda TestQueue creata in precedenza all'interno dello spazio dei nomi HowToSample.The following code shows how to send a message for the TestQueue queue previously created in the HowToSample namespace:

try
{
    BrokeredMessage message = new BrokeredMessage("MyMessage");
    service.sendQueueMessage("TestQueue", message);
}
catch (ServiceException e)
{
    System.out.print("ServiceException encountered: ");
    System.out.println(e.getMessage());
    System.exit(-1);
}

I messaggi inviati e ricevuti dalle code del bus di servizio sono istanze della classe BrokeredMessage.Messages sent to, and received from Service Bus queues are instances of the BrokeredMessage class. Gli oggetti BrokeredMessage includono un insieme di proprietà standard (ad esempio Label e TimeToLive), un dizionario usato per contenere le proprietà personalizzate specifiche dell'applicazione e un corpo di dati arbitrari dell'applicazione.BrokeredMessage objects have a set of standard properties (such as Label and TimeToLive), a dictionary that is used to hold custom application-specific properties, and a body of arbitrary application data. Per impostare il corpo del messaggio, un'applicazione può passare qualsiasi oggetto serializzabile nel costruttore di BrokeredMessage. Per serializzare l'oggetto, verrà usato il serializzatore appropriato.An application can set the body of the message by passing any serializable object into the constructor of the BrokeredMessage, and the appropriate serializer will then be used to serialize the object. In alternativa, è possibile specificare un oggetto java.IO.InputStream.Alternatively, you can provide a java.IO.InputStream object.

L'esempio seguente illustra come inviare cinque messaggi di prova all'oggetto TestQueue MessageSender ottenuto nel frammento di codice precedente:The following example demonstrates how to send five test messages to the TestQueue MessageSender we obtained in the previous code snippet:

for (int i=0; i<5; i++)
{
     // Create message, passing a string message for the body.
     BrokeredMessage message = new BrokeredMessage("Test message " + i);
     // Set an additional app-specific property.
     message.setProperty("MyProperty", i);
     // Send message to the queue
     service.sendQueueMessage("TestQueue", message);
}

Le code del bus di servizio supportano messaggi di dimensioni fino a 256 KB nel livello Standard e fino a 1 MB nel livello Premium.Service Bus queues support a maximum message size of 256 KB in the Standard tier and 1 MB in the Premium tier. Le dimensioni massime dell'intestazione, che include le proprietà standard e personalizzate dell'applicazione, non possono superare 64 KB.The header, which includes the standard and custom application properties, can have a maximum size of 64 KB. Non esiste alcun limite al numero di messaggi mantenuti in una coda, mentre è prevista una limitazione alla dimensione totale dei messaggi di una coda.There is no limit on the number of messages held in a queue but there is a cap on the total size of the messages held by a queue. Questa dimensione della coda viene definita al momento della creazione, con un limite massimo di 5 GB.This queue size is defined at creation time, with an upper limit of 5 GB.

Ricevere messaggi da una codaReceive messages from a queue

Per ricevere i messaggi da una coda si usa principalmente un oggetto ServiceBusContract.The primary way to receive messages from a queue is to use a ServiceBusContract object. I messaggi ricevuti possono essere usati in due modalità diverse: ReceiveAndDelete e PeekLock.Received messages can work in two different modes: ReceiveAndDelete and PeekLock.

Quando si usa la modalità ReceiveAndDelete, l'operazione di ricezione viene eseguita in un'unica fase. Quando infatti il bus di servizio riceve la richiesta di lettura relativa a un messaggio in una coda, lo contrassegna come usato e lo restituisce all'applicazione.When using the ReceiveAndDelete mode, receive is a single-shot operation - that is, when Service Bus receives a read request for a message in a queue, it marks the message as being consumed and returns it to the application. La modalità ReceiveAndDelete predefinita costituisce il modello più semplice ed è adatta per scenari in cui un'applicazione può tollerare la mancata elaborazione di un messaggio in caso di errore.ReceiveAndDelete mode (which is the default mode) is the simplest model and works best for scenarios in which an application can tolerate not processing a message in the event of a failure. Per comprendere meglio questo meccanismo, si consideri uno scenario in cui il consumer invia la richiesta di ricezione e viene arrestato in modo anomalo prima dell'elaborazione.To understand this, consider a scenario in which the consumer issues the receive request and then crashes before processing it. Poiché il bus di servizio contrassegna il messaggio come utilizzato, quando l'applicazione viene riavviata e inizia a utilizzare nuovamente i messaggi, il messaggio utilizzato prima dell'arresto anomalo risulterà perso.Because Service Bus will have marked the message as being consumed, then when the application restarts and begins consuming messages again, it will have missed the message that was consumed prior to the crash.

Nella modalità PeekLock l'operazione di ricezione viene suddivisa in due fasi, in modo da consentire il supporto di applicazioni che non possono tollerare messaggi mancanti.In PeekLock mode, receive becomes a two stage operation, which makes it possible to support applications that cannot tolerate missing messages. Quando il bus di servizio riceve una richiesta, individua il messaggio successivo da usare, lo blocca per impedirne la ricezione da parte di altri consumer e quindi lo restituisce all'applicazione.When Service Bus receives a request, it finds the next message to be consumed, locks it to prevent other consumers receiving it, and then returns it to the application. Dopo aver elaborato il messaggio o averlo archiviato in modo affidabile per successive elaborazioni, l'applicazione esegue la seconda fase del processo di ricezione chiamando Delete sul messaggio ricevuto.After the application finishes processing the message (or stores it reliably for future processing), it completes the second stage of the receive process by calling Delete on the received message. Quando il bus di servizio vede la chiamata Delete, contrassegna il messaggio come usato e lo rimuove dalla coda.When Service Bus sees the Delete call, it will mark the message as being consumed and remove it from the queue.

Nell'esempio seguente viene illustrato come ricevere ed elaborare messaggi usando la modalità PeekLock non predefinita.The following example demonstrates how messages can be received and processed using PeekLock mode (not the default mode). L'esempio seguente crea un ciclo infinito ed elabora i messaggi man mano che arrivano in TestQueue:The example below does an infinite loop and processes messages as they arrive into our TestQueue:

try
{
    ReceiveMessageOptions opts = ReceiveMessageOptions.DEFAULT;
    opts.setReceiveMode(ReceiveMode.PEEK_LOCK);

    while(true)  {
         ReceiveQueueMessageResult resultQM =
                 service.receiveQueueMessage("TestQueue", opts);
        BrokeredMessage message = resultQM.getValue();
        if (message != null && message.getMessageId() != null)
        {
            System.out.println("MessageID: " + message.getMessageId());
            // Display the queue message.
            System.out.print("From queue: ");
            byte[] b = new byte[200];
            String s = null;
            int numRead = message.getBody().read(b);
            while (-1 != numRead)
            {
                s = new String(b);
                s = s.trim();
                System.out.print(s);
                numRead = message.getBody().read(b);
            }
            System.out.println();
            System.out.println("Custom Property: " +
                message.getProperty("MyProperty"));
            // Remove message from queue.
            System.out.println("Deleting this message.");
            //service.deleteMessage(message);
        }  
        else  
        {
            System.out.println("Finishing up - no more messages.");
            break;
            // Added to handle no more messages.
            // Could instead wait for more messages to be added.
        }
    }
}
catch (ServiceException e) {
    System.out.print("ServiceException encountered: ");
    System.out.println(e.getMessage());
    System.exit(-1);
}
catch (Exception e) {
    System.out.print("Generic exception encountered: ");
    System.out.println(e.getMessage());
    System.exit(-1);
}

Come gestire arresti anomali e messaggi illeggibili dell'applicazioneHow to handle application crashes and unreadable messages

Il bus di servizio fornisce funzionalità per il ripristino gestito automaticamente in caso di errori nell'applicazione o di problemi di elaborazione di un messaggio.Service Bus provides functionality to help you gracefully recover from errors in your application or difficulties processing a message. Se un'applicazione ricevitore non è in grado di elaborare il messaggio per un qualsiasi motivo, può chiamare il metodo unlockMessage, anziché deleteMessage, per il messaggio ricevuto.If a receiver application is unable to process the message for some reason, then it can call the unlockMessage method on the received message (instead of the deleteMessage method). In questo modo, il bus di servizio sblocca il messaggio nella coda rendendolo nuovamente disponibile per la ricezione da parte della stessa o di un'altra applicazione consumer.This causes Service Bus to unlock the message within the queue and make it available to be received again, either by the same consuming application or by another consuming application.

Al messaggio bloccato nella coda è inoltre associato un timeout. Se l'applicazione non riesce a elaborare il messaggio prima della scadenza del timeout, ad esempio a causa di un arresto anomalo, il bus di servizio sbloccherà automaticamente il messaggio rendendolo nuovamente disponibile per la ricezione.There is also a timeout associated with a message locked within the queue, and if the application fails to process the message before the lock timeout expires (for example, if the application crashes), then Service Bus unlocks the message automatically and makes it available to be received again.

In caso di arresto anomalo dell'applicazione dopo l'elaborazione del messaggio ma prima dell'invio della richiesta deleteMessage, il messaggio viene nuovamente recapitato all'applicazione al riavvio.In the event that the application crashes after processing the message but before the deleteMessage request is issued, then the message is redelivered to the application when it restarts. Questo processo di elaborazione viene spesso definito di tipo At-Least-Once, per indicare che ogni messaggio verrà elaborato almeno una volta ma che in determinate situazioni potrà essere recapitato una seconda volta.This is often called At Least Once Processing; that is, each message is processed at least once but in certain situations the same message may be redelivered. Se lo scenario non tollera la doppia elaborazione, gli sviluppatori dovranno aggiungere logica aggiuntiva all'applicazione per gestire il secondo recapito del messaggio.If the scenario cannot tolerate duplicate processing, then application developers should add additional logic to their application to handle duplicate message delivery. A tale scopo viene spesso usato il metodo getMessageId del messaggio, che rimane costante in tutti i tentativi di recapito.This is often achieved using the getMessageId method of the message, which remains constant across delivery attempts.

Passaggi successiviNext Steps

A questo punto, dopo aver appreso le nozioni di base delle code del bus di servizio, vedere Code, argomenti e sottoscrizioni del bus di servizio per altre informazioni.Now that you've learned the basics of Service Bus queues, see Queues, topics, and subscriptions for more information.

Per ulteriori informazioni, vedere il Centro per sviluppatori di Java.For more information, see the Java Developer Center.