寻求特定偏移量

要进行查找，你的侦听器必须实现 ConsumerSeekAware，它具有以下方法

void registerSeekCallback(ConsumerSeekCallback callback);

void onPartitionsAssigned(Map<TopicPartition, Long> assignments, ConsumerSeekCallback callback);

void onPartitionsRevoked(Collection<TopicPartition> partitions)

void onIdleContainer(Map<TopicPartition, Long> assignments, ConsumerSeekCallback callback);

当容器启动以及每当分配分区时，都会调用 registerSeekCallback。你应该在初始化后在任意时间进行查找时使用此回调。你应该保存对回调的引用。如果你在多个容器（或在 ConcurrentMessageListenerContainer）中使用相同的侦听器，你应该将回调存储在 ThreadLocal 或由侦听器 Thread 作为键的其他结构中。

在使用组管理时，当分配分区时，会调用 onPartitionsAssigned。例如，你可以通过调用回调来使用此方法设置分区的初始偏移量。你还可以使用此方法将此线程的回调与已分配的分区关联（请参见下面的示例）。你必须使用回调参数，而不是传递到 registerSeekCallback 中的参数。从 2.5.5 版本开始，即使使用手动分区分配，也会调用此方法。

当容器停止或 Kafka 撤销分配时，会调用 onPartitionsRevoked。你应该丢弃此线程的回调并删除与已撤销分区的任何关联。

回调具有以下方法

void seek(String topic, int partition, long offset);

void seek(String topic, int partition, Function<Long, Long> offsetComputeFunction);

void seekToBeginning(String topic, int partition);

void seekToBeginning(Collection<TopicPartitions> partitions);

void seekToEnd(String topic, int partition);

void seekToEnd(Collection<TopicPartitions> partitions);

void seekRelative(String topic, int partition, long offset, boolean toCurrent);

void seekToTimestamp(String topic, int partition, long timestamp);

void seekToTimestamp(Collection<TopicPartition> topicPartitions, long timestamp);

seek 方法的两种不同变体提供了一种查找任意偏移量的方法。从框架的 3.2 版本开始添加了将 Function 作为计算偏移量的参数的方法。此函数提供对当前偏移量的访问（消费者返回的当前位置，即要获取的下一个偏移量）。用户可以根据函数定义中消费者中的当前偏移量决定要查找的偏移量。

在 2.3 版本中添加了 seekRelative，以执行相对查找。

offset 为负且 toCurrent 为 false - 相对于分区末尾进行查找。
offset 为正且 toCurrent 为 false - 相对于分区开头进行查找。
offset 为负且 toCurrent 为 true - 相对于当前位置进行查找（倒带）。
offset 为正且 toCurrent 为 true - 相对于当前位置进行查找（快进）。

seekToTimestamp 方法也在 2.3 版本中添加。

在 onIdleContainer 或 onPartitionsAssigned 方法中为多个分区查找相同的时间戳时，首选第二种方法，因为在对消费者的 offsetsForTimes 方法进行一次调用时，查找时间戳的偏移量更有效率。从其他位置调用时，容器将收集所有时间戳查找请求并对 offsetsForTimes 进行一次调用。

当检测到空闲容器时，您还可以在 onIdleContainer() 中执行查找操作。有关如何启用空闲容器检测，请参阅检测空闲和无响应的使用者。

例如，当处理压缩主题并且希望在每次启动应用程序时都查找开头时，接受集合的 seekToBeginning 方法非常有用

public class MyListener implements ConsumerSeekAware {

    ...

    @Override
    public void onPartitionsAssigned(Map<TopicPartition, Long> assignments, ConsumerSeekCallback callback) {
        callback.seekToBeginning(assignments.keySet());
    }

}

要在运行时任意查找，请使用适当线程的 registerSeekCallback 的回调引用。

这是一个简单的 Spring Boot 应用程序，演示了如何使用回调；它向主题发送 10 条记录；在控制台中按 <Enter> 会导致所有分区查找开头。

