发布/订阅代理组件规范 on Dapr 文档库

Apache Kafka

Mon, 01 Jan 0001 00:00:00 +0000

组件格式

要设置 Apache Kafka 的发布/订阅功能，您需要创建一个类型为 pubsub.kafka 的组件。请参阅 pub/sub broker 组件文件了解 ConsumerID 是如何自动生成的。阅读如何：发布和订阅指南了解如何创建和应用发布/订阅配置。

所有组件的元数据字段值可以使用模板化的元数据值，这些值会在 Dapr sidecar 启动时解析。例如，您可以选择使用 {namespace} 作为 consumerGroup，以便在不同命名空间中使用相同的 appId 和主题，如本文所述。

apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
 name: kafka-pubsub
spec:
 type: pubsub.kafka
 version: v1
 metadata:
 - name: brokers # 必需字段，Kafka broker 连接设置
 value: "dapr-kafka.myapp.svc.cluster.local:9092"
 - name: consumerGroup # 可选字段，用于输入绑定。
 value: "{namespace}"
 - name: consumerID # 可选字段。如果未提供，运行时将自动创建。
 value: "channel1"
 - name: clientID # 可选字段，用于 Kafka brokers 的客户端跟踪 ID。
 value: "my-dapr-app-id"
 - name: authType # 必需字段。
 value: "password"
 - name: saslUsername # 如果 authType 是 `password`，则必需。
 value: "adminuser"
 - name: saslPassword # 如果 authType 是 `password`，则必需。
 secretKeyRef:
 name: kafka-secrets
 key: saslPasswordSecret
 - name: saslMechanism
 value: "SHA-512"
 - name: maxMessageBytes # 可选字段。
 value: 1024
 - name: consumeRetryInterval # 可选字段。
 value: 200ms
 - name: heartbeatInterval # 可选字段。
 value: 5s
 - name: sessionTimeout # 可选字段。
 value: 15s
 - name: version # 可选字段。
 value: 2.0.0
 - name: disableTls # 可选字段。禁用 TLS。在生产环境中不安全！请阅读 `Mutual TLS` 部分以了解如何使用 TLS。
 value: "true"
 - name: consumerFetchMin # 可选字段。高级设置。请求中要获取的最小消息字节数 - broker 将等待直到至少有这么多可用。
 value: 1
 - name: consumerFetchDefault # 可选字段。高级设置。每个请求中从 broker 获取的默认消息字节数。
 value: 2097152
 - name: channelBufferSize # 可选字段。高级设置。内部和外部通道中要缓冲的事件数量。
 value: 512
 - name: schemaRegistryURL # 可选字段。当使用 Schema Registry Avro 序列化/反序列化时。Schema Registry URL。
 value: http://localhost:8081
 - name: schemaRegistryAPIKey # 可选字段。当使用 Schema Registry Avro 序列化/反序列化时。Schema Registry API Key。
 value: XYAXXAZ
 - name: schemaRegistryAPISecret # 可选字段。当使用 Schema Registry Avro 序列化/反序列化时。Schema Registry 凭证 API Secret。
 value: "ABCDEFGMEADFF"
 - name: schemaCachingEnabled # 可选字段。当使用 Schema Registry Avro 序列化/反序列化时。启用模式缓存。
 value: true
 - name: schemaLatestVersionCacheTTL # 可选字段。当使用 Schema Registry Avro 序列化/反序列化时。发布具有最新模式的消息时的模式缓存 TTL。
 value: 5m
 - name: escapeHeaders # 可选字段。
 value: false

有关使用 secretKeyRef 的详细信息，请参阅如何在组件中引用 secrets 的指南。

AWS SNS/SQS

Mon, 01 Jan 0001 00:00:00 +0000

组件格式

要设置AWS SNS/SQS pub/sub，创建一个类型为pubsub.aws.snssqs的组件。

默认情况下，AWS SNS/SQS组件会：

创建SNS主题
配置SQS队列
设置队列到主题的订阅

注意

如果您只有发布者而没有订阅者，那么只会创建SNS主题。

但是，如果您有订阅者，则会生成SNS、SQS及其动态或静态订阅。

apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
 name: snssqs-pubsub
spec:
 type: pubsub.aws.snssqs
 version: v1
 metadata:
 - name: accessKey
 value: "AKIAIOSFODNN7EXAMPLE"
 - name: secretKey
 value: "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY"
 - name: region
 value: "us-east-1"
 # - name: consumerID # 可选。如果未提供，运行时将创建一个。
 # value: "channel1"
 # - name: endpoint # 可选。
 # value: "http://localhost:4566"
 # - name: sessionToken # 可选（如果使用AssignedRole则必须；例如，临时accessKey和secretKey）
 # value: "TOKEN"
 # - name: messageVisibilityTimeout # 可选
 # value: 10
 # - name: messageRetryLimit # 可选
 # value: 10
 # - name: messageReceiveLimit # 可选
 # value: 10
 # - name: sqsDeadLettersQueueName # 可选
 # - value: "myapp-dlq"
 # - name: messageWaitTimeSeconds # 可选
 # value: 1
 # - name: messageMaxNumber # 可选
 # value: 10
 # - name: fifo # 可选
 # value: "true"
 # - name: fifoMessageGroupID # 可选
 # value: "app1-mgi"
 # - name: disableEntityManagement # 可选
 # value: "false"
 # - name: disableDeleteOnRetryLimit # 可选
 # value: "false"
 # - name: assetsManagementTimeoutSeconds # 可选
 # value: 5
 # - name: concurrencyMode # 可选
 # value: "single"
 # - name: concurrencyLimit # 可选
 # value: "0"

警告

上述示例使用明文字符串作为secret。建议使用secret存储来存储secret。

规格元数据字段

字段	必需	详情	示例
accessKey	Y	具有适当权限的AWS账户/角色的ID，用于SNS和SQS（见下文）	`"AKIAIOSFODNN7EXAMPLE"`
secretKey	Y	AWS用户/角色的secret。如果使用`AssumeRole`访问，还需要提供`sessionToken`	`"wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY"`
region	Y	SNS/SQS资产所在或将创建的AWS区域。请参阅此页面以获取有效区域。确保SNS和SQS在该区域可用	`"us-east-1"`
consumerID	N	消费者ID（消费者标签）将一个或多个消费者组织成一个组。具有相同消费者ID的消费者作为一个虚拟消费者工作；例如，消息仅由组中的一个消费者处理一次。如果未提供`consumerID`，Dapr运行时将其设置为Dapr应用程序ID（`appID`）值。请参阅pub/sub broker组件文件以了解如何自动生成ConsumerID。	可以设置为字符串值（如上例中的`"channel1"`）或字符串格式值（如`"{podName}"`等）。查看您可以在组件元数据中使用的所有模板标签。
endpoint	N	组件使用的AWS端点。仅用于本地开发，例如使用localstack。在生产AWS上运行时不需要`endpoint`	`"http://localhost:4566"`
sessionToken	N	要使用的AWS会话令牌。仅在使用临时安全凭证时需要会话令牌	`"TOKEN"`
messageReceiveLimit	N	消息接收的次数，在处理该消息失败后，一旦达到该次数，将导致从队列中删除该消息。如果指定了`sqsDeadLettersQueueName`，`messageReceiveLimit`是消息接收的次数，在处理该消息失败后，一旦达到该次数，将导致将消息移动到SQS死信队列。默认值：`10`	`10`
sqsDeadLettersQueueName	N	此应用程序的死信队列的名称	`"myapp-dlq"`
messageVisibilityTimeout	N	消息在发送给订阅者后从接收请求中隐藏的时间（以秒为单位）。默认值：`10`	`10`
messageRetryLimit	N	在处理消息失败后重新发送消息的次数，然后从队列中删除该消息。默认值：`10`	`10`
messageWaitTimeSeconds	N	调用等待消息到达队列的持续时间（以秒为单位），然后返回。如果有消息可用，调用会比`messageWaitTimeSeconds`更早返回。如果没有消息可用且等待时间到期，调用会成功返回一个空消息列表。默认值：`1`	`1`
messageMaxNumber	N	一次从队列中接收的最大消息数。默认值：`10`，最大值：`10`	`10`
fifo	N	使用SQS FIFO队列提供消息排序和去重。默认值：`"false"`。有关SQS FIFO的更多详细信息	`"true"`，`"false"`
fifoMessageGroupID	N	如果启用了`fifo`，指示Dapr为pubsub部署使用自定义消息组ID。这不是强制性的，因为Dapr为每个生产者创建一个自定义消息组ID，从而确保每个Dapr生产者的消息排序。默认值：`""`	`"app1-mgi"`
disableEntityManagement	N	当设置为true时，SNS主题、SQS队列和SQS到SNS的订阅不会自动创建。默认值：`"false"`	`"true"`，`"false"`
disableDeleteOnRetryLimit	N	当设置为true时，在重试并失败`messageRetryLimit`次处理消息后，重置消息可见性超时，以便其他消费者可以尝试处理，而不是从SQS中删除消息（默认行为）。默认值：`"false"`	`"true"`，`"false"`
assetsManagementTimeoutSeconds	N	AWS资产管理操作的超时时间（以秒为单位），在超时并取消之前。资产管理操作是对STS、SNS和SQS执行的任何操作，除了实现默认Dapr组件重试行为的消息发布和消费操作。该值可以设置为任何非负浮点数/整数。默认值：`5`	`0.5`，`10`
concurrencyMode	N	当从SQS批量接收消息时，按顺序调用订阅者（一次“单个”消息），或并发调用（“并行”）。默认值：`"parallel"`	`"single"`，`"parallel"`
concurrencyLimit	N	定义处理消息的最大并发工作者数量。当concurrencyMode设置为`"single"`时，此值被忽略。要避免限制并发工作者的数量，请将其设置为`0`。默认值：`0`	`100`

