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

应用程序事件

以下 Spring 应用程序事件由侦听器容器及其使用者发布：spring-doc.cn

  • ConsumerStartingEvent：在使用线程首次启动时发布，在它开始轮询之前。spring-doc.cn

  • ConsumerStartedEvent：在使用者即将开始轮询时发布。spring-doc.cn

  • ConsumerFailedToStartEvent：如果在容器属性中发布 NO，则发布。 此事件可能表示配置的任务执行程序没有足够的线程来支持使用它的容器及其并发性。 出现此情况时，还会记录错误消息。ConsumerStartingEventconsumerStartTimeoutspring-doc.cn

  • ListenerContainerIdleEvent：在未收到任何消息时发布（如果已配置）。idleEventIntervalspring-doc.cn

  • ListenerContainerNoLongerIdleEvent：在之前发布 .ListenerContainerIdleEventspring-doc.cn

  • ListenerContainerPartitionIdleEvent：未从中的该分区收到任何消息时发布（如果已配置）。idlePartitionEventIntervalspring-doc.cn

  • ListenerContainerPartitionNoLongerIdleEvent：当从之前发布 .ListenerContainerPartitionIdleEventspring-doc.cn

  • NonResponsiveConsumerEvent：当使用者似乎在方法中被阻止时发布。pollspring-doc.cn

  • ConsumerPartitionPausedEvent：当分区暂停时，由每个使用者发布。spring-doc.cn

  • ConsumerPartitionResumedEvent：每个 Consumer 在恢复分区时发布的spring-doc.cn

  • ConsumerPausedEvent：在容器暂停时由每个使用者发布。spring-doc.cn

  • ConsumerResumedEvent：容器恢复时由每个使用者发布。spring-doc.cn

  • ConsumerStoppingEvent：由每个使用者在停止前发布。spring-doc.cn

  • ConsumerStoppedEvent：在 Consumer 关闭后发布。 请参见线程安全。spring-doc.cn

  • ConsumerRetryAuthEvent：当消费者的身份验证或授权失败并正在重试时发布。spring-doc.cn

  • ConsumerRetryAuthSuccessfulEvent：成功重试身份验证或授权时发布。只有在之前有 时才会发生。ConsumerRetryAuthEventspring-doc.cn

  • ContainerStoppedEvent：当所有使用者都已停止时发布。spring-doc.cn

  • ConcurrentContainerStoppedEvent：在 已停止时发布。ConcurrentMessageListenerContainerspring-doc.cn

默认情况下，应用程序上下文的事件 multicaster 在调用线程上调用事件侦听器。 如果将 multicaster 更改为使用异步执行程序，则当事件包含对使用者的引用时，不得调用任何方法。Consumer

具有以下属性：ListenerContainerIdleEventspring-doc.cn

  • source：发布事件的侦听器容器实例。spring-doc.cn

  • container：侦听器容器或父侦听器容器（如果源容器是子容器）。spring-doc.cn

  • id：侦听器 ID（或容器 Bean 名称）。spring-doc.cn

  • idleTime：发布事件时容器处于空闲状态的时间。spring-doc.cn

  • topicPartitions：在生成事件时为容器分配的主题和分区。spring-doc.cn

  • consumer：对 Kafka 对象的引用。 例如，如果之前调用了使用者的方法，则在收到事件时可以调用该方法。Consumerpause()resume()spring-doc.cn

  • paused：容器当前是否暂停。 有关更多信息，请参阅暂停和恢复侦听器容器。spring-doc.cn

具有相同的属性，但 和 除外。ListenerContainerNoLongerIdleEventidleTimepausedspring-doc.cn

具有以下属性：ListenerContainerPartitionIdleEventspring-doc.cn

  • source：发布事件的侦听器容器实例。spring-doc.cn

  • container：侦听器容器或父侦听器容器（如果源容器是子容器）。spring-doc.cn

  • id：侦听器 ID（或容器 Bean 名称）。spring-doc.cn

  • idleTime：发布事件时分区消耗处于空闲状态的时间。spring-doc.cn

  • topicPartition：触发事件的主题和分区。spring-doc.cn

  • consumer：对 Kafka 对象的引用。 例如，如果之前调用了使用者的方法，则在收到事件时可以调用该方法。Consumerpause()resume()spring-doc.cn

  • paused：该使用者的分区使用当前是否暂停。 有关更多信息，请参阅暂停和恢复侦听器容器。spring-doc.cn

