此版本仍在开发中,尚未被视为稳定版本。对于最新的稳定版本,请使用 Spring for Apache Kafka 3.3.0spring-doc.cadn.net.cn

侦听器容器属性

表 1.ContainerProperties性能
财产 违约 描述

ackCountspring-doc.cadn.net.cn

1spring-doc.cadn.net.cn

提交待处理偏移量之前的记录数,当ackModeCOUNTCOUNT_TIME.spring-doc.cadn.net.cn

adviceChainspring-doc.cadn.net.cn

nullspring-doc.cadn.net.cn

一条Advice对象(例如MethodInterceptoraround 建议)包装消息侦听器,按顺序调用。spring-doc.cadn.net.cn

ackModespring-doc.cadn.net.cn

Batchspring-doc.cadn.net.cn

控制 offset 的提交频率 - 请参阅 Committing Offsetsspring-doc.cadn.net.cn

ackTimespring-doc.cadn.net.cn

5000spring-doc.cadn.net.cn

ackModeTIMECOUNT_TIME.spring-doc.cadn.net.cn

assignmentCommitOptionspring-doc.cadn.net.cn

LATEST_ONLY _NO_TXspring-doc.cadn.net.cn

是否在分配时提交初始位置;默认情况下,仅当ConsumerConfig.AUTO_OFFSET_RESET_CONFIGlatest即使存在事务管理器,它也不会在事务中运行。 请参阅 JavaDocs 以获取ContainerProperties.AssignmentCommitOption了解有关可用选项的更多信息。spring-doc.cadn.net.cn

asyncAcksspring-doc.cadn.net.cn

falsespring-doc.cadn.net.cn

启用无序提交(请参阅 手动提交偏移量);使用者将暂停,提交将延迟,直到填补间隙。spring-doc.cadn.net.cn

authExceptionRetryIntervalspring-doc.cadn.net.cn

nullspring-doc.cadn.net.cn

当不为 null 时,一个Duration在 poll 之间休眠时,当AuthenticationExceptionAuthorizationException由 Kafka 客户端抛出。 当 null 时,此类异常被视为致命异常,容器将停止。spring-doc.cadn.net.cn

batchRecoverAfterRollbackspring-doc.cadn.net.cn

falsespring-doc.cadn.net.cn

设置为true要启用批量恢复,请参阅 After Rollback Processorspring-doc.cadn.net.cn

clientIdspring-doc.cadn.net.cn

(空字符串)spring-doc.cadn.net.cn

client.idconsumer 属性。 覆盖 Consumer Factoryclient.id财产;在并发容器中,-n将添加为每个使用者实例的后缀。spring-doc.cadn.net.cn

checkDeserExWhenKeyNullspring-doc.cadn.net.cn

spring-doc.cadn.net.cn

设置为true以始终检查DeserializationException标头时,如果null key已收到。 当使用者代码无法确定ErrorHandlingDeserializer已配置,例如在使用 delegating deserializer 时。spring-doc.cadn.net.cn

checkDeserExWhenValueNullspring-doc.cadn.net.cn

spring-doc.cadn.net.cn

设置为true以始终检查DeserializationException标头时,如果null value已收到。 当使用者代码无法确定ErrorHandlingDeserializer已配置,例如在使用 delegating deserializer 时。spring-doc.cadn.net.cn

commitCallbackspring-doc.cadn.net.cn

nullspring-doc.cadn.net.cn

当存在且syncCommitsfalse提交完成后调用的回调。spring-doc.cadn.net.cn

commitLogLevelspring-doc.cadn.net.cn

调试spring-doc.cadn.net.cn

与提交偏移量相关的日志的日志记录级别。spring-doc.cadn.net.cn

consumerRebalanceListenerspring-doc.cadn.net.cn

nullspring-doc.cadn.net.cn

再平衡侦听器;请参阅 重新平衡侦听器spring-doc.cadn.net.cn

commitRetriesspring-doc.cadn.net.cn

3spring-doc.cadn.net.cn

设置重试次数RetriableCommitFailedException使用syncCommits设置为 true。 默认 3 (总共 4 次尝试)。spring-doc.cadn.net.cn

consumerStartTimeoutspring-doc.cadn.net.cn

30 秒spring-doc.cadn.net.cn

在记录错误之前等待使用者启动的时间;例如,如果您使用的 Task Executor 线程不足,则可能会发生这种情况。spring-doc.cadn.net.cn

deliveryAttemptHeaderspring-doc.cadn.net.cn

falsespring-doc.cadn.net.cn

请参阅 Delivery Attempts 标头spring-doc.cadn.net.cn

eosModespring-doc.cadn.net.cn