其他信息

符合AWS规范

Dapr创建的SNS主题和SQS队列名称符合AWS规范。默认情况下，Dapr根据消费者app-id创建SQS队列名称，因此Dapr可能会执行名称标准化以符合AWS规范。

Azure Event Hubs

Mon, 01 Jan 0001 00:00:00 +0000

组件格式

要配置 Azure Event Hubs 的发布/订阅功能，请创建一个类型为 pubsub.azure.eventhubs 的组件。有关 ConsumerID 自动生成的详细信息，请参阅 pub/sub broker 组件文件。要了解如何创建和应用 pub/sub 配置，请阅读发布和订阅指南。

除了下文列出的配置元数据字段，Azure Event Hubs 还支持 Azure 身份验证机制。

apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
 name: eventhubs-pubsub
spec:
 type: pubsub.azure.eventhubs
 version: v1
 metadata:
 # connectionString 和 eventHubNamespace 必须二选一
 # 不使用 Microsoft Entra ID 时使用 connectionString
 - name: connectionString
 value: "Endpoint=sb://{EventHubNamespace}.servicebus.windows.net/;SharedAccessKeyName={PolicyName};SharedAccessKey={Key};EntityPath={EventHub}"
 # 使用 Microsoft Entra ID 时使用 eventHubNamespace
 - name: eventHubNamespace
 value: "namespace"
 - name: consumerID # 可选。如果未提供，运行时将使用 Dapr 应用程序 ID (`appID`)。
 value: "channel1"
 - name: enableEntityManagement
 value: "false"
 - name: enableInOrderMessageDelivery
 value: "false"
 # 仅当 enableEntityManagement 设置为 true 时才需要以下四个属性
 - name: resourceGroupName
 value: "test-rg"
 - name: subscriptionID
 value: "Azure 订阅 ID 的值"
 - name: partitionCount
 value: "1"
 - name: messageRetentionInDays
 value: "3"
 # 检查点存储属性
 - name: storageAccountName
 value: "myeventhubstorage"
 - name: storageAccountKey
 value: "112233445566778899"
 - name: storageContainerName
 value: "myeventhubstoragecontainer"
 # 传递 storageAccountKey 的替代方法
 - name: storageConnectionString
 value: "DefaultEndpointsProtocol=https;AccountName=<account>;AccountKey=<account-key>"

注意

上面的示例使用明文字符串作为密钥。建议使用密钥存储来保护密钥，具体方法请参阅这里。

规格元数据字段

字段	必需	详情	示例
`connectionString`	是*	Event Hub 或 Event Hub 命名空间的连接字符串。 * 与 `eventHubNamespace` 字段互斥。 * 不使用 Microsoft Entra ID 身份验证时必需	`"Endpoint=sb://{EventHubNamespace}.servicebus.windows.net/;SharedAccessKeyName={PolicyName};SharedAccessKey={Key};EntityPath={EventHub}"` 或 `"Endpoint=sb://{EventHubNamespace}.servicebus.windows.net/;SharedAccessKeyName={PolicyName};SharedAccessKey={Key}"`
`eventHubNamespace`	是*	Event Hub 命名空间名称。 * 与 `connectionString` 字段互斥。 * 使用 Microsoft Entra ID 身份验证时必需	`"namespace"`
`consumerID`	否	消费者 ID（消费者标签）将一个或多个消费者组织成一个组。具有相同消费者 ID 的消费者作为一个虚拟消费者工作；例如，消息仅由组中的一个消费者处理一次。如果未提供 `consumerID`，Dapr 运行时将其设置为 Dapr 应用程序 ID (`appID`) 值。	可以设置为字符串值（如上例中的 `"channel1"`）或字符串格式值（如 `"{podName}"` 等）。查看可以在组件元数据中使用的所有模板标签。
`enableEntityManagement`	否	布尔值，允许管理 EventHub 命名空间和存储帐户。默认值：`false`	`"true", "false"`
`enableInOrderMessageDelivery`	否	布尔值，允许消息按发布顺序传递。这假设在发布或发布时设置了 `partitionKey` 以确保跨分区的顺序。默认值：`false`	`"true"`, `"false"`
`storageAccountName`	是	用于检查点存储的存储帐户名称。	`"myeventhubstorage"`
`storageAccountKey`	是*	检查点存储帐户的存储帐户密钥。 * 使用 Microsoft Entra ID 时，如果服务主体也有权访问存储帐户，则可以省略此项。	`"112233445566778899"`
`storageConnectionString`	是*	检查点存储的连接字符串，指定 `storageAccountKey` 的替代方法	`"DefaultEndpointsProtocol=https;AccountName=myeventhubstorage;AccountKey=<account-key>"`
`storageContainerName`	是	存储帐户名称的存储容器名称。	`"myeventhubstoragecontainer"`
`resourceGroupName`	否	Event Hub 命名空间所属的资源组名称。启用实体管理时必需	`"test-rg"`
`subscriptionID`	否	Azure 订阅 ID 值。启用实体管理时必需	`"azure subscription id"`
`partitionCount`	否	新 Event Hub 命名空间的分区数。仅在启用实体管理时使用。默认值：`"1"`	`"2"`
`messageRetentionInDays`	否	在新创建的 Event Hub 命名空间中保留消息的天数。仅在启用实体管理时使用。默认值：`"1"`	`"90"`

Microsoft Entra ID 身份验证

Azure Event Hubs pub/sub 组件支持使用所有 Microsoft Entra ID 机制进行身份验证。有关更多信息以及根据选择的 Microsoft Entra ID 身份验证机制提供的相关组件元数据字段，请参阅 Azure 身份验证文档。

Azure Service Bus Topics

Mon, 01 Jan 0001 00:00:00 +0000

组件格式

要配置 Azure Service Bus Topics pub/sub，需创建一个类型为 pubsub.azure.servicebus.topics 的组件。请参考 pub/sub broker 组件文件了解 ConsumerID 的自动生成方式。阅读发布和订阅指南以获取创建和应用 pub/sub 配置的步骤。

此组件使用 Azure Service Bus 的主题功能；请查看官方文档了解主题和队列的区别。
如需使用队列，请参阅 Azure Service Bus Queues pubsub 组件。

连接字符串认证

apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
 name: servicebus-pubsub
spec:
 type: pubsub.azure.servicebus.topics
 version: v1
 metadata:
 # 不使用 Microsoft Entra ID 认证时必需
 - name: connectionString
 value: "Endpoint=sb://{ServiceBusNamespace}.servicebus.windows.net/;SharedAccessKeyName={PolicyName};SharedAccessKey={Key};EntityPath={ServiceBus}"
 # - name: consumerID # 可选：默认为应用程序自身的 ID
 # 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

注意： 上述设置适用于使用此组件的所有主题。

Azure Service Bus 队列

Mon, 01 Jan 0001 00:00:00 +0000

组件格式

要配置 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

警告

上述示例使用明文字符串作为密钥。建议使用密钥存储来存储密钥，如此处所述。

规格元数据字段

