收發順序訊息 - ApsaraMQ for RocketMQ

順序訊息（FIFO訊息）是雲訊息佇列 RocketMQ 版提供的一種嚴格按照順序來發布和消費的訊息類型。本文提供使用HTTP協議下的C++ SDK收發順序訊息的範例程式碼。

背景資訊

順序訊息分為兩類：

全域順序：對於指定的一個Topic，所有訊息按照嚴格的先入先出FIFO（First In First Out）的順序進行發布和消費。
分區順序：對於指定的一個Topic，所有訊息根據Sharding Key進行區塊分區。同一個分區內的訊息按照嚴格的FIFO順序進行發布和消費。Sharding Key是順序訊息中用來區分不同分區的關鍵字段，和普通訊息的Key是完全不同的概念。

更多資訊，請參見順序訊息。

前提條件

您已完成以下操作：

安裝C++ SDK。更多資訊，請參見準備環境。
建立資源。代碼中涉及的資源資訊，例如執行個體、Topic和Group ID等，需要在控制台上提前建立。更多資訊，請參見建立資源。
擷取阿里雲存取金鑰AccessKey ID和AccessKey Secret。更多資訊，請參見建立AccessKey。

發送順序訊息

重要

雲訊息佇列 RocketMQ 版服務端判定訊息產生的順序性是參照單一生產者、單一線程並發下訊息發送的時序。如果發送方有多個生產者或者有多個線程並發發送訊息，則此時只能以到達雲訊息佇列 RocketMQ 版服務端的時序作為訊息順序的依據，和業務側的發送順序未必一致。

發送順序訊息的範例程式碼如下。

//#include <iostream>
#include <fstream>
#include <time.h>
#include "mq_http_sdk/mq_client.h"

using namespace std;
using namespace mq::http::sdk;


int main() {

    MQClient mqClient(
            // 設定HTTP協議用戶端存取點，進入訊息佇列RocketMQ版控制台執行個體詳情頁面的存取點地區查看。
            "${HTTP_ENDPOINT}",
            // 請確保環境變數ALIBABA_CLOUD_ACCESS_KEY_ID、ALIBABA_CLOUD_ACCESS_KEY_SECRET已設定。
	          // AccessKey ID，阿里雲身分識別驗證標識。
	          System.getenv("ALIBABA_CLOUD_ACCESS_KEY_ID"),
	          // AccessKey Secret，阿里雲身分識別驗證密鑰。
	          System.getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET")
            );

    // 訊息所屬的Topic，在訊息佇列RocketMQ版控制台建立。
    string topic = "${TOPIC}";
    // Topic所屬的執行個體ID，在訊息佇列RocketMQ版控制台建立。
    // 若執行個體有命名空間，則執行個體ID必須傳入；若執行個體無命名空間，則執行個體ID傳入null空值或字串空值。執行個體的命名空間可以在訊息佇列RocketMQ版控制台的執行個體詳情頁面查看。
    string instanceId = "${INSTANCE_ID}";

    MQProducerPtr producer;
    if (instanceId == "") {
        producer = mqClient.getProducerRef(topic);
    } else {
        producer = mqClient.getProducerRef(instanceId, topic);
    }

    try {
        // 迴圈發送4條訊息。
        for (int i = 0; i < 8; i++)
        {
            PublishMessageResponse pmResp;
            // 訊息內容。
            TopicMessage pubMsg("Hello, mq!order msg!");
            // 設定分區順序訊息的Sharding Key，用於標識不同的分區。Sharding Key與訊息的Key是完全不同的概念。
            pubMsg.setShardingKey(std::to_string(i % 2));
            // 設定訊息的自訂屬性。
            pubMsg.putProperty("a",std::to_string(i));
            producer->publishMessage(pubMsg, pmResp);
            cout << "Publish mq message success. Topic is: " << topic
                << ", msgId is:" << pmResp.getMessageId()
                << ", bodyMD5 is:" << pmResp.getMessageBodyMD5() << endl;
        }
    } catch (MQServerException& me) {
        cout << "Request Failed: " + me.GetErrorCode() << ", requestId is:" << me.GetRequestId() << endl;
        return -1;
    } catch (MQExceptionBase& mb) {
        cout << "Request Failed: " + mb.ToString() << endl;
        return -2;
    }

    return 0;
}

訂閱順序訊息

訂閱順序訊息的範例程式碼如下。

#include <vector>
#include <fstream>
#include "mq_http_sdk/mq_client.h"

#ifdef _WIN32
#include <windows.h>
#else
#include <unistd.h>
#endif

using namespace std;
using namespace mq::http::sdk;


