接口和参数说明

背景信息

云消息队列 RocketMQ 版支持以下两种消息获取方式：

• Push：消息由云消息队列 RocketMQ 版推送至Consumer。Push方式下，云消息队列 RocketMQ 版还支持批量消费功能，可以将消息统一批量推送至Consumer进行消费。更多信息，请参见批量消费。

• Pull：消息由Consumer主动从云消息队列 RocketMQ 版拉取。

Pull Consumer提供了更多接收消息的选择。相比于Push Consumer，您可以使用Pull Consumer更加自由地控制消息拉取。

通用参数

消息发送接口

消息发送参数

消息订阅接口

Pull方式的接口说明如下所示。

public interface PullConsumer extends Admin {

    /**
     * 获取某个Topic下的分区信息，返回结果是该Topic下的所有分区。注意该接口必须在Pull Consumer Start以后才能被调用。
     */
    Set<TopicPartition> topicPartitions(String topic);

    /**
     * 指定需要拉取消息的分区，此接口不会参与Rebalance，您需要自己保证所有分区得到消费。此外，若多次调用此接口会替换掉原来订阅的分区，并不会增量增加订阅分区的数量。
     */
    void assign(Collection<TopicPartition> topicPartitions);

    /**
     * 拉取消息，单次最多拉取maxBatchMessageCount个消息，超时时间您可以自定义，单位为毫秒。
     */
    List<Message> poll(long timeout);

    /**
     * 将指定的分区的消费位点重置到某个指定位置。该位置必须在分区的最小位点和最大位点之间。注意该接口必须在Pull Consumer Start以后才能被调用，并且指定的分区必须为订阅的分区。
     */
    void seek(TopicPartition topicPartition, long offset);

    /**
     * 将指定分区的消费位点重置到该分区的最小位点。注意该接口必须在Pull Consumer Start以后才能被调用，并且指定的分区必须为订阅的分区。
     */
    void seekToBeginning(TopicPartition topicPartition);

    /**
     * 将指定分区的消费位点重置到该分区的最大位点。注意该接口必须在Pull Consumer Start以后才能被调用，并且指定的分区必须为订阅的分区。
     */
    void seekToEnd(TopicPartition topicPartition);

    /**
     * 暂停指定分区的消费。
     */
    void pause(Collection<TopicPartition> topicPartitions);

    /**
     * 恢复指定分区的消费。
     */
    void resume(Collection<TopicPartition> topicPartitions);

    /**
     * 查找指定分区对应时间戳的位点。该时间戳为消息存储到服务器的时间戳。该位点是指定分区中第一个存储时间戳大于或等于该时间戳消息对应的位点。
     */
    Long offsetForTimestamp(TopicPartition topicPartition, Long timestamp);

    /**
     * 获取指定分区的最新消费位点。
     */
    Long committed(TopicPartition topicPartition);

    /**
     * 手动提交消费位点，该消费位点首先同步到本地，再由异步线程提交到服务器。
     */
    void commitSync();
    
    interface TopicPartitionChangeListener {
        /**
         * 该方法在某个Topic下分区发生变化时被调用，例如在服务端扩缩容时造成Topic的分区数量发生变化时回调该方法。
         */
        void onChanged(Set<TopicPartition> topicPartitions);
    }
    
    /**
     * 注册监听某个Topic分区变化的TopicPartitionChangeListener。例如注册后在服务端扩缩容时造成Topic的分区数量发生变化时回调listener的onChanged方法，默认最多5秒左右延迟。
     */
    void registerTopicPartitionChangedListener(String topic, TopicPartitionChangeListener callback);
}

消息订阅参数

分区和位点的详细说明，请参见基本概念。

更多信息

消息收发示例代码的更多信息，请参见以下文档：

• 发送普通消息（三种方式）

• 收发顺序消息

• 收发定时消息

• 收发延时消息

• 收发事务消息

• 订阅消息