初始 Kafka Consumer 消费者 (2)

要认识 Kafka 的消费者,个人认为最好的办法就是从它的类图着手,下面给出 Consumer 接口的类图。

在这里插入图片描述


接下来对起重点方法进行一个初步的介绍,从下篇文章开始将对其进行详细设计。

Set< TopicPartition> assignment()
获取该消费者的队列分配列表。

Set< String> subscription()
获取该消费者的订阅信息。

void subscribe(Collection< String> topics)
订阅主题。

void subscribe(Collection< String> topics, ConsumerRebalanceListener callback)
订阅主题,并指定队列重平衡的监听器。

void assign(Collection< TopicPartition> partitions)
取代 subscription,手动指定消费哪些队列。

void unsubscribe()
取消订阅关系。

ConsumerRecords<K, V> poll(Duration timeout)
拉取消息,是 KafkaConsumer 的核心方法,将在下文详细介绍。

void commitSync()
同步提交消费进度,为本批次的消费提交,将在后续文章中详细介绍。

void commitSync(Duration timeout)
同步提交消费进度,可设置超时时间。

void commitSync(Map<TopicPartition, OffsetAndMetadata> offsets)
显示同步提交消费进度, offsets 指明需要提交消费进度的信息。

void commitSync(final Map<TopicPartition, OffsetAndMetadata> offsets, final Duration timeout)
显示同步提交消费进度,带超时间。

void seek(TopicPartition partition, long offset)
重置 consumer#poll 方法下一次拉消息的偏移量。

void seek(TopicPartition partition, OffsetAndMetadata offsetAndMetadata)
seek 方法重载方法。

void seekToBeginning(Collection< TopicPartition> partitions)
将 poll 方法下一次的拉取偏移量设置为队列的初始偏移量。

void seekToEnd(Collection< TopicPartition> partitions)
将 poll 方法下一次的拉取偏移量设置为队列的最大偏移量。

long position(TopicPartition partition)
获取将被拉取的偏移量。

long position(TopicPartition partition, final Duration timeout)
同上。

OffsetAndMetadata committed(TopicPartition partition)
获取指定分区已提交的偏移量。

OffsetAndMetadata committed(TopicPartition partition, final Duration timeout)
同上。

Map<MetricName, ? extends Metric> metrics()
统计指标。

List< PartitionInfo> partitionsFor(String topic)
获取主题的路由信息。

List< PartitionInfo> partitionsFor(String topic, Duration timeout)
同上。

Map<String, List< PartitionInfo>> listTopics()
获取所有 topic 的路由信息。

Map<String, List< PartitionInfo>> listTopics(Duration timeout)
同上。

Set< TopicPartition> paused()
获取已挂起的分区信息。

void pause(Collection< TopicPartition> partitions)
挂起分区,下一次 poll 方法将不会返回这些分区的消息。

void resume(Collection< TopicPartition> partitions)
恢复挂起的分区。

Map<TopicPartition, OffsetAndTimestamp> offsetsForTimes(Map<TopicPartition, Long> timestampsToSearch)
根据时间戳查找最近的一条消息的偏移量。

Map<TopicPartition, OffsetAndTimestamp> offsetsForTimes(Map<TopicPartition, Long> timestampsToSearch, Duration timeout)
同上。

Map<TopicPartition, Long> beginningOffsets(Collection< TopicPartition> partitions)
查询指定分区当前最小的偏移量。

Map<TopicPartition, Long> beginningOffsets(Collection< TopicPartition> partitions, Duration timeout)
同上。

Map<TopicPartition, Long> endOffsets(Collection< TopicPartition> partitions)
查询指定分区当前最大的偏移量。

Map<TopicPartition, Long> endOffsets(Collection< TopicPartition> partitions, Duration timeout)
同上。

void close()
关闭消费者。

void close(Duration timeout)
关闭消费者。

void wakeup()
唤醒消费者。

4、初始 KafkaConsumer

在这里插入图片描述


接下来笔者根据其构造函数,对一一介绍其核心属性的含义,为接下来讲解其核心方法打下基础。

String groupId
消费组ID。同一个消费组内的多个消费者共同消费一个主题下的消息。

内容版权声明:除非注明,否则皆为本站原创文章。

转载注明出处:https://www.heiqu.com/zywdff.html