字段	必需	详情	示例
`connectionString`	Y	Service Bus 的共享访问策略连接字符串。除非使用 Microsoft Entra ID 认证，否则必需。	见上例
`consumerID`	N	消费者 ID（消费者标签）将一个或多个消费者组织成一个组。具有相同消费者 ID 的消费者作为一个虚拟消费者工作；例如，消息仅由组中的一个消费者处理一次。如果未提供 `consumerID`，Dapr 运行时将其设置为 Dapr 应用程序 ID (`appID`) 值。	可以设置为字符串值（如上例中的 `"channel1"`）或字符串格式值（如 `"{podName}"` 等）。查看您可以在组件元数据中使用的所有模板标签。
`namespaceName`	N	设置 Service Bus 命名空间地址的参数，作为完全限定的域名。使用 Microsoft Entra ID 认证时必需。	`"namespace.servicebus.windows.net"`
`timeoutInSec`	N	发送消息和管理操作的超时时间。默认：`60`	`30`
`handlerTimeoutInSec`	N	调用应用程序处理程序的超时时间。默认：`60`	`30`
`lockRenewalInSec`	N	定义缓冲消息锁将被续订的频率。默认：`20`。	`20`
`maxActiveMessages`	N	定义一次处理或缓冲的最大消息数。此值应至少与最大并发处理程序一样大。默认：`1000`	`2000`
`maxConcurrentHandlers`	N	定义最大并发消息处理程序数。默认：`0`（无限制）	`10`
`disableEntityManagement`	N	设置为 true 时，队列和订阅不会自动创建。默认：`"false"`	`"true"`，`"false"`
`defaultMessageTimeToLiveInSec`	N	默认消息生存时间，以秒为单位。仅在订阅创建期间使用。	`10`
`autoDeleteOnIdleInSec`	N	在自动删除空闲订阅之前等待的时间，以秒为单位。仅在订阅创建期间使用。必须为 300 秒或更长。默认：`0`（禁用）	`3600`
`maxDeliveryCount`	N	定义服务器尝试传递消息的次数。仅在订阅创建期间使用。服务器默认设置。	`10`
`lockDurationInSec`	N	定义消息在过期前被锁定的时间长度，以秒为单位。仅在订阅创建期间使用。服务器默认设置。	`30`
`minConnectionRecoveryInSec`	N	在连接失败的情况下，尝试重新连接到 Azure Service Bus 之前等待的最小间隔（以秒为单位）。默认：`2`	`5`
`maxConnectionRecoveryInSec`	N	在连接失败的情况下，尝试重新连接到 Azure Service Bus 之前等待的最大间隔（以秒为单位）。每次尝试后，组件在最小和最大之间等待一个随机秒数，每次增加。默认：`300`（5 分钟）	`600`
`maxRetriableErrorsPerSec`	N	每秒处理的最大可重试错误数。如果消息处理失败并出现可重试错误，组件会在开始处理另一条消息之前添加延迟，以避免立即重新处理失败的消息。默认：`10`	`10`
`publishMaxRetries`	N	当 Azure Service Bus 响应“过于繁忙”以限制消息时的最大重试次数。默认：`5`	`5`
`publishInitialRetryIntervalInMs`	N	当 Azure Service Bus 限制消息时，初始指数回退的时间（以毫秒为单位）。默认：`500`	`500`

Microsoft Entra ID 认证

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

GCP

Mon, 01 Jan 0001 00:00:00 +0000

创建 Dapr 组件

要配置 GCP pub/sub，需创建一个类型为 pubsub.gcp.pubsub 的组件。参考 pub/sub broker 组件文件了解 ConsumerID 的自动生成方式。查看发布和订阅指南了解如何创建和应用 pub/sub 配置。

apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
 name: gcp-pubsub
spec:
 type: pubsub.gcp.pubsub
 version: v1
 metadata:
 - name: type
 value: service_account
 - name: projectId
 value: <PROJECT_ID> # 替换
 - name: endpoint # 可选
 value: "http://localhost:8085"
 - name: consumerID # 可选 - 默认为应用程序自身的 ID
 value: <CONSUMER_ID>
 - name: identityProjectId
 value: <IDENTITY_PROJECT_ID> # 替换
 - name: privateKeyId
 value: <PRIVATE_KEY_ID> # 替换
 - name: clientEmail
 value: <CLIENT_EMAIL> # 替换
 - name: clientId
 value: <CLIENT_ID> # 替换
 - name: authUri
 value: https://accounts.google.com/o/oauth2/auth
 - name: tokenUri
 value: https://oauth2.googleapis.com/token
 - name: authProviderX509CertUrl
 value: https://www.googleapis.com/oauth2/v1/certs
 - name: clientX509CertUrl
 value: https://www.googleapis.com/robot/v1/metadata/x509/<PROJECT_NAME>.iam.gserviceaccount.com # 替换 PROJECT_NAME
 - name: privateKey
 value: <PRIVATE_KEY> # 替换 x509 证书
 - name: disableEntityManagement
 value: "false"
 - name: enableMessageOrdering
 value: "false"
 - name: orderingKey # 可选
 value: <ORDERING_KEY>
 - name: maxReconnectionAttempts # 可选
 value: 30
 - name: connectionRecoveryInSec # 可选
 value: 2
 - name: deadLetterTopic # 可选
 value: <EXISTING_PUBSUB_TOPIC>
 - name: maxDeliveryAttempts # 可选
 value: 5
 - name: maxOutstandingMessages # 可选
 value: 1000
 - name: maxOutstandingBytes # 可选
 value: 1000000000
 - name: maxConcurrentConnections # 可选
 value: 10

警告

上述示例中，secret 以明文字符串形式使用。建议使用 secret 存储来存储 secret，具体方法请参考这里。

规格元数据字段

字段	必需	详情	示例
projectId	Y	GCP 项目 ID	`myproject-123`
endpoint	N	组件使用的 GCP 端点。仅用于本地开发（例如）与 GCP Pub/Sub Emulator 一起使用。运行 GCP 生产 API 时不需要 `endpoint`。	`"http://localhost:8085"`
`consumerID`	N	Consumer ID 将一个或多个消费者组织成一个组。具有相同 consumer ID 的消费者作为一个虚拟消费者工作；例如，消息仅由组中的一个消费者处理一次。如果未提供 `consumerID`，Dapr 运行时将其设置为 Dapr 应用程序 ID (`appID`) 值。`consumerID` 与请求中提供的 `topic` 一起用于构建 Pub/Sub 订阅 ID	可以设置为字符串值（例如 `"channel1"`）或字符串格式值（例如 `"{podName}"` 等）。查看可以在组件元数据中使用的所有模板标签。
identityProjectId	N	如果 GCP pubsub 项目与身份项目不同，使用此属性指定身份项目	`"myproject-123"`
privateKeyId	N	如果使用显式凭据，此字段应包含服务账户 JSON 文档中的 `private_key_id` 字段	`"my-private-key"`
privateKey	N	如果使用显式凭据，此字段应包含服务账户 JSON 中的 `private_key` 字段	`-----BEGIN PRIVATE KEY-----MIIBVgIBADANBgkqhkiG9w0B`
clientEmail	N	如果使用显式凭据，此字段应包含服务账户 JSON 中的 `client_email` 字段	`"myservice@myproject-123.iam.gserviceaccount.com"`
clientId	N	如果使用显式凭据，此字段应包含服务账户 JSON 中的 `client_id` 字段	`106234234234`
authUri	N	如果使用显式凭据，此字段应包含服务账户 JSON 中的 `auth_uri` 字段	`https://accounts.google.com/o/oauth2/auth`
tokenUri	N	如果使用显式凭据，此字段应包含服务账户 JSON 中的 `token_uri` 字段	`https://oauth2.googleapis.com/token`
authProviderX509CertUrl	N	如果使用显式凭据，此字段应包含服务账户 JSON 中的 `auth_provider_x509_cert_url` 字段	`https://www.googleapis.com/oauth2/v1/certs`
clientX509CertUrl	N	如果使用显式凭据，此字段应包含服务账户 JSON 中的 `client_x509_cert_url` 字段	`https://www.googleapis.com/robot/v1/metadata/x509/myserviceaccount%40myproject.iam.gserviceaccount.com`
disableEntityManagement	N	设置为 `"true"` 时，主题和订阅不会自动创建。默认值：`"false"`	`"true"`，`"false"`
enableMessageOrdering	N	设置为 `"true"` 时，订阅的消息将按顺序接收，具体取决于发布和权限配置。	`"true"`，`"false"`
orderingKey	N	请求中提供的键。当 `enableMessageOrdering` 设置为 `true` 时，用于根据该键对消息进行排序。	“my-orderingkey”
maxReconnectionAttempts	N	定义最大重连尝试次数。默认值：`30`	`30`
connectionRecoveryInSec	N	连接恢复尝试之间的等待时间（以秒为单位）。默认值：`2`	`2`
deadLetterTopic	N	GCP Pub/Sub 主题的名称。此主题在使用此组件之前必须存在。	`"myapp-dlq"`
maxDeliveryAttempts	N	消息传递的最大尝试次数。如果指定了 `deadLetterTopic`，`maxDeliveryAttempts` 是消息处理失败的最大尝试次数。一旦达到该次数，消息将被移至死信主题。默认值：`5`	`5`
type	N	已弃用 GCP 凭据类型。仅支持 `service_account`。默认为 `service_account`	`service_account`
maxOutstandingMessages	N	给定 streaming-pull 连接可以拥有的最大未完成消息数。默认值：`1000`	`50`
maxOutstandingBytes	N	给定 streaming-pull 连接可以拥有的最大未完成字节数。默认值：`1000000000`	`1000000000`
maxConcurrentConnections	N	要维护的最大并发 streaming-pull 连接数。默认值：`10`	`2`
ackDeadline	N	消息确认持续时间截止时间。默认值：`20s`	`1m`

