ApsaraMQ for RocketMQ：介面和參數說明

背景資訊

雲訊息佇列 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);
}

訊息訂閱參數

分區和位點的詳細說明，請參見基本概念。

更多資訊

訊息收發範例程式碼的更多資訊，請參見以下文檔：

• 發送普通訊息（三種方式）

• 收發順序訊息

• 收發定時訊息

• 收發延時訊息

• 收發事務訊息

• 訂閱訊息