配置选项

与Kafka绑定连接的经纪人的列表。spring-doc.cadn.net.cn

brokers 允许不带端口信息的主机（例如，host1,host2:port2）。这设置了没有在代理列表中配置端口时的默认端口。spring-doc.cadn.net.cn

由绑定器创建的所有客户端传递的客户端属性（生产者和使用者）的键/值映射。 <br> 由于这些属性同时用于生产者和使用者，因此应将其限制使用于通用属性，例如安全性设置。 <br> 通过此配置提供的任何未知的Kafka生产者或使用者属性都会被筛选掉，不允许传播。 <br> 此处的属性会覆盖在启动中设置的任何属性。spring-doc.cadn.net.cn

任意Kafka客户端消费者属性的键值映射。除了支持已知的Kafka消费者属性外，还允许在此处设置未知的消费者属性。此处设置的属性会覆盖在boot和configuration属性中设置的属性。spring-doc.cadn.net.cn

列表中包含传输程序运输的自定义标题。仅在与旧版应用程序（< 1.3.x）通信时需要（使用版本号< 0.11.0.0）。较新版本（版本号> 0.11.0.0）原生支持标头。spring-doc.cadn.net.cn

要等待获取分区信息的时间，以秒为单位。健康报告在计时器到期时变为离线状态。spring-doc.cadn.net.cn

在broker上所需确认的数量。 见producer的Kafka文档acks属性。spring-doc.cadn.net.cn

仅在设置为autoCreateTopics或autoAddPartitions时有效。生产或消费数据的话题上配置绑定器的全局最小分区数。可以被partitionCount设置的生产者或instanceCount * concurrency设置的生产者(如果更大)所取代。spring-doc.cadn.net.cn

任意 Kafka 客户端生产者属性的键/值映射。 除了支持已知的 Kafka 生产者属性外，这里也允许使用未知的生产者属性。 这里的属性会覆盖在 boot 和上一个 configuration 属性中设置的任何属性。spring-doc.cadn.net.cn

自动创建主题的复制因子，如果为autoCreateTopics则有效。 可以在每个绑定上重写它。spring-doc.cadn.net.cn

如果设置为 true，绑定器会自动创建新主题。
如果设置为 false，绑定器依赖于主题已经配置好。
在后一种情况下，如果主题不存在，绑定器将无法启动。spring-doc.cadn.net.cn

如果设置为true，则在必要时创建新分区。如果设置为false，则依赖于目标主题的分区大小已经配置。如果目标主题的分区数小于预期值，绑定程序将无法启动。spring-doc.cadn.net.cn

在绑定程序中启用事务。请参阅Kafka文档中的transaction.id和spring-kafka文档中的https://docs.spring.io/spring-kafka/reference/html/#transactions。当启用事务时，单独的producer属性被忽略，所有生产者使用spring.cloud.stream.kafka.binder.transaction.producer.*属性。spring-doc.cadn.net.cn

事务绑定程序中生产者的全局生产者属性。spring-doc.cadn.net.cn

spring-doc.cadn.net.cn

有关所有绑定程序支持的通用生产者属性，请参阅spring.cloud.stream.kafka.binder.transaction.transactionIdPrefix和Kafka Producer Properties。spring-doc.cadn.net.cn

spring-doc.cadn.net.cn

用于将 Kafka 标头映射到和从 Kafka 标头进行映射的KafkaHeaderMapper的 Bean 名称。

例如，如果您希望自定义使用 JSON 反序列化处理标头的BinderHeaderMapper bean 中的信任包集，则可以使用此功能。

如果未使用此属性提供此自定义BinderHeaderMapper bean，则绑定器将查找名称为kafkaBinderHeaderMapper且类型为BinderHeaderMapper的标头映射器 bean，然后回退到由绑定器创建的默认BinderHeaderMapper。spring-doc.cadn.net.cn

标志，用于设置绑定器健康状态为down，当发现主题上的任何分区没有领导者时（无论哪个消费者正在从中接收数据）。spring-doc.cadn.net.cn

当信任库或密钥库证书位置被指定为非本地文件系统资源（由org支持的资源）时。springframework.core.io.资源E。g.CLASSPATH、HTTP 等等。该绑定程序会将资源从可转换为org的路径复制到org。springframework.core.io.(类路径资源)到文件系统上的位置。This is true for both broker level certificates (0 and 1) and certificates intended for schema registry (2 and 3).请注意，信任库和密钥库的位置路径必须在spring.cloud.stream.kafka.binder.configuration…​下提供。例如，spring.cloud.stream.kafka.binder.configuration.ssl.truststore.location、spring.cloud.stream.kafka.binder.configuration.schema.registry.ssl.truststore.location 等。
文件将在指定为该属性值的位置复制。该属性的值必须是文件系统上可由正在运行应用程序的进程写入的现有目录。If this value is not set and the certificate file is a non-local file system resource, then it will be copied to System’s temp directory as returned by System.getProperty("java.io.tmpdir").这也是正确的，如果存在此值，但文件夹在文件系统中找不到或不可写。spring-doc.cadn.net.cn