警告

如果 enableMessageOrdering 设置为 “true”，则需要在服务账户上授予 roles/viewer 或 roles/pubsub.viewer 角色，以确保在消息中未嵌入顺序令牌的情况下保证顺序。如果未授予此角色，或调用 Subscription.Config() 失败的任何其他原因，嵌入顺序令牌的排序仍将正常工作。

GCP 凭据

由于 GCP Pub/Sub 组件使用 GCP Go 客户端库，默认情况下它使用 应用程序默认凭据 进行身份验证。这在使用客户端库对 GCP 云服务进行身份验证指南中有进一步解释。

JetStream

Mon, 01 Jan 0001 00:00:00 +0000

组件格式

要配置 JetStream 的发布/订阅功能，需要创建一个类型为 pubsub.jetstream 的组件。请参考 pubsub broker 组件文件以了解 ConsumerID 的自动生成方式。阅读发布和订阅指南以获取创建和应用 pubsub 配置的步骤。

apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
 name: jetstream-pubsub
spec:
 type: pubsub.jetstream
 version: v1
 metadata:
 - name: natsURL
 value: "nats://localhost:4222"
 - name: jwt # 可选。用于分布式 JWT 认证。
 value: "eyJhbGciOiJ...6yJV_adQssw5c"
 - name: seedKey # 可选。用于分布式 JWT 认证。
 value: "SUACS34K232O...5Z3POU7BNIL4Y"
 - name: tls_client_cert # 可选。用于 TLS 客户端认证。
 value: "/path/to/tls.crt"
 - name: tls_client_key # 可选。用于 TLS 客户端认证。
 value: "/path/to/tls.key"
 - name: token # 可选。用于基于令牌的认证。
 value: "my-token"
 - name: name
 value: "my-conn-name"
 - name: streamName
 value: "my-stream"
 - name: durableName 
 value: "my-durable-subscription"
 - name: queueGroupName
 value: "my-queue-group"
 - name: startSequence
 value: 1
 - name: startTime # Unix 时间戳格式
 value: 1630349391
 - name: flowControl
 value: false
 - name: ackWait
 value: 10s
 - name: maxDeliver
 value: 5
 - name: backOff
 value: "50ms, 1s, 10s"
 - name: maxAckPending
 value: 5000
 - name: replicas
 value: 1
 - name: memoryStorage
 value: false
 - name: rateLimit
 value: 1024
 - name: heartbeat
 value: 15s
 - name: ackPolicy
 value: explicit
 - name: deliverPolicy
 value: all
 - name: domain
 value: hub
 - name: apiPrefix
 value: PREFIX

规格元数据字段

字段	必需	详情	示例
natsURL	是	NATS 服务器地址 URL	`"nats://localhost:4222"`
jwt	否	NATS 分布式认证 JWT	`"eyJhbGciOiJ...6yJV_adQssw5c"`
seedKey	否	NATS 分布式认证种子密钥	`"SUACS34K232O...5Z3POU7BNIL4Y"`
tls_client_cert	否	NATS TLS 客户端认证证书	`"/path/to/tls.crt"`
tls_client_key	否	NATS TLS 客户端认证密钥	`"/path/to/tls.key"`
token	否	NATS 基于令牌的认证	`"my-token"`
name	否	NATS 连接名称	`"my-conn-name"`
streamName	否	要绑定的 JetStream 流名称	`"my-stream"`
durableName	否	持久名称	`"my-durable"`
queueGroupName	否	队列组名称	`"my-queue"`
startSequence	否	开始序列	`1`
startTime	否	开始时间，Unix 时间戳格式	`1630349391`
flowControl	否	流量控制	`true`
ackWait	否	确认等待	`10s`
maxDeliver	否	最大投递次数	`15`
backOff	否	退避	`"50ms, 1s, 5s, 10s"`
maxAckPending	否	最大确认待处理	`5000`
replicas	否	副本	`3`
memoryStorage	否	内存存储	`false`
rateLimit	否	速率限制	`1024`
heartbeat	否	心跳	`10s`
ackPolicy	否	确认策略	`explicit`
deliverPolicy	否	其中之一：all, last, new, sequence, time	`all`
domain	否	JetStream Leafonodes	`HUB`
apiPrefix	否	[JetStream Leafnodes]	`PREFIX`

创建 NATS 服务器

您可以使用 Docker 在本地运行启用 JetStream 的 NATS 服务器：

KubeMQ

Mon, 01 Jan 0001 00:00:00 +0000

组件格式

要配置 KubeMQ pub/sub，需创建一个类型为 pubsub.kubemq 的组件。请参阅 pub/sub broker 组件文件了解 ConsumerID 是如何自动生成的。阅读如何发布和订阅指南以了解如何创建和应用 pub/sub 配置。

apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
 name: kubemq-pubsub
spec:
 type: pubsub.kubemq
 version: v1
 metadata:
 - name: address
 value: localhost:50000
 - name: store
 value: false
 - name: consumerID
 value: channel1

规格元数据字段

字段	必需	详情	示例
address	Y	KubeMQ 服务器的地址	`"localhost:50000"`
store	N	pubsub 类型，true: pubsub 持久化 (EventsStore)，false: pubsub 内存中 (Events)	`true` 或 `false` (默认是 `false`)
consumerID	N	消费者 ID（消费者标签）用于将一个或多个消费者组织成一个组。具有相同消费者 ID 的消费者作为一个虚拟消费者工作；例如，消息仅由组中的一个消费者处理一次。如果未提供 `consumerID`，Dapr 运行时将其设置为 Dapr 应用程序 ID (`appID`) 值。	可以设置为字符串值（如上例中的 `"channel1"`）或字符串格式值（如 `"{podName}"` 等）。查看可以在组件元数据中使用的所有模板标签。
clientID	N	客户端 ID 连接的名称	`sub-client-12345`
authToken	N	连接的 Auth JWT 令牌查看 KubeMQ 认证	`ew...`
group	N	用于负载均衡的订阅者组	`g1`
disableReDelivery	N	设置是否在应用程序出错时重新传递消息	`true` 或 `false` (默认是 `false`)

创建 KubeMQ broker

获取 KubeMQ 密钥。
等待电子邮件确认您的密钥

您可以使用 Docker 运行 KubeMQ broker：

MQTT

Mon, 01 Jan 0001 00:00:00 +0000

组件格式

要配置MQTT pub/sub，您需要创建一个类型为pubsub.mqtt的组件。请参阅pub/sub broker组件文件以了解ConsumerID的自动生成方式。阅读操作指南：发布和订阅指南以了解如何创建和应用pub/sub配置。

apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
 name: mqtt-pubsub
spec:
 type: pubsub.mqtt
 version: v1
 metadata:
 - name: url
 value: "tcp://[username][:password]@host.domain[:port]"
 - name: qos
 value: 1
 - name: retain
 value: "false"
 - name: cleanSession
 value: "false"
 - name: consumerID
 value: "channel1"

警告

上述示例中使用了明文字符串作为密钥。建议使用密钥存储来保护密钥，详情请参阅这里。

规格元数据字段