V2spring-doc.cadn.net.cn

Exactly Once 语义模式;请参阅 Exactly Once 语义spring-doc.cadn.net.cn

fixTxOffsetsspring-doc.cadn.net.cn

falsespring-doc.cadn.net.cn

当使用事务创建者生成的记录时,如果使用者位于分区的末尾,则滞后可能会错误地报告为大于零,因为伪记录用于指示事务提交/回滚,并且可能存在回滚记录。 这在功能上不会影响消费者,但一些用户表示担心“滞后”不为零。 将此属性设置为true容器将更正此类误报的偏移量。 该检查在下一次轮询之前执行,以避免增加提交处理的复杂性。 在撰写本文时,只有当消费者配置了isolation.level=read_committedmax.poll.records大于 1。 有关更多信息,请参阅 KAFKA-10683spring-doc.cadn.net.cn

groupIdspring-doc.cadn.net.cn

nullspring-doc.cadn.net.cn

覆盖使用者group.id财产;由@KafkaListener idgroupId财产。spring-doc.cadn.net.cn

idleBeforeDataMultiplierspring-doc.cadn.net.cn

5.0spring-doc.cadn.net.cn

乘数idleEventInterval,该 API 将在收到任何记录之前应用。 收到记录后,将不再应用乘数。 自 2.8 版起可用。spring-doc.cadn.net.cn

idleBetweenPollsspring-doc.cadn.net.cn

0spring-doc.cadn.net.cn

用于通过在轮询之间休眠线程来减慢投放速度。 处理一批记录的时间加上此值必须小于max.poll.interval.msconsumer 属性。spring-doc.cadn.net.cn

idleEventIntervalspring-doc.cadn.net.cn

nullspring-doc.cadn.net.cn

设置后,将启用ListenerContainerIdleEvents,请参阅 应用程序事件检测空闲和无响应的使用者。 另请参阅idleBeforeDataMultiplier.spring-doc.cadn.net.cn

idlePartitionEventIntervalspring-doc.cadn.net.cn

nullspring-doc.cadn.net.cn

设置后,将启用ListenerContainerIdlePartitionEvents,请参阅 应用程序事件检测空闲和无响应的使用者spring-doc.cadn.net.cn

kafkaConsumerPropertiesspring-doc.cadn.net.cn

没有spring-doc.cadn.net.cn

用于覆盖在 Consumer Factory 上配置的任何任意 Consumer 属性。spring-doc.cadn.net.cn

kafkaAwareTransactionManagerspring-doc.cadn.net.cn

nullspring-doc.cadn.net.cn

请参阅 事务spring-doc.cadn.net.cn

listenerTaskExecutorspring-doc.cadn.net.cn

SimpleAsyncTaskExecutorspring-doc.cadn.net.cn

用于运行使用者线程的任务执行程序。 默认执行程序会创建名为<name>-C-n;使用KafkaMessageListenerContainer,则 name 是 bean 名称;使用ConcurrentMessageListenerContainer名称是后缀为-m哪里m对于每个子容器递增。请参阅容器线程命名spring-doc.cadn.net.cn

logContainerConfigspring-doc.cadn.net.cn

falsespring-doc.cadn.net.cn

设置为true在 INFO 级别记录所有容器属性。spring-doc.cadn.net.cn

messageListenerspring-doc.cadn.net.cn

nullspring-doc.cadn.net.cn

消息侦听器。spring-doc.cadn.net.cn

micrometerEnabledspring-doc.cadn.net.cn

truespring-doc.cadn.net.cn

是否维护使用者线程的 Micrometer 计时器。spring-doc.cadn.net.cn

micrometerTagsspring-doc.cadn.net.cn

spring-doc.cadn.net.cn

要添加到微米度量的静态标签的映射。spring-doc.cadn.net.cn

micrometerTagsProviderspring-doc.cadn.net.cn

nullspring-doc.cadn.net.cn

一个基于使用者记录提供动态标签的函数。spring-doc.cadn.net.cn

missingTopicsFatalspring-doc.cadn.net.cn

falsespring-doc.cadn.net.cn

如果代理上不存在配置的主题,则为 true 时将阻止容器启动。spring-doc.cadn.net.cn

monitorIntervalspring-doc.cadn.net.cn

30 秒spring-doc.cadn.net.cn

检查使用者线程状态的频率NonResponsiveConsumerEvents. 看noPollThresholdpollTimeout.spring-doc.cadn.net.cn

noPollThresholdspring-doc.cadn.net.cn

3.0spring-doc.cadn.net.cn

乘以pollTimeOut要确定是否发布NonResponsiveConsumerEvent. 看monitorInterval.spring-doc.cadn.net.cn