当将其设置为true时，每次访问度量时都会计算每个consumer topic的偏移量滞后。当将其设置为false时，只使用定期计算的偏移量滞后。spring-doc.cadn.net.cn

间隔用于计算每个消费者主题的偏移滞后。 当禁用 0 或其 计算太长时使用此值。spring-doc.cadn.net.cn

在此绑定器中启用所有绑定的 Micrometer 观察注册表。spring-doc.cadn.net.cn

KafkaHealthIndicator metada consumer group.id。 This consumer is used by the HealthIndicator to query the metadata about the topics in use。spring-doc.cadn.net.cn

{ 'html':'***' }spring-doc.cadn.net.cn

{ 'html':'***' }spring-doc.cadn.net.cn

{ 'html':'***' }spring-doc.cadn.net.cn

当为 0 时，主题分区会自动在消费者组成员之间重新平衡。spring-doc.cadn.net.cn

spring-doc.cadn.net.cn

当为 1 时，每个消费者根据 2 和 3 分配一组固定的分区。spring-doc.cadn.net.cn

这需要在每个已启动的实例上适当地设置 4 和 5 属性。spring-doc.cadn.net.cn

6 的值在这种情况下通常必须大于 1。spring-doc.cadn.net.cn

spring-doc.cadn.net.cn

当为autoCommitOffset时，此设置确定是否在处理每个记录后提交偏移量。默认情况下，所有记录都已处理后，会提交所有记录的偏移量。

一次返回的记录数可以通过Kafka属性控制，该属性通过consumer consumer.poll()属性进行设置。通过max.poll.records。

将此设置为configuration可能会导致性能下降，但这样做可以减少故障发生时重复传递记录的可能性。

另外，请参阅绑定器true属性，它也影响提交偏移量的性能。

此属性从3.1版本开始弃用，建议使用ackMode。

如果未设置ackMode且批处理模式未启用，则将使用RECORD ackMode。spring-doc.cadn.net.cn

从版本 3.1 开始，此属性已过时。请参阅有关替代方案的详细信息。当消息已处理时，是否自动提交偏移量。如果设置为 1，在传入消息的标题中存在一个键为 2 的标题。标题的类型为 3。应用程序可以使用此标题进行确认消息。有关详细信息，请参阅示例部分。当此属性设置为 4 时，Kafka 绑定程序将确认模式设置为 5，并且应用程序负责确认记录。另请参阅 6。spring-doc.cadn.net.cn

指定容器确认模式。 此模式基于 Spring Kafka 中定义的 AckMode 枚举进行设置。 如果 ackEachRecord 属性设置为 true，且消费者未处于批处理模式，则使用确认模式 RECORD，否则，使用此属性提供的确认模式。spring-doc.cadn.net.cn

在可轮询的使用者中，如果设置为true，则在出错时始终自动提交。如果未设置（默认）或false，则在可轮询的使用者中不自动提交。请注意，此属性仅适用于可轮询的使用者。spring-doc.cadn.net.cn

是否将消费者的偏移量重置为提供的startOffset值。必须为false，如果提供了一个KafkaBindingRebalanceListener；有关此属性的更多信息，请参阅rebalance监听器见重置-偏移量以了解更多信息。spring-doc.cadn.net.cn

新组的起始偏移量。允许的值：earliest 和 latest。
如果消费者组通过spring.cloud.stream.bindings.<channelName>.group显式设置给消费者 'binding'（在 earliest 设置），则 'startOffset' 被设为 latest。否则，对于 anonymous 消费者组，它被设为 xref page。
有关此属性的更多信息，请参阅reset-offsets。spring-doc.cadn.net.cn

当设置为 true 时，它会启用消费者的死信队列（DLQ）行为。
默认情况下，导致错误的消息会被转发到名为 error.<destination>.<group> 的主题。
通过设置 dlqName 属性或定义类型为 DlqDestinationResolver 的 @Bean，可以配置 DLQ 主题名称。
这对于错误数量相对较少且重放整个原始主题可能过于繁琐的情况，提供了替代于更常见的 Kafka 重放场景的选项。
有关更多信息，请参阅 kafka 死信队列处理。
从版本 2.0 开始，发送到 DLQ 主题的消息增强了以下标头：x-original-topic、x-exception-message 和 x-exception-stacktrace，格式为 byte[]。
默认情况下，失败的记录被发送到与原记录相同的分区编号中的 DLQ 主题。
请参阅 dlq 分区选择 了解如何更改该行为。
当 destinationIsPattern 为 true 时不允许使用。spring-doc.cadn.net.cn