字段	必需	详情	示例
url	Y	MQTT broker的地址。可以使用`secretKeyRef`来引用密钥。对于非TLS通信，使用`tcp://` URI方案。对于TLS通信，使用`ssl://` URI方案。	`"tcp://[username][:password]@host.domain[:port]"`
consumerID	N	用于连接到MQTT broker的消费者连接的客户端ID。默认为Dapr应用ID。注意：如果未设置`producerID`，则在此值后附加`-consumer`用于消费者连接	可以设置为字符串值（如上例中的`"channel1"`）或字符串格式值（如`"{podName}"`等）。查看可以在组件元数据中使用的所有模板标签。
producerID	N	用于连接到MQTT broker的生产者连接的客户端ID。默认为`{consumerID}-producer`。	`"myMqttProducerApp"`
qos	N	表示消息的服务质量级别（QoS）（更多信息）。默认为`1`。	`0`, `1`, `2`
retain	N	定义broker是否将消息保存为指定主题的最后已知良好值。默认为`"false"`。	`"true"`, `"false"`
cleanSession	N	如果为`"true"`，则在连接消息中设置`clean_session`标志到MQTT broker（更多信息）。默认为`"false"`。	`"true"`, `"false"`
caCert	使用TLS时必需	用于验证服务器TLS证书的证书颁发机构（CA）证书，格式为PEM。	`"-----BEGIN CERTIFICATE-----\n<base64-encoded DER>\n-----END CERTIFICATE-----"`
clientCert	使用TLS时必需	TLS客户端证书，格式为PEM。必须与`clientKey`一起使用。	`"-----BEGIN CERTIFICATE-----\n<base64-encoded DER>\n-----END CERTIFICATE-----"`
clientKey	使用TLS时必需	TLS客户端密钥，格式为PEM。必须与`clientCert`一起使用。可以使用`secretKeyRef`来引用密钥。	`"-----BEGIN RSA PRIVATE KEY-----\n<base64-encoded PKCS8>\n-----END RSA PRIVATE KEY-----"`

启用消息传递重试

MQTT pub/sub组件不支持内置的重试策略。这意味着sidecar只会向服务发送一次消息。如果服务标记消息为未处理，则消息不会被确认回broker。只有当broker重新发送消息时，才会重试。

MQTT3

Mon, 01 Jan 0001 00:00:00 +0000

组件格式

要配置一个MQTT3发布/订阅组件，请创建一个类型为pubsub.mqtt3的组件。请参阅发布/订阅代理组件文件以了解如何自动生成ConsumerID。阅读操作指南：发布和订阅指南以了解如何创建和应用发布/订阅配置。

apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
 name: mqtt-pubsub
spec:
 type: pubsub.mqtt3
 version: v1
 metadata:
 - name: url
 value: "tcp://[username][:password]@host.domain[:port]"
 # 可选
 - name: retain
 value: "false"
 - name: cleanSession
 value: "false"
 - name: qos
 value: "1"
 - name: consumerID
 value: "channel1"

警告

上述示例中使用了明文字符串作为密钥。建议使用密钥存储来管理密钥，如此处所述。

规格元数据字段

字段	必需	详情	示例
`url`	Y	MQTT broker的地址。可以使用`secretKeyRef`来引用密钥。对于非TLS通信，使用`tcp://` URI方案。对于TLS通信，使用`ssl://` URI方案。	`"tcp://[username][:password]@host.domain[:port]"`
`consumerID`	N	用于连接到MQTT broker的客户端ID。默认为Dapr应用ID。	可以设置为字符串值（如上例中的`"channel1"`）或字符串格式值（如`"{podName}"`等）。查看您可以在组件元数据中使用的所有模板标签。
`retain`	N	定义消息是否由broker保存为指定主题的最后已知良好值。默认为`"false"`。	`"true"`，`"false"`
`cleanSession`	N	如果为`"true"`，则在连接消息中设置`clean_session`标志到MQTT broker（更多信息）。默认为`"false"`。	`"true"`，`"false"`
`caCert`	使用TLS时必需	用于验证服务器TLS证书的PEM格式的证书颁发机构（CA）证书。	参见下面的示例
`clientCert`	使用TLS时必需	PEM格式的TLS客户端证书。必须与`clientKey`一起使用。	参见下面的示例
`clientKey`	使用TLS时必需	PEM格式的TLS客户端密钥。必须与`clientCert`一起使用。可以使用`secretKeyRef`来引用密钥。	参见下面的示例
`qos`	N	表示消息的服务质量级别（QoS）（更多信息）。默认为`1`。	`0`，`1`，`2`

使用TLS进行通信

要配置使用TLS进行通信，请确保MQTT broker（例如emqx）配置为支持证书，并在组件配置中提供caCert，clientCert，clientKey元数据。例如：

Pulsar

Mon, 01 Jan 0001 00:00:00 +0000

组件格式

要配置 Apache Pulsar 的发布/订阅(pub/sub)功能，需要创建一个类型为 pubsub.pulsar 的组件。请参阅 pub/sub broker 组件文件以了解 ConsumerID 的自动生成方式。阅读操作指南：发布和订阅以了解如何创建和应用 pub/sub 配置。

有关 Apache Pulsar 的更多信息，请阅读官方文档。

apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
 name: pulsar-pubsub
spec:
 type: pubsub.pulsar
 version: v1
 metadata:
 - name: host
 value: "localhost:6650"
 - name: enableTLS
 value: "false"
 - name: tenant
 value: "public"
 - name: token
 value: "eyJrZXlJZCI6InB1bHNhci1wajU0cXd3ZHB6NGIiLCJhbGciOiJIUzI1NiJ9.eyJzd"
 - name: consumerID
 value: "channel1"
 - name: namespace
 value: "default"
 - name: persistent
 value: "true"
 - name: disableBatching
 value: "false"
 - name: receiverQueueSize
 value: "1000"
 - name: <topic-name>.jsonschema # 为配置的主题设置 JSON schema 验证
 value: |
 {
 "type": "record",
 "name": "Example",
 "namespace": "test",
 "fields": [
 {"name": "ID","type": "int"},
 {"name": "Name","type": "string"}
 ]
 }
 - name: <topic-name>.avroschema # 为配置的主题设置 Avro schema 验证
 value: |
 {
 "type": "record",
 "name": "Example",
 "namespace": "test",
 "fields": [
 {"name": "ID","type": "int"},
 {"name": "Name","type": "string"}
 ]
 }

警告

上面的示例使用了明文字符串作为 secret。建议使用 secret 存储来存储 secret。此组件支持将 token 参数和其他敏感数据存储为 Kubernetes Secrets。

规格元数据字段

字段	必需	详情	示例
host	Y	Pulsar broker 的地址。默认值为 `"localhost:6650"`	`"localhost:6650"` 或 `"http://pulsar-pj54qwwdpz4b-pulsar.ap-sg.public.pulsar.com:8080"`
enableTLS	N	是否启用 TLS。默认值: `"false"`	`"true"`, `"false"`
tenant	N	主题的租户。租户是 Pulsar 多租户的关键，并跨集群分布。默认值: `"public"`	`"public"`
consumerID	N	用于设置订阅名称或消费者 ID。	可以设置为字符串值（如上例中的 `"channel1"`）或字符串格式值（如 `"{podName}"` 等）。查看可以在组件元数据中使用的所有模板标签。
namespace	N	主题的管理单元，作为相关主题的分组机制。默认值: `"default"`	`"default"`
persistent	N	Pulsar 支持两种类型的主题：持久化和非持久化。持久化主题的所有消息都存储在磁盘上，而非持久化主题的数据不会存储到磁盘。
disableBatching	N	是否禁用批处理。启用批处理时，默认批处理延迟为 10 毫秒，默认批处理大小为 1000 条消息，设置 `disableBatching: true` 将使生产者单独发送消息。默认值: `"false"`	`"true"`, `"false"`
receiverQueueSize	N	设置消费者接收队列的大小。控制消费者在被 Dapr 显式调用读取消息之前可以累积多少消息。默认值: `"1000"`	`"1000"`
batchingMaxPublishDelay	N	设置消息发送的批处理时间段（如果启用了批处理消息）。如果设置为非零值，消息将排队直到此时间间隔或 batchingMaxMessages（见下文）或 batchingMaxSize（见下文）。有两种有效格式，一种是带单位后缀的分数格式，另一种是纯数字格式，处理为毫秒。有效的时间单位有 “ns”, “us” (或 “µs”), “ms”, “s”, “m”, “h”。默认值: `"10ms"`	`"10ms"`, `"10"`
batchingMaxMessages	N	设置批处理中允许的最大消息数。如果设置为大于 1 的值，消息将排队直到达到此阈值或 batchingMaxSize（见下文）或批处理间隔已过。默认值: `"1000"`	`"1000"`
batchingMaxSize	N	设置批处理中允许的最大字节数。如果设置为大于 1 的值，消息将排队直到达到此阈值或 batchingMaxMessages（见上文）或批处理间隔已过。默认值: `"128KB"`	`"131072"`
.jsonschema	N	为配置的主题强制执行 JSON schema 验证。
.avroschema	N	为配置的主题强制执行 Avro schema 验证。
publicKey	N	用于发布者和消费者加密的公钥。值可以是两种选项之一：本地 PEM 证书的文件路径，或证书数据字符串值
privateKey	N	用于消费者加密的私钥。值可以是两种选项之一：本地 PEM 证书的文件路径，或证书数据字符串值
keys	N	包含 Pulsar 会话密钥名称的逗号分隔字符串。与 `publicKey` 一起用于发布者加密
processMode	N	是否支持同时处理多条消息。默认值: `"async"`	`"async"`, `"sync"`
subscribeType	N	Pulsar 支持四种订阅类型。默认值: `"shared"`	`"shared"`, `"exclusive"`, `"failover"`, `"key_shared"`
partitionKey	N	设置消息的路由策略键。默认值: `""`
`maxConcurrentHandlers`	N	定义并发消息处理程序的最大数量。默认值: `100`	`10`

