你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

EventProcessorClientBuilder 类

参考

包:: com.azure.messaging.eventhubs

Maven 项目:: com.azure:azure-messaging-eventhubs:5.18.4

java.lang.Object
- com.azure.messaging.eventhubs.EventProcessorClientBuilder

实现

AmqpTrait<EventProcessorClientBuilder> AzureNamedKeyCredentialTrait<EventProcessorClientBuilder> AzureSasCredentialTrait<EventProcessorClientBuilder> ConfigurationTrait<EventProcessorClientBuilder> ConnectionStringTrait<EventProcessorClientBuilder> TokenCredentialTrait<EventProcessorClientBuilder>

public class EventProcessorClientBuilder
implements TokenCredentialTrait<EventProcessorClientBuilder>, AzureNamedKeyCredentialTrait<EventProcessorClientBuilder>, ConnectionStringTrait<EventProcessorClientBuilder>, AzureSasCredentialTrait<EventProcessorClientBuilder>, AmqpTrait<EventProcessorClientBuilder>, ConfigurationTrait<EventProcessorClientBuilder>

此类提供 Fluent Builder API 来帮助配置和实例化 EventProcessorClient。调用 buildEventProcessorClient() 构造的新实例 EventProcessorClient。

若要创建的 EventProcessorClient实例， 需要以下字段：

consumerGroup(String consumerGroup).
CheckpointStore - CheckpointStore 的实现，用于存储检查点和分区所有权信息，以实现负载均衡和检查点处理事件。
processEvent(Consumer<EventContext> processEvent) 或 processEventBatch(Consumer<EventBatchContext> processEventBatch, int maxBatchSize, Duration maxWaitTime) - 处理从事件中心接收的事件的回调。
processError(Consumer<ErrorContext> processError) - 处理运行 EventProcessorClient 时可能发生的错误的回调。
针对Azure 事件中心执行操作的凭据。可以使用以下方法之一设置它们：
- connectionString(String connectionString) 与特定事件中心的连接字符串。
- connectionString(String connectionString, String eventHubName) 包含事件中心 命名空间 连接字符串和事件中心名称。
- credential(String fullyQualifiedNamespace, String eventHubName, TokenCredential credential) 具有完全限定的命名空间、事件中心名称和一组授权使用事件中心的凭据。
- credential(TokenCredential credential)、 credential(AzureSasCredential credential)或 credential(AzureNamedKeyCredential credential) 以及 fullyQualifiedNamespace(String fullyQualifiedNamespace) 和 eventHubName(String eventHubName)。使用事件中心的完全限定命名空间、事件中心名称和授权凭据。

本文档中显示的示例使用名为 DefaultAzureCredential 的凭据对象进行身份验证，该对象适用于大多数方案，包括本地开发和生产环境。此外，建议在生产环境中使用托管标识进行身份验证。可以在 Azure 标识文档中找到有关不同身份验证方式及其相应凭据类型的详细信息。

示例：构造 EventProcessorClient

以下代码示例演示如何创建处理器客户端。建议将处理器客户端用于生产方案，因为它可以在多个正在运行的实例之间进行负载均衡，可以执行检查点，并在网络中断等暂时性故障时重新连接。以下示例使用内存CheckpointStore中，但 azure-messaging-eventhubs-checkpointstore-blob 提供由Azure Blob 存储支持的检查点存储。

TokenCredential credential = new DefaultAzureCredentialBuilder().build();

 // "<<fully-qualified-namespace>>" will look similar to "{your-namespace}.servicebus.windows.net"
 // "<<event-hub-name>>" will be the name of the Event Hub instance you created inside the Event Hubs namespace.
 EventProcessorClient eventProcessorClient = new EventProcessorClientBuilder()
     .consumerGroup("<< CONSUMER GROUP NAME >>")
     .credential("<<fully-qualified-namespace>>", "<<event-hub-name>>",
         credential)
     .checkpointStore(new SampleCheckpointStore())
     .processEvent(eventContext -> {
         System.out.printf("Partition id = %s and sequence number of event = %s%n",
             eventContext.getPartitionContext().getPartitionId(),
             eventContext.getEventData().getSequenceNumber());
     })
     .processError(errorContext -> {
         System.out.printf("Error occurred in partition processor for partition %s, %s%n",
             errorContext.getPartitionContext().getPartitionId(),
             errorContext.getThrowable());
     })
     .buildEventProcessorClient();

字段摘要

修饰符和类型	字段和描述
static final Duration	DEFAULT_LOAD_BALANCING_UPDATE_INTERVAL 默认负载均衡更新间隔。
static final Duration	DEFAULT_OWNERSHIP_EXPIRATION_INTERVAL 默认所有权过期。

构造函数摘要

构造函数	说明
EventProcessorClientBuilder()	创建 EventProcessorClientBuilder 的新实例。

方法摘要