当 enableDlq 为真，且未设置此属性时，将创建一个与主主题分区数相同的死信队列。
通常情况下，死信记录会被发送到死信队列中的相同分区作为原始记录。
可以更改此行为；请参阅死信队列分区选择。
如果将此属性设置为1，并且没有DqlPartitionFunction的bean，则所有死信记录将写入分区0。
如果此属性大于1，则您必须提供DlqPartitionFunction的bean。
请注意，实际分区数量受绑定器的minPartitionCount属性影响。spring-doc.cadn.net.cn

包含通用 Kafka 消费者属性的键/值对映射。除了具有 Kafka 消费者属性外，还可以传递其他配置属性。例如应用程序所需的某些属性，如spring.cloud.stream.kafka.bindings.input.consumer.configuration.foo=bar。bootstrap.servers属性不能在此处设置；如果需要连接到多个集群，请使用多绑定器支持。spring-doc.cadn.net.cn

接收错误消息的死信队列（DLQ）主题的名称。spring-doc.cadn.net.cn

使用此功能，可以设置与死信队列（DLQ）相关的生产者属性。
所有可以通过 Kafka 生产者属性设置的属性都可以通过此属性进行设置。
当在消费者上启用原生解码时（即 useNativeDecoding: true），应用程序必须为 DLQ 提供相应的键/值序列化器。
这必须以 dlqProducerProperties.configuration.key.serializer 和 dlqProducerProperties.configuration.value.serializer 的形式提供。spring-doc.cadn.net.cn

指示入站通道适配器填充哪些标准标头。
允许值：none，id，timestamp，或both。
如果使用原生反序列化并且接收消息的第一个组件需要一个id(例如配置为使用JDBC消息存储的聚合器)，则很有用。spring-doc.cadn.net.cn

实现RecordMessageConverter的bean的名称。用于入站通道适配器中，以替换默认的MessagingMessageConverter。spring-doc.cadn.net.cn

表示最近未收到消息的事件之间的时间间隔（以毫秒为单位）。 使用 ApplicationListener<ListenerContainerIdleEvent> 可接收这些事件。 有关用法示例，请参阅暂停-恢复。spring-doc.cadn.net.cn

当为 true 时，目的地被视为正则表达式 Pattern，代理用其匹配主题名称。
当为 true 时，不会配置主题，并且不允许使用 enableDlq，因为在配置阶段绑定器不知道主题名称。
请注意，检测与模式匹配的新主题所需的时间由消费者属性 metadata.max.age.ms 控制（在编写本文时），默认值为 300,000 毫秒（5 分钟）。
可以使用上面的 configuration 属性进行配置。spring-doc.cadn.net.cn

用于在配置新主题时使用的Kafka主题属性的Map——例如，spring.cloud.stream.kafka.bindings.input.consumer.topic.properties.message.format.version=0.9.0.0spring-doc.cadn.net.cn

一个<Integer, List<Integer>> 的副本分配映射，其中键为分区，值为分配。spring-doc.cadn.net.cn

spring-doc.cadn.net.cn

用于配置新主题时使用。spring-doc.cadn.net.cn

参见 <code>0</code> Java 文档在 <code>1</code> jar 中的说明。spring-doc.cadn.net.cn

spring-doc.cadn.net.cn

配置主题时要使用的复制因子。覆盖绑定器范围内的设置。
如果存在replicas-assignments，则忽略此设置。spring-doc.cadn.net.cn

轮询中用于可轮询消费者超时时间。spring-doc.cadn.net.cn

用于覆盖此绑定的Binder事务管理器的KafkaAwareTransactionManager的Bean名称。如果要使用ChainedKafkaTransactionManaager将另一个事务与Kafka事务同步，则通常需要它。为了实现记录的精确一次消费和生产，必须为所有消费者和生产者绑定配置相同的事务管理器。spring-doc.cadn.net.cn

使用事务性绑定器时，恢复记录（例如重试次数耗尽后发送到死信主题的记录）的偏移量将默认通过新事务进行提交。将此属性设置为false会抑制已恢复记录的偏移量提交。spring-doc.cadn.net.cn

CommonErrorHandler 每个消费者绑定使用的bean名称。当提供时，此用户提供的CommonErrorHandler优先于捆绑器定义的任何其他错误处理器。ListenerContainerCustomizer不使用并检查目标/组组合来设置错误处理器的应用程序可以方便地表达错误处理器。spring-doc.cadn.net.cn

{ 'html':'***' }spring-doc.cadn.net.cn

{ 'html':'***' }spring-doc.cadn.net.cn

{ 'html':'***' }spring-doc.cadn.net.cn

Kafka 生产者在发送前尝试批处理数据的最大字节数上限。spring-doc.cadn.net.cn