observationConventionspring-doc.cadn.net.cn

nullspring-doc.cadn.net.cn

设置后,根据使用者记录中的信息向计时器和跟踪添加动态标记。spring-doc.cadn.net.cn

observationEnabledspring-doc.cadn.net.cn

falsespring-doc.cadn.net.cn

设置为true启用通过 Micrometer 进行观察。spring-doc.cadn.net.cn

offsetAndMetadataProviderspring-doc.cadn.net.cn

nullspring-doc.cadn.net.cn

一个OffsetAndMetadata;默认情况下,提供程序会创建具有空元数据的偏移量和元数据。提供程序提供了一种自定义元数据的方法。spring-doc.cadn.net.cn

onlyLogRecordMetadataspring-doc.cadn.net.cn

falsespring-doc.cadn.net.cn

设置为false记录完整的使用者记录(错误、调试日志等),而不仅仅是topic-partition@offset.spring-doc.cadn.net.cn

pauseImmediatespring-doc.cadn.net.cn

falsespring-doc.cadn.net.cn

当容器暂停时,在当前记录之后停止处理,而不是在处理上一次轮询的所有记录之后停止处理;其余记录保留在内存中,并将在容器恢复时传递给侦听器。spring-doc.cadn.net.cn

pollTimeoutspring-doc.cadn.net.cn

5000spring-doc.cadn.net.cn

传入的超时Consumer.poll()以毫秒为单位。spring-doc.cadn.net.cn

pollTimeoutWhilePausedspring-doc.cadn.net.cn

100spring-doc.cadn.net.cn

传入的超时Consumer.poll()(以毫秒为单位)当容器处于暂停状态时。spring-doc.cadn.net.cn

restartAfterAuthExceptionsspring-doc.cadn.net.cn

spring-doc.cadn.net.cn

如果容器因授权/身份验证异常而停止,则为 True,则重新启动容器。spring-doc.cadn.net.cn

schedulerspring-doc.cadn.net.cn

ThreadPoolTaskSchedulerspring-doc.cadn.net.cn

要在其上运行使用者监视器任务的计划程序。spring-doc.cadn.net.cn

shutdownTimeoutspring-doc.cadn.net.cn

10000spring-doc.cadn.net.cn

阻止stop()方法,直到所有使用者停止,并在发布容器停止事件之前。spring-doc.cadn.net.cn

stopContainerWhenFencedspring-doc.cadn.net.cn

falsespring-doc.cadn.net.cn

如果ProducerFencedException被抛出。 有关更多信息,请参阅 After-rollback Processorspring-doc.cadn.net.cn

stopImmediatespring-doc.cadn.net.cn

falsespring-doc.cadn.net.cn

当容器停止时,请在当前记录之后停止处理,而不是在处理上一次轮询的所有记录之后停止处理。spring-doc.cadn.net.cn

subBatchPerPartitionspring-doc.cadn.net.cn

见 desc.spring-doc.cadn.net.cn

使用批处理侦听器时,如果这是true,则调用侦听器时,轮询结果将拆分为子批处理,每个分区一个子批处理。 违约false.spring-doc.cadn.net.cn

syncCommitTimeoutspring-doc.cadn.net.cn

nullspring-doc.cadn.net.cn

在以下情况下使用的超时syncCommitstrue. 如果未设置,容器将尝试确定default.api.timeout.ms消费者财产并使用它;否则将使用 60 秒。spring-doc.cadn.net.cn

syncCommitsspring-doc.cadn.net.cn

truespring-doc.cadn.net.cn

是否对偏移量使用 sync 或 async commits;看commitCallback.spring-doc.cadn.net.cn

topics topicPattern topicPartitionsspring-doc.cadn.net.cn

不适用spring-doc.cadn.net.cn

配置的主题、主题模式或显式分配的主题/分区。 互斥;必须至少提供一个;强制执行者ContainerProperties构造 函数。spring-doc.cadn.net.cn

transactionManagerspring-doc.cadn.net.cn

nullspring-doc.cadn.net.cn

自 3.2 起已移除,请参阅 [kafkaAwareTransactionManager]其他事务管理器spring-doc.cadn.net.cn

表 2.AbstractMessageListenerContainer性能
财产 违约 描述

afterRollbackProcessorspring-doc.cadn.net.cn

DefaultAfterRollbackProcessorspring-doc.cadn.net.cn

AfterRollbackProcessor在事务回滚后调用。spring-doc.cadn.net.cn

applicationEventPublisherspring-doc.cadn.net.cn

应用程序上下文spring-doc.cadn.net.cn

