顺序消息(FIFO 消息)是阿里云 RocketMQ 提供的一种严格按照顺序来发布和消费的消息类型。本文提供使用 TCP 协议下的开源 C++ SDK 收发顺序消息的示例代码供您参考。

顺序消息分为两类:

  • 全局顺序:对于指定的一个 Topic,所有消息按照严格的先入先出(First In First Out,简称 FIFO)的顺序进行发布和消费。
  • 分区顺序:对于指定的一个 Topic,所有消息根据 Sharding Key 进行区块分区。 同一个分区内的消息按照严格的 FIFO 顺序进行发布和消费。Sharding Key 是顺序消息中用来区分不同分区的关键字段,和普通消息的 Key 是完全不同的概念。

详情请参见顺序消息

前提条件

安装 CPP 动态库

发送顺序消息

  1. 将以下代码拷贝到 OrderProducerDemo.cpp 文件中,修改相应的参数后,使用 g++ 命令进行编译,生成可执行文件,即可直接运行。

    g++ -o order_producer_demo -std=c++11 -lz -lrocketmq OrderProducerDemo.cpp

  2. 发送顺序消息的示例代码如下。
    #include <iostream>
    #include <chrono>
    #include <thread>
    #include "DefaultMQProducer.h"
    
    using namespace std;
    using namespace rocketmq;
    
    class ExampleSelectMessageQueueByHash : public MessageQueueSelector {
    public:
        MQMessageQueue select(const std::vector<MQMessageQueue> &mqs, const MQMessage &msg, void *arg) {
            // 实现自定义分区逻辑,根据业务传入 arg 参数即分区键,计算路由到哪个队列,这里以 arg 为 int 型参数为例。
            int orderId = *static_cast<int *>(arg);
            int index = orderId % mqs.size();
            return mqs[0];
        }
    };
    
    int main() {
        std::cout << "=======Before sending messages=======" << std::endl;
        //您在阿里云 RocketMQ 控制台上申请的 GID。
        DefaultMQProducer producer("GID_XXXXXXXX");
        //设置 TCP 协议接入点,从阿里云 RocketMQ 控制台的实例详情页面获取。
        producer.setNamesrvAddr("http://MQ_INST_XXXXXXXXXX.mq-internet-access.mq-internet.aliyuncs.com:80");
        //您在阿里云账号管理控制台中创建的 AccessKeyId 和 AccessKeySecret 用于身份认证,用户渠道,默认值为:ALIYUN。
        producer.setSessionCredentials("AK", "SK", "ALIYUN");
    
        //请确保参数设置完成之后启动Producer。
        producer.start();
        auto start = std::chrono::system_clock::now();
        int count = 32;
        //可以设置发送重试的次数,确保发送成功。
        int retryTimes = 1;
        //参考接口 MessageQueueSelector, 通过设置的自定义参数 arg,计算发送到指定的路由队列中,此处的 arg 便是分区 ID。
        ExampleSelectMessageQueueByHash *pSelector = new ExampleSelectMessageQueueByHash();
        for (int i = 0; i < count; ++i) {
            //发送消息时请设置您在阿里云 RocketMQ 控制台上申请的 Topic。
            MQMessage msg("YOUR ORDERLY TOPIC", "HiTAG", "Hello,CPP SDK, Orderly Message.");
            try {
                SendResult sendResult = producer.send(msg, pSelector, &i, 1, false);
                std::cout << "SendResult:" << sendResult.getSendStatus() << ", Message ID: " << sendResult.getMsgId()
                          << "MessageQueue:" << sendResult.getMessageQueue().toString() << std::endl;
                this_thread::sleep_for(chrono::seconds(1));
            } catch (MQException e) {
                std::cout << "ErrorCode: " << e.GetError() << " Exception:" << e.what() << std::endl;
            }
        }
        auto interval = std::chrono::system_clock::now() - start;
        std::cout << "Send " << count << " messages OK, costs "
                  << std::chrono::duration_cast<std::chrono::milliseconds>(interval).count() << "ms" << std::endl;
    
        producer.shutdown();
        std::cout << "=======After sending messages=======" << std::endl;
        return 0;
    }

消费顺序消息

  1. 将以下代码拷贝到 OrderConsumerDemo.cpp 文件中,修改相应的参数后,使用 g++ 命令进行编译,生成可执行文件,即可直接运行。

    g++ -o order_consumer_demo -std=c++11 -lz -lrocketmq OrderConsumerDemo.cpp

  2. 消费顺序消息的示例代码如下。
    
    #include <iostream>
    #include <thread>
    #include "DefaultMQPushConsumer.h"
    
    using namespace rocketmq;
    
    
    class ExampleOrderlyMessageListener : public MessageListenerOrderly {
    public:
        ConsumeStatus consumeMessage(const std::vector<MQMessageExt> &msgs) {
            for (auto item = msgs.begin(); item != msgs.end(); item++) {
                std::cout << "Received Message Topic:" << item->getTopic() << ", MsgId:" << item->getMsgId() << std::endl;
            }
            return CONSUME_SUCCESS;
        }
    };
    
    int main(int argc, char *argv[]) {
        std::cout << "=======Before consuming messages=======" << std::endl;
        //您在阿里云 RocketMQ 控制台上申请的 GID。
        DefaultMQPushConsumer *consumer = new DefaultMQPushConsumer("GID_XXXXXXXXXXX");
        //设置 TCP 协议接入点,从阿里云 RocketMQ 控制台的实例详情页面获取。
        consumer->setNamesrvAddr("http://MQ_INST_XXXXXXXXXXXXXX.mq-internet-access.mq-internet.aliyuncs.com:80");
        //您在阿里云账号管理控制台中创建的 AccessKeyId 和 AccessKeySecret 用于身份认证,用户渠道,默认值为:ALIYUN。
        consumer->setSessionCredentials("AK", "SK", "ALIYUN");
        auto start = std::chrono::system_clock::now();
    
        //register your own listener here to handle the messages received.
        //请注册自定义侦听函数用来处理接收到的消息,并返回响应的处理结果。
        ExampleOrderlyMessageListener *messageListener = new ExampleOrderlyMessageListener();
        consumer->subscribe("YOUR ORDERLY TOPIC", "*");
        consumer->registerMessageListener(messageListener);
    
        //Start this consumer
        //准备工作完成,必须调用启动函数,才可以正常工作。
        // ********************************************
        // 1.确保订阅关系的设置在启动之前完成。
        // 2.确保相同 GID 下面的消费者的订阅关系一致。
        // *********************************************
        consumer->start();
    
        //Keep main thread running until process finished.
        //请保持线程常驻,不要执行shutdown 操作。
        std::this_thread::sleep_for(std::chrono::seconds (60 ));
        consumer->shutdown();
        std::cout << "=======After consuming messages======" << std::endl;
        return 0;
    }