生产者是否为同步的。spring-doc.cadn.net.cn

在启用同步发布时，针对传出消息评估的 SpEL 表达式用于确定等待确认的时间（以毫秒为单位）——例如，headers['mySendTimeout']。
当版本低于 3.0 时，除非使用原生编码，否则无法使用负载，因为在评估此表达式时，负载已经是 byte[] 的形式。现在，在转换负载之前就评估该表达式。spring-doc.cadn.net.cn

生产者在发送同一批次中的消息之前等待多长时间以允许更多消息累积。（通常，生产者不会等待，并且会立即发送所有已累积的消息。非零值可能会增加吞吐量，但会增加延迟）。spring-doc.cadn.net.cn

针对传出消息求值的 SpEL 表达式，用于填充生成的 Kafka 消息的键——例如，headers['myKey']。在 3.0 版本之前，除非使用原生编码，否则无法使用负载，因为在表达式被评估时，负载已经是 byte[] 的形式。现在，在负载转换之前就对表达式进行评估。对于常规处理器（Function<String, String> 或 Function<Message<?>, Message<?>），如果要使生成的键与来自主题的传入键相同，则可以按如下方式设置此属性。spring.cloud.stream.kafka.bindings.<output-binding-name>.producer.messageKeyExpression: headers['kafka_receivedMessageKey'] 对于反应函数，请记住一个重要注意事项。在这种情况下，应用程序必须手动将传入消息的头复制到传出消息中。您可以设置标头，如 myKey 并按照上述方法使用 headers['myKey']，或者为了方便起见，只需设置 KafkaHeaders.MESSAGE_KEY 标头即可，根本不需要设置此属性。spring-doc.cadn.net.cn

用于匹配Spring消息头并映射到Kafka Headers的简单模式的逗号分隔列表，位于ProducerRecord中。
模式可以以通配符（星号）开头或结尾。
可以通过在前面加上!来否定模式。
匹配将在第一次匹配（正向或负向）后停止。
例如!ask,as*将通过ash但不通过ask。
id和timestamp永远不会被映射。spring-doc.cadn.net.cn

包含通用 Kafka 生产者属性的键/值对映射。bootstrap.servers 属性不能在其中设置；如果需要连接到多个集群，请使用多绑定器支持。spring-doc.cadn.net.cn

用于在配置新主题时使用的Kafka主题属性的Map——例如，spring.cloud.stream.kafka.bindings.output.producer.topic.properties.message.format.version=0.9.0.0spring-doc.cadn.net.cn

一个<Integer, List<Integer>> 的副本分配映射，其中键为分区，值为分配。spring-doc.cadn.net.cn

spring-doc.cadn.net.cn

用于配置新主题时使用。spring-doc.cadn.net.cn

参见 <code>0</code> Java 文档在 <code>1</code> jar 中的说明。spring-doc.cadn.net.cn

spring-doc.cadn.net.cn

配置主题时要使用的复制因子。覆盖绑定器范围内的设置。
如果存在replicas-assignments，则忽略此设置。spring-doc.cadn.net.cn

设置为true，以使用传出消息中的KafkaHeaders.TOPIC消息头的值来覆盖默认绑定目标（主题名称）。如果不存在该头部，则使用默认绑定目标。spring-doc.cadn.net.cn

成功发送结果应被发送到的MessageChannel的bean名称；该bean必须存在于应用程序上下文中。
发送到通道的消息是已转换（如果有）的已发送消息，并带有额外的标头KafkaHeaders.RECORD_METADATA。
此标头包含Kafka客户端提供的RecordMetadata对象；它包括记录在主题中写入的分区和偏移量。spring-doc.cadn.net.cn

设置compression.type生产者属性。
支持的值为none、gzip、snappy、lz4和zstd。
如果您覆盖kafka-clients jar到2.1.0（或更高版本），如Apache Kafka文档中的Spring讨论，并希望使用zstd压缩，请使用spring.cloud.stream.kafka.bindings.<binding-name>.producer.configuration.compression.type=zstd。spring-doc.cadn.net.cn

用于覆盖此绑定的Binder事务管理器的KafkaAwareTransactionManager的Bean名称。如果要使用ChainedKafkaTransactionManaager将另一个事务与Kafka事务同步，则通常需要它。为了实现记录的精确一次消费和生产，必须为所有消费者和生产者绑定配置相同的事务管理器。spring-doc.cadn.net.cn

关闭生产者时等待的超时时间（以秒为单位）。spring-doc.cadn.net.cn

通常，与事务绑定器关联的所有输出绑定都会在新事务中发布，除非已有事务正在运行。此属性允许您覆盖该行为。如果设置为 true，则发布的记录将不会在此输出绑定中运行事务，除非已经存在一个事务。spring-doc.cadn.net.cn