查找特定偏移量
为了定位，您的监听器必须实现 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);
String getGroupId();seek 方法的两种不同变体提供了一种定位到任意偏移量的方法。接受 Function 作为参数来计算偏移量的方法是在框架的 3.2 版中添加的。此函数提供了对当前偏移量的访问（消费者返回的当前位置，即要获取的下一个偏移量）。用户可以根据函数定义中消费者的当前偏移量来决定要定位到哪个偏移量。
seekRelative 在 2.3 版中添加，用于执行相对定位。
-
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() {
getTopicsAndCallbacks()
.forEach((tp, callbacks) ->
callbacks.forEach(callback -> callback.seekRelative(tp.topic(), tp.partition(), -1, true))
);
}
/**
* Rewind one partition one record.
*/
public void rewindOnePartitionOneRecord(String topic, int partition) {
getSeekCallbacksFor(new TopicPartition(topic, partition))
.forEach(callback -> callback.seekRelative(topic, partition, -1, true));
}
}2.6 版向抽象类添加了便利方法：
-
seekToBeginning()- 将所有分配的分区定位到开头。 -
seekToEnd()- 将所有分配的分区定位到末尾。 -
seekToTimestamp(long timestamp)- 将所有分配的分区定位到该时间戳表示的偏移量。
示例
public class MyListener extends AbstractConsumerSeekAware {
@KafkaListener(...)
void listen(...) {
...
}
}
public class SomeOtherBean {
MyListener listener;
...
void someMethod() {
this.listener.seekToTimestamp(System.currentTimeMillis() - 60_000);
}
}自 3.3 版起，ConsumerSeekAware.ConsumerSeekCallback 接口中引入了一个新方法 getGroupId()。当您需要识别与特定定位回调关联的消费者组时，此方法特别有用。
当使用扩展 AbstractConsumerSeekAware 的类时，在一个监听器中执行的定位操作可能会影响同一类中的所有监听器。这可能并非总是所需行为。为了解决此问题，您可以使用回调提供的 getGroupId() 方法。这允许您有选择地执行定位操作，仅针对感兴趣的消费者组。 |
