Azure Service Bus 队列

组件格式

要配置 Azure Service Bus 队列的发布/订阅功能，创建一个类型为 pubsub.azure.servicebus.queues 的组件。请参考 发布/订阅代理组件文件 了解 ConsumerID 是如何自动生成的。请阅读 发布和订阅指南 了解如何创建和应用发布/订阅配置。

该组件在 Azure Service Bus 上使用队列；请查看官方文档了解 主题和队列 之间的区别。 若要使用主题，请参阅 Azure Service Bus 主题发布/订阅组件。

连接字符串认证

apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
  name: servicebus-pubsub
spec:
  type: pubsub.azure.servicebus.queues
  version: v1
  metadata:
  # 不使用 Microsoft Entra ID 认证时必需
  - name: connectionString
    value: "Endpoint=sb://{ServiceBusNamespace}.servicebus.windows.net/;SharedAccessKeyName={PolicyName};SharedAccessKey={Key};EntityPath={ServiceBus}"
  # - name: consumerID # 可选
  #   value: channel1
  # - name: timeoutInSec # 可选
  #   value: 60
  # - name: handlerTimeoutInSec # 可选
  #   value: 60
  # - name: disableEntityManagement # 可选
  #   value: "false"
  # - name: maxDeliveryCount # 可选
  #   value: 3
  # - name: lockDurationInSec # 可选
  #   value: 60
  # - name: lockRenewalInSec # 可选
  #   value: 20
  # - name: maxActiveMessages # 可选
  #   value: 10000
  # - name: maxConcurrentHandlers # 可选
  #   value: 10
  # - name: defaultMessageTimeToLiveInSec # 可选
  #   value: 10
  # - name: autoDeleteOnIdleInSec # 可选
  #   value: 3600
  # - name: minConnectionRecoveryInSec # 可选
  #   value: 2
  # - name: maxConnectionRecoveryInSec # 可选
  #   value: 300
  # - name: maxRetriableErrorsPerSec # 可选
  #   value: 10
  # - name: publishMaxRetries # 可选
  #   value: 5
  # - name: publishInitialRetryIntervalInMs # 可选
  #   value: 500

规格元数据字段

Microsoft Entra ID 认证

Azure Service Bus 队列发布/订阅组件支持使用所有 Microsoft Entra ID 机制进行认证，包括托管身份。有关更多信息以及根据选择的 Microsoft Entra ID 认证机制提供的相关组件元数据字段，请参阅 Azure 认证文档。

示例配置

apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
  name: servicebus-pubsub
spec:
  type: pubsub.azure.servicebus.queues
  version: v1
  metadata:
  - name: namespaceName
    # 使用 Azure 认证时必需。
    # 必须是完全限定的域名
    value: "servicebusnamespace.servicebus.windows.net"
  - name: azureTenantId
    value: "***"
  - name: azureClientId
    value: "***"
  - name: azureClientSecret
    value: "***"

消息元数据

Azure Service Bus 消息在 Dapr 消息格式的基础上增加了上下文元数据。一些元数据字段由 Azure Service Bus 本身设置（只读），其他字段可以在发布消息时由客户端设置。

发送带有元数据的消息

要在发送消息时设置 Azure Service Bus 元数据，请在 HTTP 请求或 gRPC 元数据上设置查询参数，如 此处 所述。

• metadata.MessageId
• metadata.CorrelationId
• metadata.SessionId
• metadata.Label
• metadata.ReplyTo
• metadata.PartitionKey
• metadata.To
• metadata.ContentType
• metadata.ScheduledEnqueueTimeUtc
• metadata.ReplyToSessionId

接收带有元数据的消息

当 Dapr 调用您的应用程序时，它使用 HTTP 头或 gRPC 元数据将 Azure Service Bus 消息元数据附加到请求中。 除了 上述可设置的元数据 外，您还可以访问以下只读消息元数据。

• metadata.DeliveryCount
• metadata.LockedUntilUtc
• metadata.LockToken
• metadata.EnqueuedTimeUtc
• metadata.SequenceNumber

要了解这些元数据属性的用途的更多详细信息，请参阅 官方 Azure Service Bus 文档。

此外，原始 Azure Service Bus 消息的所有 ApplicationProperties 条目都作为 metadata.<application property's name> 附加。

发送和接收多条消息

Azure Service Bus 支持使用批量发布/订阅 API 在单个操作中发送和接收多条消息。

配置批量发布

要为批量发布操作设置元数据，请在 HTTP 请求或 gRPC 元数据上设置查询参数，如 此处 所述。

配置批量订阅

订阅主题时，您可以配置 bulkSubscribe 选项。有关更多详细信息，请参阅 批量订阅消息。了解更多关于 批量订阅 API 的信息。

创建 Azure Service Bus 队列代理

按照 此处 的说明设置 Azure Service Bus 队列。

重试策略和死信队列

默认情况下，Azure Service Bus 队列有一个死信队列。消息会根据 maxDeliveryCount 的值进行重试。默认的 maxDeliveryCount 值为 10，但可以设置为最多 2000。这些重试发生得非常迅速，如果没有成功返回，消息将被放入死信队列。

Dapr 发布/订阅提供了自己的死信队列概念，允许您控制重试策略并通过 Dapr 订阅死信队列。

1. 在 Azure Service Bus 命名空间中设置一个单独的队列作为死信队列，并定义一个弹性策略来定义如何重试。
2. 订阅主题以获取失败的消息并处理它们。

例如，在订阅中设置一个死信队列 orders-dlq 和一个弹性策略，允许您订阅主题 orders-dlq 以处理失败的消息。

有关设置死信队列的更多详细信息，请参阅 死信文章。

相关链接

• Dapr 组件的基本架构
• 发布/订阅构建块
• 阅读 本指南 以获取配置发布/订阅组件的说明