使用 Token 进行身份验证

要使用静态 JWT token 进行 Pulsar 身份验证，可以使用以下元数据字段：

RabbitMQ

Mon, 01 Jan 0001 00:00:00 +0000

组件格式

要设置 RabbitMQ 的发布/订阅功能，请创建一个类型为 pubsub.rabbitmq 的组件。请参阅 pub/sub broker 组件文件以了解消费者ID（ConsumerID）是如何自动生成的。阅读 How-to: 发布和订阅指南以了解如何创建和应用 pub/sub 配置。

apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
 name: rabbitmq-pubsub
spec:
 type: pubsub.rabbitmq
 version: v1
 metadata:
 - name: connectionString
 value: "amqp://localhost:5672"
 - name: protocol
 value: amqp 
 - name: hostname
 value: localhost 
 - name: username
 value: username
 - name: password
 value: password 
 - name: consumerID
 value: channel1
 - name: durable
 value: false
 - name: deletedWhenUnused
 value: false
 - name: autoAck
 value: false
 - name: deliveryMode
 value: 0
 - name: requeueInFailure
 value: false
 - name: prefetchCount
 value: 0
 - name: reconnectWait
 value: 0
 - name: concurrencyMode
 value: parallel
 - name: publisherConfirm
 value: false
 - name: enableDeadLetter # 可选，是否启用死信
 value: true
 - name: maxLen # 可选，队列中的最大消息数
 value: 3000
 - name: maxLenBytes # 可选，队列的最大字节长度
 value: 10485760
 - name: exchangeKind
 value: fanout
 - name: saslExternal
 value: false
 - name: ttlInSeconds
 value: 60
 - name: clientName
 value: {podName}
 - name: heartBeat
 value: 10s

警告

上述示例使用明文字符串作为 secrets。建议使用 secret 存储来存储 secrets，如此处所述。

规格元数据字段

字段	必需	详情	示例
connectionString	Y*	RabbitMQ 连接字符串。*与 protocol、hostname、username、password 字段互斥	`amqp://user:pass@localhost:5672`
protocol	N*	RabbitMQ 协议。*与 connectionString 字段互斥	`amqp`
hostname	N*	RabbitMQ 主机名。*与 connectionString 字段互斥	`localhost`
username	N*	RabbitMQ 用户名。*与 connectionString 字段互斥	`username`
password	N*	RabbitMQ 密码。*与 connectionString 字段互斥	`password`
consumerID	N	消费者 ID（消费者标签）将一个或多个消费者组织成一个组。具有相同消费者 ID 的消费者作为一个虚拟消费者工作；例如，消息仅由组中的一个消费者处理一次。如果未提供 `consumerID`，Dapr 运行时会将其设置为 Dapr 应用程序 ID (`appID`) 的值。	可以设置为字符串值（如上例中的 `"channel1"`）或字符串格式值（如 `"{podName}"` 等）。查看您可以在组件元数据中使用的所有模板标签。
durable	N	是否使用持久化队列。默认为 `"false"`	`"true"`，`"false"`
deletedWhenUnused	N	队列是否应配置为自动删除默认为 `"true"`	`"true"`，`"false"`
autoAck	N	队列消费者是否应自动确认消息。默认为 `"false"`	`"true"`，`"false"`
deliveryMode	N	发布消息时的持久性模式。默认为 `"0"`。RabbitMQ 将 `"2"` 视为持久性，其他数字视为非持久性	`"0"`，`"2"`
requeueInFailure	N	在失败情况下发送负确认时是否重新排队。默认为 `"false"`	`"true"`，`"false"`
prefetchCount	N	要预取的消息数量。考虑将其更改为非零值以用于生产环境。默认为 `"0"`，这意味着将预取所有可用消息。	`"2"`
publisherConfirm	N	如果启用，客户端在发布消息后等待发布者确认。默认为 `"false"`	`"true"`，`"false"`
reconnectWait	N	如果发生连接故障，重新连接前等待的时间（以秒为单位）	`"0"`
concurrencyMode	N	`parallel` 是默认值，允许并行处理多个消息（如果配置了 `app-max-concurrency` 注释，则受其限制）。设置为 `single` 以禁用并行处理。在大多数情况下，没有理由更改此设置。	`parallel`，`single`
enableDeadLetter	N	启用将无法处理的消息转发到死信主题。默认为 `"false"`	`"true"`，`"false"`
maxLen	N	队列及其死信队列（如果启用了死信）的最大消息数。如果同时设置了 `maxLen` 和 `maxLenBytes`，则两者都将适用；首先达到的限制将被强制执行。默认为无限制。	`"1000"`
maxLenBytes	N	队列及其死信队列（如果启用了死信）的最大字节长度。如果同时设置了 `maxLen` 和 `maxLenBytes`，则两者都将适用；首先达到的限制将被强制执行。默认为无限制。	`"1048576"`
exchangeKind	N	rabbitmq 交换的交换类型。默认为 `"fanout"`。	`"fanout"`，`"topic"`
saslExternal	N	使用 TLS 时，用户名是否应从附加字段（例如 CN）中获取。请参阅 RabbitMQ 认证机制。默认为 `"false"`。	`"true"`，`"false"`
ttlInSeconds	N	在组件级别设置消息 TTL，可以通过每个请求的消息级别 TTL 覆盖。	`"60"`
caCert	使用 TLS 时必需	用于验证服务器 TLS 证书的 PEM 格式的证书颁发机构（CA）证书。	`"-----BEGIN CERTIFICATE-----\n<base64-encoded DER>\n-----END CERTIFICATE-----"`
clientCert	使用 TLS 时必需	PEM 格式的 TLS 客户端证书。必须与 `clientKey` 一起使用。	`"-----BEGIN CERTIFICATE-----\n<base64-encoded DER>\n-----END CERTIFICATE-----"`
clientKey	使用 TLS 时必需	PEM 格式的 TLS 客户端密钥。必须与 `clientCert` 一起使用。可以是 `secretKeyRef` 以使用 secret 引用。	`"-----BEGIN RSA PRIVATE KEY-----\n<base64-encoded PKCS8>\n-----END RSA PRIVATE KEY-----"`
clientName	N	这个 RabbitMQ 客户端提供的连接名称是一个自定义标识符。如果设置，标识符将在 RabbitMQ 服务器日志条目和管理 UI 中提及。可以设置为 {uuid}、{podName} 或 {appID}，Dapr 运行时将其替换为实际值。	`"app1"`，`{uuid}`，`{podName}`，`{appID}`
heartBeat	N	定义与服务器的心跳间隔，检测与 RabbitMQ 服务器的对等 TCP 连接的存活性。默认为 `10s` 。	`"10s"`

使用 TLS 进行通信

要配置使用 TLS 的通信，请确保 RabbitMQ 节点已启用 TLS，并在组件配置中提供 caCert、clientCert、clientKey 元数据。例如：

Redis Streams

Mon, 01 Jan 0001 00:00:00 +0000

组件格式

要设置 Redis Streams pub/sub，创建一个类型为 pubsub.redis 的组件。请参阅 pub/sub broker 组件文件了解 ConsumerID 是如何自动生成的。阅读操作指南：发布和订阅指南了解如何创建和应用 pub/sub 配置。

apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
 name: redis-pubsub
spec:
 type: pubsub.redis
 version: v1
 metadata:
 - name: redisHost
 value: localhost:6379
 - name: redisPassword
 value: "KeFg23!"
 - name: consumerID
 value: "channel1"
 - name: useEntraID
 value: "true"
 - name: enableTLS
 value: "false"

警告

上述示例使用了明文字符串作为密钥。建议使用密钥存储来保护密钥，具体方法请参阅此处。

规格元数据字段