事件发布者。spring-doc.cadn.net.cn

batchErrorHandlerspring-doc.cadn.net.cn

见 desc.spring-doc.cadn.net.cn

已弃用 - 请参阅commonErrorHandler.spring-doc.cadn.net.cn

batchInterceptorspring-doc.cadn.net.cn

nullspring-doc.cadn.net.cn

设置BatchInterceptor在调用批处理侦听器之前调用;不适用于 Record 侦听器。 另请参阅interceptBeforeTx.spring-doc.cadn.net.cn

beanNamespring-doc.cadn.net.cn

Bean 名称spring-doc.cadn.net.cn

容器的 Bean 名称;后缀为-n对于子容器。spring-doc.cadn.net.cn

commonErrorHandlerspring-doc.cadn.net.cn

见 desc.spring-doc.cadn.net.cn

DefaultErrorHandlernulltransactionManagerDefaultAfterRollbackProcessor被使用。 请参阅 容器错误处理程序spring-doc.cadn.net.cn

containerPropertiesspring-doc.cadn.net.cn

ContainerPropertiesspring-doc.cadn.net.cn

容器 properties 实例。spring-doc.cadn.net.cn

groupIdspring-doc.cadn.net.cn

见 desc.spring-doc.cadn.net.cn

containerProperties.groupId,如果存在,否则group.idProperty 的 Factory。spring-doc.cadn.net.cn

interceptBeforeTxspring-doc.cadn.net.cn

truespring-doc.cadn.net.cn

确定recordInterceptor在事务开始之前或之后调用。spring-doc.cadn.net.cn

listenerIdspring-doc.cadn.net.cn

见 desc.spring-doc.cadn.net.cn

用户配置的容器的 Bean 名称或id属性@KafkaListeners.spring-doc.cadn.net.cn

listenerInfospring-doc.cadn.net.cn

spring-doc.cadn.net.cn

要在KafkaHeaders.LISTENER_INFO页眉。 跟@KafkaListener,此值从info属性。 此标头可用于各种位置,例如RecordInterceptor,RecordFilterStrategy以及侦听器代码本身。spring-doc.cadn.net.cn

pauseRequestedspring-doc.cadn.net.cn

(只读)spring-doc.cadn.net.cn

如果已请求使用者暂停,则为 True。spring-doc.cadn.net.cn

recordInterceptorspring-doc.cadn.net.cn

nullspring-doc.cadn.net.cn

设置RecordInterceptor在调用 record listener 之前调用 ;不适用于批处理侦听器。 另请参阅interceptBeforeTx.spring-doc.cadn.net.cn

topicCheckTimeoutspring-doc.cadn.net.cn

30 秒spring-doc.cadn.net.cn

missingTopicsFatalcontainer 属性为true,等待describeTopics作完成。spring-doc.cadn.net.cn

表 3.KafkaMessageListenerContainer性能
财产 违约 描述

assignedPartitionsspring-doc.cadn.net.cn

(只读)spring-doc.cadn.net.cn

当前分配给此容器的分区(显式或不显式)。spring-doc.cadn.net.cn

clientIdSuffixspring-doc.cadn.net.cn

nullspring-doc.cadn.net.cn

由并发容器使用,为每个子容器的使用者提供唯一的client.id.spring-doc.cadn.net.cn

containerPausedspring-doc.cadn.net.cn

不适用spring-doc.cadn.net.cn

如果已请求暂停,并且使用者实际上已暂停,则为 True。spring-doc.cadn.net.cn

表 4.ConcurrentMessageListenerContainer性能
财产 违约 描述

alwaysClientIdSuffixspring-doc.cadn.net.cn

truespring-doc.cadn.net.cn

设置为 false 可禁止向client.idconsumer 属性时,当concurrency只有 1 个。spring-doc.cadn.net.cn

assignedPartitionsspring-doc.cadn.net.cn

(只读)spring-doc.cadn.net.cn

当前分配给此容器的子级的分区的聚合KafkaMessageListenerContainers(显式或不显式)。spring-doc.cadn.net.cn

concurrencyspring-doc.cadn.net.cn

1spring-doc.cadn.net.cn

子级数KafkaMessageListenerContainers 进行管理。spring-doc.cadn.net.cn

containerPausedspring-doc.cadn.net.cn

不适用spring-doc.cadn.net.cn

如果已请求暂停,并且所有子容器的使用者实际上都已暂停,则为 True。spring-doc.cadn.net.cn

containersspring-doc.cadn.net.cn

不适用spring-doc.cadn.net.cn

对所有子项的引用KafkaMessageListenerContainers.spring-doc.cadn.net.cn


APP信息