修饰符和类型	方法和描述
EventProcessorClient	buildEventProcessorClient() 这将创建一个配置了此生成器中设置的选项的新 EventProcessorClient 。
EventProcessorClientBuilder	checkpointStore(CheckpointStore checkpointStore) CheckpointStore EventProcessorClient设置将用于存储分区所有权和检查点信息的。
EventProcessorClientBuilder	clientOptions(ClientOptions clientOptions) 设置处理器客户端的客户端选项。
EventProcessorClientBuilder	configuration(Configuration configuration) 设置在构造服务客户端期间使用的配置存储。
EventProcessorClientBuilder	connectionString(String connectionString) 为事件中心实例设置给定连接字符串的凭据信息。
EventProcessorClientBuilder	connectionString(String connectionString, String eventHubName) 将给定连接字符串的凭据信息设置为事件中心命名空间，并将名称设置为特定事件中心实例。
EventProcessorClientBuilder	consumerGroup(String consumerGroup) 设置使用者组名称， EventProcessorClient 从中应使用事件。
EventProcessorClientBuilder	credential(AzureNamedKeyCredential credential) 设置要连接到的事件中心实例的凭据信息，以及如何对其授权。
EventProcessorClientBuilder	credential(AzureSasCredential credential) 设置要连接到的事件中心实例的凭据信息，以及如何对其授权。
EventProcessorClientBuilder	credential(TokenCredential credential) TokenCredential设置用于授权发送到服务的请求的。
EventProcessorClientBuilder	credential(String fullyQualifiedNamespace, String eventHubName, AzureNamedKeyCredential credential) 设置要连接到的事件中心实例的凭据信息，以及如何对其授权。
EventProcessorClientBuilder	credential(String fullyQualifiedNamespace, String eventHubName, AzureSasCredential credential) 设置要连接到的事件中心实例的凭据信息，以及如何对其授权。
EventProcessorClientBuilder	credential(String fullyQualifiedNamespace, String eventHubName, TokenCredential credential) 设置要连接到的事件中心实例的凭据信息，以及如何对其授权。
EventProcessorClientBuilder	customEndpointAddress(String customEndpointAddress) 在连接到事件中心服务时设置自定义终结点地址。
EventProcessorClientBuilder	eventHubName(String eventHubName) 设置要将客户端连接到的事件中心的名称。
EventProcessorClientBuilder	fullyQualifiedNamespace(String fullyQualifiedNamespace) 设置事件中心命名空间的完全限定名称。
EventProcessorClientBuilder	initialPartitionEventPosition(Map<String,EventPosition> initialPartitionEventPosition) 设置包含要用于每个分区的事件位置的映射（如果中 CheckpointStore不存在分区的检查点）。
EventProcessorClientBuilder	initialPartitionEventPosition(Function<String,EventPosition> initialEventPositionProvider) 如果中不存在 CheckpointStore该分区的检查点，则设置每个分区的默认起始位置。
EventProcessorClientBuilder	loadBalancingStrategy(LoadBalancingStrategy loadBalancingStrategy) EventProcessorClient将LoadBalancingStrategy用于声明分区所有权。
EventProcessorClientBuilder	loadBalancingUpdateInterval(Duration loadBalancingUpdateInterval) 负载均衡更新周期之间的时间间隔。
EventProcessorClientBuilder	partitionOwnershipExpirationInterval(Duration partitionOwnershipExpirationInterval) 如果拥有的处理器实例未续订分区所有权，则分区的所有权将在该持续时间之后过期。
EventProcessorClientBuilder	prefetchCount(int prefetchCount) 设置接收方用于控制每个使用者在本地主动接收和排队的事件数，而不考虑接收操作当前是否处于活动状态。
EventProcessorClientBuilder	processError(Consumer<ErrorContext> processError) 处理事件时发生错误时调用的函数。
EventProcessorClientBuilder	processEvent(Consumer<EventContext> processEvent) 为此接收 EventProcessorClient的每个事件调用的函数。
EventProcessorClientBuilder	processEvent(Consumer<EventContext> processEvent, Duration maxWaitTime) 为此接收 EventProcessorClient的每个事件调用的函数。
EventProcessorClientBuilder	processEventBatch(Consumer<EventBatchContext> processEventBatch, int maxBatchSize) 为此接收 EventProcessorClient的每个事件调用的函数。
EventProcessorClientBuilder	processEventBatch(Consumer<EventBatchContext> processEventBatch, int maxBatchSize, Duration maxWaitTime) 为此接收 EventProcessorClient的每个事件调用的函数。
EventProcessorClientBuilder	processPartitionClose(Consumer<CloseContext> closePartition) 分区的处理停止时调用的函数。
EventProcessorClientBuilder	processPartitionInitialization(Consumer<InitializationContext> initializePartition) 在开始处理分区之前调用的函数。
EventProcessorClientBuilder	proxyOptions(ProxyOptions proxyOptions) 设置要用于的 EventHubAsyncClient代理配置。
EventProcessorClientBuilder	retry(AmqpRetryOptions retryOptions) 已放弃替换为 retryOptions(AmqpRetryOptions retryOptions)。设置的 EventHubAsyncClient重试策略。
EventProcessorClientBuilder	retryOptions(AmqpRetryOptions retryOptions) 设置的 EventHubAsyncClient重试策略。
EventProcessorClientBuilder	trackLastEnqueuedEventProperties(boolean trackLastEnqueuedEventProperties) 设置事件处理程序是否应请求有关其关联分区上最后一个排队事件的信息，并在接收事件时跟踪该信息。
EventProcessorClientBuilder	transportType(AmqpTransportType transport) 设置与Azure 事件中心的所有通信所依据的传输类型。

方法继承自 java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

字段详细信息

DEFAULT_LOAD_BALANCING_UPDATE_INTERVAL

public static final Duration DEFAULT_LOAD_BALANCING_UPDATE_INTERVAL

默认负载均衡更新间隔。均衡间隔应考虑到客户端与存储帐户之间的延迟。

DEFAULT_OWNERSHIP_EXPIRATION_INTERVAL

public static final Duration DEFAULT_OWNERSHIP_EXPIRATION_INTERVAL

默认所有权过期。

构造函数详细信息