int main() {

    MQClient mqClient(
            // 設定HTTP協議用戶端存取點，進入訊息佇列RocketMQ版控制台執行個體詳情頁面的存取點地區查看。
            "${HTTP_ENDPOINT}",
            // 請確保環境變數ALIBABA_CLOUD_ACCESS_KEY_ID、ALIBABA_CLOUD_ACCESS_KEY_SECRET已設定。
	          // AccessKey ID，阿里雲身分識別驗證標識。
	          System.getenv("ALIBABA_CLOUD_ACCESS_KEY_ID"),
	          // AccessKey Secret，阿里雲身分識別驗證密鑰。
	          System.getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET")
            );

    // 訊息所屬的Topic，在訊息佇列RocketMQ版控制台建立。
    string topic = "${TOPIC}";
    // 您在訊息佇列RocketMQ版控制台建立的Group ID。
    string groupId = "${GROUP_ID}";
    // Topic所屬的執行個體ID，在訊息佇列RocketMQ版控制台建立。
    // 若執行個體有命名空間，則執行個體ID必須傳入；若執行個體無命名空間，則執行個體ID傳入null空值或字串空值。執行個體的命名空間可以在訊息佇列RocketMQ版控制台的執行個體詳情頁面查看。
    string instanceId = "${INSTANCE_ID}";

    MQConsumerPtr consumer;
    if (instanceId == "") {
        consumer = mqClient.getConsumerRef(topic, groupId);
    } else {
        consumer = mqClient.getConsumerRef(instanceId, topic, groupId, "");
    }

    do {
        try {
            std::vector<Message> messages;
            // 長輪詢順序消費訊息, 拉取到的訊息可能是多個分區的（對於分區順序訊息），一個分區內的訊息一定是順序的。
            // 對於分區順序訊息，只要一個分區記憶體在沒有被確認消費的訊息，那麼該分區下次還會消費到相同的訊息。
            // 對於一個分區，只有所有訊息確認消費成功才能消費下一批訊息。
            // 長輪詢表示如果Topic沒有訊息，則請求會在服務端掛起3s，3s內如果有訊息可以消費則服務端立即返迴響應。
            consumer->consumeMessageOrderly(
                    3, // 一次最多消費3條（最多可設定為16條）。
                    3, // 長輪詢時間3秒（最多可設定為30秒）。
                    messages
            );
            cout << "Consume: " << messages.size() << " Messages!" << endl;

            // 處理商務邏輯。
            std::vector<std::string> receiptHandles;
            for (std::vector<Message>::iterator iter = messages.begin();
                    iter != messages.end(); ++iter)
            {
                cout << "MessageId: " << iter->getMessageId()
                    << " PublishTime: " << iter->getPublishTime()
                    << " Tag: " << iter->getMessageTag()
                    << " Body: " << iter->getMessageBody()
                    << " FirstConsumeTime: " << iter->getFirstConsumeTime()
                    << " NextConsumeTime: " << iter->getNextConsumeTime()
                    << " ConsumedTimes: " << iter->getConsumedTimes()
                    << " Properties: " << iter->getPropertiesAsString()
                    << " ShardingKey: " << iter->getShardingKey() << endl;
                receiptHandles.push_back(iter->getReceiptHandle());
            }

            // 確認訊息消費成功。
            // Message.NextConsumeTime前若不確認訊息消費成功，則訊息會被重複消費。
            // 訊息控制代碼有時間戳記，同一條訊息每次消費拿到的都不一樣。
            AckMessageResponse bdmResp;
            consumer->ackMessage(receiptHandles, bdmResp);
            if (!bdmResp.isSuccess()) {
                // 某些訊息的控制代碼可能逾時，會導致訊息消費狀態確認不成功。
                const std::vector<AckMessageFailedItem>& failedItems =
                    bdmResp.getAckMessageFailedItem();
                for (std::vector<AckMessageFailedItem>::const_iterator iter = failedItems.begin();
                        iter != failedItems.end(); ++iter)
                {
                    cout << "AckFailedItem: " << iter->errorCode
                        << "  " << iter->receiptHandle << endl;
                }
            } else {
                cout << "Ack: " << messages.size() << " messages suc!" << endl;
            }
        } catch (MQServerException& me) {
            if (me.GetErrorCode() == "MessageNotExist") {
                cout << "No message to consume! RequestId: " + me.GetRequestId() << endl;
                continue;
            }
            cout << "Request Failed: " + me.GetErrorCode() + ".RequestId: " + me.GetRequestId() << endl;
#ifdef _WIN32
            Sleep(2000);
#else
            usleep(2000 * 1000);
#endif
        } catch (MQExceptionBase& mb) {
            cout << "Request Failed: " + mb.ToString() << endl;
#ifdef _WIN32
            Sleep(2000);
#else
            usleep(2000 * 1000);
#endif
        }

    } while(true);
}