具有相同的属性，但 和 除外。ListenerContainerPartitionNoLongerIdleEventidleTimepausedspring-doc.cn

具有以下属性：NonResponsiveConsumerEventspring-doc.cn

  • source：发布事件的侦听器容器实例。spring-doc.cn

  • container：侦听器容器或父侦听器容器（如果源容器是子容器）。spring-doc.cn

  • id：侦听器 ID（或容器 Bean 名称）。spring-doc.cn

  • timeSinceLastPoll：容器上次调用 之前的时间。poll()spring-doc.cn

  • topicPartitions：在生成事件时为容器分配的主题和分区。spring-doc.cn

  • consumer：对 Kafka 对象的引用。 例如，如果之前调用了使用者的方法，则在收到事件时可以调用该方法。Consumerpause()resume()spring-doc.cn

  • paused：容器当前是否暂停。 有关更多信息，请参阅暂停和恢复侦听器容器。spring-doc.cn

、 和 事件 具有以下属性：ConsumerPausedEventConsumerResumedEventConsumerStoppingspring-doc.cn

  • source：发布事件的侦听器容器实例。spring-doc.cn

  • container：侦听器容器或父侦听器容器（如果源容器是子容器）。spring-doc.cn

  • partitions：涉及的实例。TopicPartitionspring-doc.cn

事件的 ， 具有以下属性：ConsumerPartitionPausedEventConsumerPartitionResumedEventspring-doc.cn

  • source：发布事件的侦听器容器实例。spring-doc.cn

  • container：侦听器容器或父侦听器容器（如果源容器是子容器）。spring-doc.cn

  • partition：涉及的实例。TopicPartitionspring-doc.cn

该事件具有以下属性：ConsumerRetryAuthEventspring-doc.cn

、 和 事件 具有以下属性：ConsumerStartingEventConsumerStartedEventConsumerFailedToStartEventConsumerStoppedEventConsumerRetryAuthSuccessfulEventContainerStoppedEventspring-doc.cn

  • source：发布事件的侦听器容器实例。spring-doc.cn

  • container：侦听器容器或父侦听器容器（如果源容器是子容器）。spring-doc.cn

所有容器（无论是子容器还是父容器）都会发布 。 对于父容器，source 和 container 属性相同。ContainerStoppedEventspring-doc.cn

此外，它还具有以下附加属性：ConsumerStoppedEventspring-doc.cn

  • reason:spring-doc.cn

    • NORMAL- 消费者正常停止 （容器已停止）。spring-doc.cn

    • ERROR- A 被抛出。java.lang.Errorspring-doc.cn

    • FENCED- 事务生成者已屏蔽，容器属性为 .stopContainerWhenFencedtruespring-doc.cn

    • AUTH- 引发了 OR 且 未配置。AuthenticationExceptionAuthorizationExceptionauthExceptionRetryIntervalspring-doc.cn

    • NO_OFFSET- 分区没有偏移量，策略为 。auto.offset.resetnonespring-doc.cn

在出现此类情况后，您可以使用此事件重新启动容器：spring-doc.cn

if (event.getReason().equals(Reason.FENCED)) {
    event.getSource(MessageListenerContainer.class).start();
}

检测空闲和无响应的使用者

虽然效率很高，但异步使用者的一个问题是检测它们何时处于空闲状态。 如果在一段时间内没有消息到达，您可能需要采取一些措施。spring-doc.cn

您可以将侦听器容器配置为在一段时间后没有消息传递时发布。 当容器处于空闲状态时，每毫秒发布一次事件。ListenerContainerIdleEventidleEventIntervalspring-doc.cn