字段	必需	详情	示例
redisHost	Y	Redis 主机的连接字符串。如果 `"redisType"` 是 `"cluster"`，可以是多个主机用逗号分隔，或仅一个主机	`localhost:6379`, `redis-master.default.svc.cluster.local:6379`
redisPassword	N	Redis 主机的密码。无默认值。可以是 `secretKeyRef` 以使用密钥引用	`""`, `"KeFg23!"`
redisUsername	N	Redis 主机的用户名。默认为空。确保您的 Redis 服务器版本为 6 或更高，并正确创建了 ACL 规则。	`""`, `"default"`
consumerID	N	消费者组 ID。	可以设置为字符串值（如上例中的 `"channel1"`）或字符串格式值（如 `"{podName}"` 等）。查看您可以在组件元数据中使用的所有模板标签。
useEntraID	N	实现对 Azure Cache for Redis 的 EntraID 支持。启用此功能之前：必须以 `"server:port"` 的形式指定 `redisHost` 名称必须启用 TLS 了解更多关于此设置的信息，请参阅创建 Redis 实例 > Azure Cache for Redis	`"true"`, `"false"`
enableTLS	N	如果 Redis 实例支持带有公共证书的 TLS，可以配置为启用或禁用。默认为 `"false"`	`"true"`, `"false"`
clientCert	N	客户端证书的内容，用于需要客户端证书的 Redis 实例。必须与 `clientKey` 一起使用，并且 `enableTLS` 必须设置为 true。建议使用密钥存储，如此处所述	`"----BEGIN CERTIFICATE-----\nMIIC..."`
clientKey	N	客户端私钥的内容，与 `clientCert` 一起用于身份验证。建议使用密钥存储，如此处所述	`"----BEGIN PRIVATE KEY-----\nMIIE..."`
redeliverInterval	N	检查待处理消息以重新传递的间隔。可以使用 Go duration 字符串（例如 “ms”, “s”, “m”）或毫秒数。默认为 `"60s"`。`"0"` 禁用重新传递。	`"30s"`, `"5000"`
processingTimeout	N	消息在尝试重新传递之前必须挂起的时间量。可以使用 Go duration 字符串（例如 “ms”, “s”, “m”）或毫秒数。默认为 `"15s"`。`"0"` 禁用重新传递。	`"60s"`, `"600000"`
queueDepth	N	处理消息的队列大小。默认为 `"100"`。	`"1000"`
concurrency	N	处理消息的并发工作者数量。默认为 `"10"`。	`"15"`
redisType	N	Redis 的类型。有两个有效值，一个是 `"node"` 表示单节点模式，另一个是 `"cluster"` 表示 Redis 集群模式。默认为 `"node"`。	`"cluster"`
redisDB	N	连接到 Redis 后选择的数据库。如果 `"redisType"` 是 `"cluster"`，此选项将被忽略。默认为 `"0"`。	`"0"`
redisMaxRetries	N	在放弃之前重试命令的最大次数。默认情况下不重试失败的命令。	`"5"`
redisMinRetryInterval	N	每次重试之间 Redis 命令的最小回退时间。默认为 `"8ms"`；`"-1"` 禁用回退。	`"8ms"`
redisMaxRetryInterval	N	每次重试之间 Redis 命令的最大回退时间。默认为 `"512ms"`；`"-1"` 禁用回退。	`"5s"`
dialTimeout	N	建立新连接的拨号超时时间。默认为 `"5s"`。	`"5s"`
readTimeout	N	套接字读取的超时时间。如果达到，Redis 命令将因超时而失败而不是阻塞。默认为 `"3s"`，`"-1"` 表示无超时。	`"3s"`
writeTimeout	N	套接字写入的超时时间。如果达到，Redis 命令将因超时而失败而不是阻塞。默认值为 readTimeout。	`"3s"`
poolSize	N	最大套接字连接数。默认是每个 CPU 10 个连接，由 runtime.NumCPU 报告。	`"20"`
poolTimeout	N	如果所有连接都忙，客户端等待连接的时间量，然后返回错误。默认是 readTimeout + 1 秒。	`"5s"`
maxConnAge	N	客户端退役（关闭）连接的连接年龄。默认是不关闭老化连接。	`"30m"`
minIdleConns	N	为了避免创建新连接的性能下降，保持打开的最小空闲连接数。默认为 `"0"`。	`"2"`
idleCheckFrequency	N	空闲连接清理器进行空闲检查的频率。默认为 `"1m"`。`"-1"` 禁用空闲连接清理器。	`"-1"`
idleTimeout	N	客户端关闭空闲连接的时间量。应小于服务器的超时时间。默认为 `"5m"`。`"-1"` 禁用空闲超时检查。	`"10m"`
failover	N	启用故障转移配置的属性。需要设置 sentinalMasterName。默认为 `"false"`	`"true"`, `"false"`
sentinelMasterName	N	Sentinel 主名称。参见 Redis Sentinel 文档	`""`, `"127.0.0.1:6379"`
maxLenApprox	N	流内的最大项目数。当达到指定长度时，旧条目会自动被驱逐，以便流保持恒定大小。默认为无限制。	`"10000"`

创建 Redis 实例

Dapr 可以使用任何 Redis 实例 - 无论是容器化的、在本地开发机器上运行的，还是托管的云服务，只要 Redis 的版本是 5.x 或 6.x。

RocketMQ

Mon, 01 Jan 0001 00:00:00 +0000

组件格式

要设置 RocketMQ pub/sub，创建一个类型为 pubsub.rocketmq 的组件。请参阅 pub/sub broker 组件文件了解 ConsumerID 是如何自动生成的。阅读如何：发布和订阅指南了解如何创建和应用 pub/sub 配置。

apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
 name: rocketmq-pubsub
spec:
 type: pubsub.rocketmq
 version: v1
 metadata:
 - name: instanceName
 value: dapr-rocketmq-test
 - name: consumerGroup
 value: dapr-rocketmq-test-g-c
 - name: producerGroup 
 value: dapr-rocketmq-test-g-p
 - name: consumerID
 value: channel1
 - name: nameSpace
 value: dapr-test
 - name: nameServer
 value: "127.0.0.1:9876,127.0.0.2:9876"
 - name: retries
 value: 3
 - name: consumerModel
 value: "clustering"
 - name: consumeOrderly
 value: false

警告

上述示例中，secret 使用了明文字符串。建议使用 secret 存储来存储 secret，如此处所述。

规格元数据字段

