Java의 끌어오기 배달을 사용하여 이벤트 수신
이 문서에서는 Event Grid의 끌어오기 배달을 사용하여 CloudEvents를 수신하는 빠른 단계별 가이드를 제공합니다. 수신, 승인(Event Grid에서 이벤트 삭제)을 위한 샘플 코드를 제공합니다.
필수 조건
계속하기 전에 갖춰야 할 필수 조건은 다음과 같습니다.
끌어오기 배달이 무엇인지 이해합니다. 자세한 내용은 끌어오기 배달 개념 및 끌어오기 배달 개요를 참조하세요.
네임스페이스, 토픽 및 이벤트 구독.
최신 베타 SDK 패키지입니다. Maven을 사용하는 경우 Maven 중앙 리포지토리를 참조하세요.
Important
끌어오기 배달 데이터 평면 SDK 지원은 베타 패키지로 제공됩니다. 프로젝트에서는 최신 베타 패키지를 사용해야 합니다.
IntelliJ IDEA, Eclipse IDE 또는 Visual Studio Code와 같은 Java를 지원하는 IDE입니다.
Java 8 언어 수준을 실행하는 Java JRE.
특정 토픽에 대한 이벤트가 있어야 합니다. 네임스페이스 토픽에 대한 이벤트 게시를 참조하세요.
끌어오기 배달을 사용하여 이벤트 수신
수신 작업으로 네임스페이스 토픽과 큐 이벤트 구독을 지정하여 Event Grid에서 이벤트를 읽습니다. 이벤트 구독은 소비자 클라이언트가 읽을 수 있는 CloudEvents 컬렉션을 효과적으로 정의하는 리소스입니다. 이 샘플 코드는 빠르고 간단한 인증 방식을 제공하는 키 기반 인증을 사용합니다. 프로덕션 시나리오의 경우 훨씬 더 강력한 인증 메커니즘을 제공하는 Microsoft Entry ID 인증을 사용해야 합니다.
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 = "<yourEventSubscriptionName>";
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());
이벤트 확인
이벤트를 확인하려면 이벤트 수신에 사용된 것과 동일한 코드를 사용하고 다음 줄을 추가하여 프라이빗 확인 메서드를 호출합니다.
// Acknowledge (i.e. delete from Event Grid the) events
acknowledge(receivedCloudEventLockTokens);
실패한 잠금 토큰에 대한 정보를 인쇄하는 유틸리티 메서드와 함께 승인 메서드의 샘플 구현은 다음과 같습니다.
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());
}
}
릴리스 이벤트
이벤트를 릴리스하여 다시 배달할 수 있도록 합니다. 이벤트 확인을 위해 수행한 작업과 유사하게 다음 정적 메서드와 이를 호출하여 인수로 전달된 잠금 토큰으로 식별되는 이벤트를 해제하는 줄을 추가할 수 있습니다. 이 메서드를 컴파일하려면 writeFailedLockTokens 메서드가 필요합니다.
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());
}
}
이벤트 거부
소비자 애플리케이션이 처리할 수 없는 이벤트를 거부합니다. 이벤트를 거부하는 조건에는 구문 분석할 수 없는 잘못된 형식의 이벤트 또는 이벤트를 처리하는 애플리케이션 관련 문제가 포함됩니다.
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());
}
}
다음 단계
- Java API 참조를 확인합니다.
- 끌어오기 배달 모델에 대해 자세히 알아보려면 끌어오기 배달 개요를 참조하세요.