要配置此功能，请在容器上设置 以下示例显示了如何执行此操作：idleEventIntervalspring-doc.cn

@Bean
public KafkaMessageListenerContainer(ConsumerFactory<String, String> consumerFactory) {
    ContainerProperties containerProps = new ContainerProperties("topic1", "topic2");
    ...
    containerProps.setIdleEventInterval(60000L);
    ...
    KafkaMessageListenerContainer<String, String> container = new KafKaMessageListenerContainer<>(consumerFactory, containerProps);
    return container;
}

以下示例演示如何为 ：idleEventInterval@KafkaListenerspring-doc.cn

@Bean
public ConcurrentKafkaListenerContainerFactory kafkaListenerContainerFactory() {
    ConcurrentKafkaListenerContainerFactory<String, String> factory =
                new ConcurrentKafkaListenerContainerFactory<>();
    ...
    factory.getContainerProperties().setIdleEventInterval(60000L);
    ...
    return factory;
}

在上述每种情况下，当容器处于空闲状态时，每分钟发布一次事件。spring-doc.cn

如果由于某种原因，consumer 方法没有退出，则不会收到任何消息，并且无法生成空闲事件（当无法访问代理时，这是早期版本的问题）。 在这种情况下，如果 poll 未在属性中返回，则容器会发布 。 默认情况下，每个容器中每 30 秒执行一次此检查。 您可以通过在配置侦听器容器时在 中设置 （默认 30 秒） 和 （默认 3.0） 属性来修改此行为。 这应该大于以避免由于争用条件而获得虚假事件。 接收此类事件可让您停止容器，从而唤醒使用者，使其可以停止。poll()kafka-clientsNonResponsiveConsumerEvent3xpollTimeoutmonitorIntervalnoPollThresholdContainerPropertiesnoPollThreshold1.0spring-doc.cn

从版本 2.6.2 开始，如果容器发布了 ，它将在随后收到记录时发布 。ListenerContainerIdleEventListenerContainerNoLongerIdleEventspring-doc.cn

事件消耗

您可以通过实现来捕获这些事件 — 通用侦听器或缩小范围以仅接收此特定事件的侦听器。 您还可以使用 Spring Framework 4.2 中引入的 。ApplicationListener@EventListenerspring-doc.cn

下一个示例将 和 合并为一个类。 您应该了解应用程序侦听器会获取所有容器的事件，因此，如果您想根据哪个容器处于空闲状态来执行特定操作，则可能需要检查侦听器 ID。 您也可以将 用于此目的。@KafkaListener@EventListener@EventListenerconditionspring-doc.cn

有关事件属性的信息，请参阅应用程序事件。spring-doc.cn

该事件通常在使用者线程上发布，因此与对象交互是安全的。Consumerspring-doc.cn

以下示例同时使用 和 ：@KafkaListener@EventListenerspring-doc.cn

public class Listener {

    @KafkaListener(id = "qux", topics = "annotated")
    public void listen4(@Payload String foo, Acknowledgment ack) {
        ...
    }

    @EventListener(condition = "event.listenerId.startsWith('qux-')")
    public void eventHandler(ListenerContainerIdleEvent event) {
        ...
    }

}
事件侦听器查看所有容器的事件。 因此，在前面的示例中，我们根据侦听器 ID 缩小接收的事件范围。 由于为 创建的容器支持并发，因此实际容器的命名方式为 ，其中 是支持并发的每个实例的唯一值。 这就是我们在 CONDITION 中使用的原因。@KafkaListenerid-nnstartsWith
如果您希望使用 idle 事件来停止侦听器容器，则不应在调用侦听器的线程上调用。 这样做会导致延迟和不必要的日志消息。 相反，您应该将事件移交给其他线程，然后该线程可以停止容器。 此外，如果容器实例是子容器，则不应使用容器实例。 您应该改为停止并发容器。container.stop()stop()

空闲时的当前位置

注意，当检测到 idle 时，你可以通过在 Listener 中实现来获取当前位置。 见 in seek.ConsumerSeekAwareonIdleContainer()spring-doc.cn