字段	必需	详情	默认值	示例
instanceName	N	实例名称	`time.Now().String()`	`dapr-rocketmq-test`
consumerGroup	N	消费者组名称。建议使用。如果 `producerGroup` 为 `null`，则使用 `groupName`。		`dapr-rocketmq-test-g-c`
producerGroup (consumerID)	N	生产者组名称。建议使用。如果 `producerGroup` 为 `null`，则使用 `consumerID`。如果 `consumerID` 也为 null，则使用 `groupName`。		`dapr-rocketmq-test-g-p`
consumerID	N	消费者 ID（消费者标签）用于将一个或多个消费者组织成一个组。具有相同消费者 ID 的消费者作为一个虚拟消费者工作；例如，一条消息仅由组中的一个消费者处理一次。如果未提供 `consumerID`，Dapr 运行时将其设置为 Dapr 应用程序 ID (`appID`) 值。	可以设置为字符串值（如上例中的 `"channel1"`）或字符串格式值（如 `"{podName}"` 等）。查看可以在组件元数据中使用的所有模板标签。
groupName	N	消费者/生产者组名称。已弃用。		`dapr-rocketmq-test-g`
nameSpace	N	RocketMQ 命名空间		`dapr-rocketmq`
nameServerDomain	N	RocketMQ 名称服务器域名		`https://my-app.net:8080/nsaddr`
nameServer	N	RocketMQ 名称服务器，使用 “,” 或 “;” 分隔		`127.0.0.1:9876;127.0.0.2:9877,127.0.0.3:9877`
accessKey	N	访问密钥（用户名）		`"admin"`
secretKey	N	密钥（密码）		`"password"`
securityToken	N	安全令牌
retries	N	向 broker 发送消息的重试次数	`3`	`3`
producerQueueSelector (queueSelector)	N	生产者队列选择器。有五种队列选择器实现：`hash`、`random`、`manual`、`roundRobin`、`dapr`。	`dapr`	`hash`
consumerModel	N	定义消息如何传递到每个消费者客户端的消息模型。RocketMQ 支持两种消息模型：`clustering` 和 `broadcasting`。	`clustering`	`broadcasting` , `clustering`
fromWhere (consumeFromWhere)	N	消费者启动时的消费点。有三个消费点：`CONSUME_FROM_LAST_OFFSET`、`CONSUME_FROM_FIRST_OFFSET`、`CONSUME_FROM_TIMESTAMP`	`CONSUME_FROM_LAST_OFFSET`	`CONSUME_FROM_LAST_OFFSET`
consumeTimestamp	N	以秒为精度回溯消费时间。时间格式为 `yyyymmddhhmmss`。例如，`20131223171201` 表示 2013 年 12 月 23 日 17:12:01	`time.Now().Add(time.Minute * (-30)).Format("20060102150405")`	`20131223171201`
consumeOrderly	N	确定是否使用 FIFO 顺序的有序消息。	`false`	`false`
consumeMessageBatchMaxSize	N	批量消费大小，范围 `[1, 1024]`	`512`	`10`
consumeConcurrentlyMaxSpan	N	并发最大跨度偏移。这对顺序消费没有影响。范围：`[1, 65535]`	`1000`	`1000`
maxReconsumeTimes	N	最大重新消费次数。`-1` 表示 16 次。如果消息在成功前被重新消费超过 {@link maxReconsumeTimes} 次，它们将被定向到删除队列。	顺序消息为 `MaxInt32`；并发消息为 `16`	`16`
autoCommit	N	启用自动提交	`true`	`false`
consumeTimeout	N	消息可能阻塞消费线程的最大时间。时间单位：分钟	`15`	`15`
consumerPullTimeout	N	套接字超时时间，单位为毫秒
pullInterval	N	消息拉取间隔	`100`	`100`
pullBatchSize	N	一次从 broker 拉取的消息数量。如果 `pullBatchSize` 为 `null`，使用 `ConsumerBatchSize`。`pullBatchSize` 范围 `[1, 1024]`	`32`	`10`
pullThresholdForQueue	N	队列级别的流量控制阈值。默认情况下，每个消息队列将缓存最多 1000 条消息。考虑 `PullBatchSize` - 瞬时值可能超过限制。范围：`[1, 65535]`	`1024`	`1000`
pullThresholdForTopic	N	主题级别的流量控制阈值。如果 `pullThresholdForQueue` 不是无限制的，将被 `pullThresholdForTopic` 的值覆盖并计算。例如，如果 `pullThresholdForTopic` 的值为 1000，并且为此消费者分配了 10 个消息队列，则 `pullThresholdForQueue` 将设置为 100。范围：`[1, 6553500]`	`-1(无限制)`	`10`
pullThresholdSizeForQueue	N	限制队列级别的缓存消息大小。考虑 `pullBatchSize` - 瞬时值可能超过限制。消息的大小仅通过消息体测量，因此不准确。范围：`[1, 1024]`	`100`	`100`
pullThresholdSizeForTopic	N	限制主题级别的缓存消息大小。如果 `pullThresholdSizeForQueue` 不是无限制的，将被 `pullThresholdSizeForTopic` 的值覆盖并计算。例如，如果 `pullThresholdSizeForTopic` 的值为 1000 MiB，并且为此消费者分配了 10 个消息队列，则 `pullThresholdSizeForQueue` 将设置为 100 MiB。范围：`[1, 102400]`	`-1`	`100`
content-type	N	消息内容类型。	`"text/plain"`	`"application/cloudevents+json; charset=utf-8"`, `"application/octet-stream"`
logLevel	N	日志级别	`warn`	`info`
sendTimeOut	N	连接 RocketMQ 的 broker 发送消息超时，以纳秒为单位。已弃用。	3 秒	`10000000000`
sendTimeOutSec	N	发布消息的超时时间，以秒为单位。如果 `sendTimeOutSec` 为 `null`，则使用 `sendTimeOut`。	3 秒	`3`
mspProperties	N	RocketMQ 消息属性集合中的属性传递给应用程序，数据用 “,” 分隔多个属性		`key,mkey`

出于向后兼容的原因，元数据中的以下值仍然支持，尽管不推荐使用。

Solace-AMQP

Mon, 01 Jan 0001 00:00:00 +0000

组件格式

要配置 Solace-AMQP 发布/订阅组件，请创建一个类型为 pubsub.solace.amqp 的组件。请参考发布/订阅代理组件文件了解 ConsumerID 的自动生成方式。参阅操作指南：发布和订阅指南以获取创建和应用发布/订阅配置的步骤。

apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
 name: solace
spec:
 type: pubsub.solace.amqp
 version: v1
 metadata:
 - name: url
 value: 'amqp://localhost:5672'
 - name: username
 value: 'default'
 - name: password
 value: 'default'
 - name: consumerID
 value: 'channel1'

警告

上述示例中使用了明文字符串作为密钥。建议使用密钥存储来保护密钥，具体方法请参见此处。

规格元数据字段

字段	必需	详情	示例
url	Y	AMQP 代理的地址。可以使用 `secretKeyRef` 引用密钥。使用 `amqp://` URI 方案进行非 TLS 通信。使用 `amqps://` URI 方案进行 TLS 通信。	`"amqp://host.domain[:port]"`
username	Y	连接到代理的用户名。仅在未启用匿名连接或设置为 `false` 时需要。	`default`
password	Y	连接到代理的密码。仅在未启用匿名连接或设置为 `false` 时需要。	`default`
consumerID	N	消费者 ID（消费者标签）用于将一个或多个消费者组织成一个组。具有相同消费者 ID 的消费者作为一个虚拟消费者工作；例如，消息仅由组中的一个消费者处理一次。如果未提供 `consumerID`，Dapr 运行时将其设置为 Dapr 应用程序 ID (`appID`) 值。	可以设置为字符串值（如上例中的 `"channel1"`）或字符串格式值（如 `"{podName}"` 等）。查看您可以在组件元数据中使用的所有模板标签。
anonymous	N	在不进行凭证验证的情况下连接到代理。仅在代理上启用时有效。如果设置为 `true`，则不需要用户名和密码。	`true`
caCert	使用 TLS 时必需	用于验证服务器 TLS 证书的 PEM 格式的证书颁发机构 (CA) 证书。	`"-----BEGIN CERTIFICATE-----\n<base64-encoded DER>\n-----END CERTIFICATE-----"`
clientCert	使用 TLS 时必需	PEM 格式的 TLS 客户端证书。必须与 `clientKey` 一起使用。	`"-----BEGIN CERTIFICATE-----\n<base64-encoded DER>\n-----END CERTIFICATE-----"`
clientKey	使用 TLS 时必需	PEM 格式的 TLS 客户端密钥。必须与 `clientCert` 一起使用。可以使用 `secretKeyRef` 引用密钥。	`"-----BEGIN RSA PRIVATE KEY-----\n<base64-encoded PKCS8>\n-----END RSA PRIVATE KEY-----"`

使用 TLS 进行通信

要配置使用 TLS 进行通信：

内存

Mon, 01 Jan 0001 00:00:00 +0000

内存 pub/sub 组件运行在单个 Dapr sidecar 中。这主要用于开发目的。状态不会在多个 sidecar 之间复制，并且在 Dapr sidecar 重启时会丢失。

组件格式

apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
 name: pubsub
spec:
 type: pubsub.in-memory
 version: v1
 metadata: []

注意：内存组件不需要特定的元数据即可工作，但 spec.metadata 是必填字段。

发布/订阅代理组件规范 on Dapr 文档库

Apache Kafka

组件格式

AWS SNS/SQS

组件格式

注意

警告

规格元数据字段

其他信息

符合AWS规范

Azure Event Hubs

组件格式

注意

规格元数据字段

Microsoft Entra ID 身份验证

Azure Service Bus Topics

组件格式

连接字符串认证

Azure Service Bus 队列

组件格式

连接字符串认证

警告

规格元数据字段

Microsoft Entra ID 认证

GCP

创建 Dapr 组件

警告

规格元数据字段

警告

GCP 凭据

JetStream

组件格式

规格元数据字段

创建 NATS 服务器

KubeMQ

组件格式

规格元数据字段

创建 KubeMQ broker

MQTT

组件格式

警告

规格元数据字段

启用消息传递重试

MQTT3

组件格式

警告

规格元数据字段

使用TLS进行通信

Pulsar

组件格式

警告

规格元数据字段

使用 Token 进行身份验证

RabbitMQ

组件格式

警告

规格元数据字段

使用 TLS 进行通信

Redis Streams

组件格式

警告

规格元数据字段

创建 Redis 实例

RocketMQ

组件格式

警告

规格元数据字段

Solace-AMQP

组件格式

警告

规格元数据字段

使用 TLS 进行通信

内存

组件格式

相关链接