@SpringBootApplication
public class SeekExampleApplication {

    public static void main(String[] args) {
        SpringApplication.run(SeekExampleApplication.class, args);
    }

    @Bean
    public ApplicationRunner runner(Listener listener, KafkaTemplate<String, String> template) {
        return args -> {
            IntStream.range(0, 10).forEach(i -> template.send(
                new ProducerRecord<>("seekExample", i % 3, "foo", "bar")));
            while (true) {
                System.in.read();
                listener.seekToStart();
            }
        };
    }

    @Bean
    public NewTopic topic() {
        return new NewTopic("seekExample", 3, (short) 1);
    }

}

@Component
class Listener implements ConsumerSeekAware {

    private static final Logger logger = LoggerFactory.getLogger(Listener.class);

    private final ThreadLocal<ConsumerSeekCallback> callbackForThread = new ThreadLocal<>();

    private final Map<TopicPartition, ConsumerSeekCallback> callbacks = new ConcurrentHashMap<>();

    @Override
    public void registerSeekCallback(ConsumerSeekCallback callback) {
        this.callbackForThread.set(callback);
    }

    @Override
    public void onPartitionsAssigned(Map<TopicPartition, Long> assignments, ConsumerSeekCallback callback) {
        assignments.keySet().forEach(tp -> this.callbacks.put(tp, this.callbackForThread.get()));
    }

    @Override
    public void onPartitionsRevoked(Collection<TopicPartition> partitions) {
        partitions.forEach(tp -> this.callbacks.remove(tp));
        this.callbackForThread.remove();
    }

    @Override
    public void onIdleContainer(Map<TopicPartition, Long> assignments, ConsumerSeekCallback callback) {
    }

    @KafkaListener(id = "seekExample", topics = "seekExample", concurrency = "3")
    public void listen(ConsumerRecord<String, String> in) {
        logger.info(in.toString());
    }

    public void seekToStart() {
        this.callbacks.forEach((tp, callback) -> callback.seekToBeginning(tp.topic(), tp.partition()));
    }

}

为了简化操作，版本 2.3 添加了 AbstractConsumerSeekAware 类，该类跟踪要用于主题/分区的回调。以下示例演示了如何每次容器变为空闲时查找每个分区中处理的最后一条记录。它还具有允许任意外部调用将分区倒回一条记录的方法。

public class SeekToLastOnIdleListener extends AbstractConsumerSeekAware {

    @KafkaListener(id = "seekOnIdle", topics = "seekOnIdle")
    public void listen(String in) {
        ...
    }

    @Override
    public void onIdleContainer(Map<TopicPartition, Long> assignments,
            ConsumerSeekCallback callback) {

            assignments.keySet().forEach(tp -> callback.seekRelative(tp.topic(), tp.partition(), -1, true));
    }

    /**
    * Rewind all partitions one record.
    */
    public void rewindAllOneRecord() {
        getSeekCallbacks()
            .forEach((tp, callback) ->
                callback.seekRelative(tp.topic(), tp.partition(), -1, true));
    }

    /**
    * Rewind one partition one record.
    */
    public void rewindOnePartitionOneRecord(String topic, int partition) {
        getSeekCallbackFor(new TopicPartition(topic, partition))
            .seekRelative(topic, partition, -1, true);
    }

}

版本 2.6 向抽象类添加了便捷方法

seekToBeginning() - 将所有已分配分区查找开头。
seekToEnd() - 将所有已分配分区查找结尾。
seekToTimestamp(long timestamp) - 将所有已分配分区查找表示该时间戳的偏移量。

示例

public class MyListener extends AbstractConsumerSeekAware {

    @KafkaListener(...)
    void listn(...) {
        ...
    }
}

public class SomeOtherBean {

    MyListener listener;

    ...

    void someMethod() {
        this.listener.seekToTimestamp(System.currentTimeMillis() - 60_000);
    }

}