Recevoir des événements à l’aide de la livraison par tirage (pull) avec Java
Cet article fournit un guide rapide et détaillé pour recevoir des CloudEvents à l’aide de la livraison par tirage (pull) Event Grid. Il fournit un exemple de code à recevoir et reconnaître (supprimer des événements d’Event Grid).
Prérequis
Les conditions préalables qui doivent être établies avant de continuer sont les suivantes :
Comprenez ce qu’est la livraison par tirage (pull). Pour plus d'informations, consultez concepts de livraison par tirage (pull) et vue d’ensemble de la livraison par tirage (pull).
Un espace de noms, une rubrique et un abonnement aux événements.
- Créer et gérer un espace de noms
- Créer et gérer une rubrique d’espaces de noms
- Créer et gérer un abonnement aux événements
Le dernier package du kit de développement logiciel (SDK) en bêta. Si vous utilisez maven, vous pouvez consulter le référentiel central maven.
Important
La prise en charge du kit de développement logiciel (SDK) du plan de données de livraison par tirage (pull) est disponible dans les packages bêta. Vous devez utiliser le dernier package bêta dans votre projet.
Un environnement de développement intégré (IDE, integrated development environment) qui prend en charge Java, comme IntelliJ IDEA, Eclipse IDE ou Visual Studio Code.
Java JRE exécutant le niveau de langage Java 8.
Vous devez disposer d’événements disponibles sur une rubrique. Consultez publier des événements dans des rubriques d’espaces de noms.
Recevoir des événements à l’aide de la livraison par tirage (pull)
Vous lisez des événements à partir d’Event Grid en spécifiant une rubrique d’espaces de noms et un abonnement d’événements de file d’attente avec l'opération de réception. L’abonnement aux événements est la ressource qui définit réellement la collection de CloudEvents qu’un client consommateur peut lire. Cet exemple de code utilise l’authentification basée sur clé, car elle fournit une approche d’authentification rapide et simple. Pour les scénarios de production, vous devez utiliser l’authentification Microsoft Entra ID, car elle fournit un mécanisme d’authentification beaucoup plus solide.
package com.azure.messaging.eventgrid.samples;
import com.azure.core.credential.AzureKeyCredential;
import com.azure.core.http.HttpClient;
import com.azure.core.models.CloudEvent;
import com.azure.messaging.eventgrid.EventGridClient;
import com.azure.messaging.eventgrid.EventGridClientBuilder;
import com.azure.messaging.eventgrid.EventGridMessagingServiceVersion;
import com.azure.messaging.eventgrid.models.*;
import java.time.Duration;
import java.util.ArrayList;
import java.util.List;
/**
* <p>Simple demo consumer app of CloudEvents from queue event subscriptions created for namespace topics.
* This code samples should use Java 1.8 level or above to avoid compilation errors.
* You should consult the resources below to use the client SDK and set up your project using maven.
* @see <a href="https://github.com/Azure/azure-sdk-for-java/tree/main/sdk/eventgrid/azure-messaging-eventgrid">Event Grid data plane client SDK documentation</a>
* @see <a href="https://github.com/Azure/azure-sdk-for-java/blob/main/sdk/boms/azure-sdk-bom/README.md">Azure BOM for client libraries</a>
* @see <a href="https://aka.ms/spring/versions">Spring Version Mapping</a> if you are using Spring.
* @see <a href="https://aka.ms/azsdk">Tool with links to control plane and data plane SDKs across all languages supported</a>.
*</p>
*/
public class NamespaceTopicConsumer {
private static final String TOPIC_NAME = "<yourNamespaceTopicName>";
public static final String EVENT_SUBSCRIPTION_NAME = "<yourEventSusbcriptionName>";
public static final String ENDPOINT = "<yourFullHttpsUrlToTheNamespaceEndpoint>";
public static final int MAX_NUMBER_OF_EVENTS_TO_RECEIVE = 10;
public static final Duration MAX_WAIT_TIME_FOR_EVENTS = Duration.ofSeconds(10);
private static EventGridClient eventGridClient;
private static List<String> receivedCloudEventLockTokens = new ArrayList<>();
private static List<CloudEvent> receivedCloudEvents = new ArrayList<>();
//TODO Do NOT include keys in source code. This code's objective is to give you a succinct sample about using Event Grid, not to provide an authoritative example for handling secrets in applications.
/**
* For security concerns, you should not have keys or any other secret in any part of the application code.
* You should use services like Azure Key Vault for managing your keys.
*/
public static final AzureKeyCredential CREDENTIAL = new AzureKeyCredential("<namespace key>");
public static void main(String[] args) {
//TODO Update Event Grid version number to your desired version. You can find more information on data plane APIs here:
//https://learn.microsoft.com/en-us/rest/api/eventgrid/.
eventGridClient = new EventGridClientBuilder()
.httpClient(HttpClient.createDefault()) // Requires Java 1.8 level
.endpoint(ENDPOINT)
.serviceVersion(EventGridMessagingServiceVersion.V2023_06_01_PREVIEW)
.credential(CREDENTIAL).buildClient(); // you may want to use .buildAsyncClient() for an asynchronous (project reactor) client.
System.out.println("Waiting " + MAX_WAIT_TIME_FOR_EVENTS.toSecondsPart() + " seconds for events to be read...");
List<ReceiveDetails> receiveDetails = eventGridClient.receiveCloudEvents(TOPIC_NAME, EVENT_SUBSCRIPTION_NAME,
MAX_NUMBER_OF_EVENTS_TO_RECEIVE, MAX_WAIT_TIME_FOR_EVENTS).getValue();
for (ReceiveDetails detail : receiveDetails) {
// Add order message received to a tracking list
CloudEvent orderCloudEvent = detail.getEvent();
receivedCloudEvents.add(orderCloudEvent);
// Add lock token to a tracking list. Lock token functions like an identifier to a cloudEvent
BrokerProperties metadataForCloudEventReceived = detail.getBrokerProperties();
String lockToken = metadataForCloudEventReceived.getLockToken();
receivedCloudEventLockTokens.add(lockToken);
}
System.out.println("<-- Number of events received: " + receivedCloudEvents.size());
Reconnaissance des événements
Pour reconnaître les événements, utilisez le même code que celui utilisé pour recevoir des événements et ajoutez les lignes suivantes pour appeler une méthode privée de reconnaissance :
// Acknowledge (i.e. delete from Event Grid the) events
acknowledge(receivedCloudEventLockTokens);
Exemple d’implémentation d’une méthode de reconnaissance ainsi qu’une méthode utilitaire pour imprimer des informations à propos des jetons de verrouillage ayant échoué :
private static void acknowledge(List<String> lockTokens) {
AcknowledgeResult acknowledgeResult = eventGridClient.acknowledgeCloudEvents(TOPIC_NAME, EVENT_SUBSCRIPTION_NAME, new AcknowledgeOptions(lockTokens));
List<String> succeededLockTokens = acknowledgeResult.getSucceededLockTokens();
if (succeededLockTokens != null && lockTokens.size() >= 1)
System.out.println("@@@ " + succeededLockTokens.size() + " events were successfully acknowledged:");
for (String lockToken : succeededLockTokens) {
System.out.println(" Acknowledged event lock token: " + lockToken);
}
// Print the information about failed lock tokens
if (succeededLockTokens.size() < lockTokens.size()) {
System.out.println(" At least one event was not acknowledged (deleted from Event Grid)");
writeFailedLockTokens(acknowledgeResult.getFailedLockTokens());
}
}
private static void writeFailedLockTokens(List<FailedLockToken> failedLockTokens) {
for (FailedLockToken failedLockToken : failedLockTokens) {
System.out.println(" Failed lock token: " + failedLockToken.getLockToken());
System.out.println(" Error code: " + failedLockToken.getErrorCode());
System.out.println(" Error description: " + failedLockToken.getErrorDescription());
}
}
Publier des événements
Publiez des événements afin de les mettre à disposition pour être livrées à nouveau. Comme pour les événements de reconnaissance, vous pouvez ajouter la méthode statique suivante et une ligne pour l’appeler afin de publier des événements identifiés par les lock-tokens passés en tant qu’arguments. Vous avez besoin de la méthode writeFailedLockTokens pour que cette méthode soit compilée.
private static void release(List<String> lockTokens) {
ReleaseResult releaseResult = eventGridClient.releaseCloudEvents(TOPIC_NAME, EVENT_SUBSCRIPTION_NAME, new ReleaseOptions(lockTokens));
List<String> succeededLockTokens = releaseResult.getSucceededLockTokens();
if (succeededLockTokens != null && lockTokens.size() >= 1)
System.out.println("^^^ " + succeededLockTokens.size() + " events were successfully released:");
for (String lockToken : succeededLockTokens) {
System.out.println(" Released event lock token: " + lockToken);
}
// Print the information about failed lock tokens
if (succeededLockTokens.size() < lockTokens.size()) {
System.out.println(" At least one event was not released back to Event Grid.");
writeFailedLockTokens(releaseResult.getFailedLockTokens());
}
}
Rejeter les événements
Refuser les événements que votre application consommatrice ne peut pas traiter. Les conditions selon lesquelles vous refusez un événement incluent un événement malformé qui ne peut pas être analysé ou des problèmes dans l’application qui traite les événements.
private static void reject(List<String> lockTokens) {
RejectResult rejectResult = eventGridClient.rejectCloudEvents(TOPIC_NAME, EVENT_SUBSCRIPTION_NAME, new RejectOptions(lockTokens));
List<String> succeededLockTokens = rejectResult.getSucceededLockTokens();
if (succeededLockTokens != null && lockTokens.size() >= 1)
System.out.println("--- " + succeededLockTokens.size() + " events were successfully rejected:");
for (String lockToken : succeededLockTokens) {
System.out.println(" Rejected event lock token: " + lockToken);
}
// Print the information about failed lock tokens
if (succeededLockTokens.size() < lockTokens.size()) {
System.out.println(" At least one event was not rejected.");
writeFailedLockTokens(rejectResult.getFailedLockTokens());
}
}
Étapes suivantes
- Consultez Informations de référence sur l’API Java.
- Pour en savoir plus sur le modèle de livraison pull, voir Vue d'ensemble de la livraison pull.