全部產品
Search
文件中心

ApsaraMQ for RocketMQ:收發順序訊息

更新時間:Jul 01, 2024

順序訊息(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

發送順序訊息

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

using System;
using System.Collections.Generic;
using System.Threading;
using Aliyun.MQ.Model;
using Aliyun.MQ.Model.Exp;
using Aliyun.MQ.Util;

namespace Aliyun.MQ.Sample
{
    public class OrderProducerSample
    {
        // 設定HTTP協議用戶端存取點,進入訊息佇列RocketMQ版控制台執行個體詳情頁面的存取點地區查看。
        private const string _endpoint = "${HTTP_ENDPOINT}";
        // 請確保環境變數ALIBABA_CLOUD_ACCESS_KEY_ID、ALIBABA_CLOUD_ACCESS_KEY_SECRET已設定。
        // AccessKey ID,阿里雲身分識別驗證標識。
        private const string _accessKeyId = Environment.GetEnvironmentVariable("ALIBABA_CLOUD_ACCESS_KEY_ID");
        // AccessKey Secret,阿里雲身分識別驗證密鑰。
        private const string _secretAccessKey = Environment.GetEnvironmentVariable("ALIBABA_CLOUD_ACCESS_KEY_SECRET");
        // 訊息所屬的Topic,在訊息佇列RocketMQ版控制台建立。
        private const string _topicName = "${TOPIC}";
        // Topic所屬的執行個體ID,在訊息佇列RocketMQ版控制台建立。
        // 若執行個體有命名空間,則執行個體ID必須傳入;若執行個體無命名空間,則執行個體ID傳入null空值或字串空值。執行個體的命名空間可以在訊息佇列RocketMQ版控制台的執行個體詳情頁面查看。
        private const string _instanceId = "${INSTANCE_ID}";

        private static MQClient _client = new Aliyun.MQ.MQClient(_accessKeyId, _secretAccessKey, _endpoint);

        static MQProducer producer = _client.GetProducer(_instanceId, _topicName);

        static void Main(string[] args)
        {
            try
            {
                // 迴圈發送8條訊息。
                for (int i = 0; i < 8; i++)
                {
                    // 訊息內容和訊息的tag。
                    TopicMessage sendMsg = new TopicMessage("hello mq", "tag");
                    // 設定訊息的自訂屬性。
                    sendMsg.PutProperty("a", i.ToString());
                    // 設定分區順序訊息的Sharding Key,用於標識不同的分區。Sharding Key與訊息的Key是完全不同的概念。
                    sendMsg.ShardingKey = (i % 2).ToString();
                    TopicMessage result = producer.PublishMessage(sendMsg);
                    Console.WriteLine("publis message success:" + result);
                }
            }
            catch (Exception ex)
            {
                Console.Write(ex);
            }
        }
    }
}

訂閱順序訊息

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

using System;
using System.Collections.Generic;
using System.Threading;
using Aliyun.MQ.Model;
using Aliyun.MQ.Model.Exp;
using Aliyun.MQ;

namespace Aliyun.MQ.Sample
{
    public class OrderConsumerSample
{
        // 設定HTTP協議用戶端存取點,進入訊息佇列RocketMQ版控制台執行個體詳情頁面的存取點地區查看。
        private const string _endpoint = "${HTTP_ENDPOINT}";
        // 請確保環境變數ALIBABA_CLOUD_ACCESS_KEY_ID、ALIBABA_CLOUD_ACCESS_KEY_SECRET已設定。
        // AccessKey ID,阿里雲身分識別驗證標識。
        private const string _accessKeyId = Environment.GetEnvironmentVariable("ALIBABA_CLOUD_ACCESS_KEY_ID");
        // AccessKey Secret,阿里雲身分識別驗證密鑰。
        private const string _secretAccessKey = Environment.GetEnvironmentVariable("ALIBABA_CLOUD_ACCESS_KEY_SECRET");
        // 訊息所屬的Topic,在訊息佇列RocketMQ版控制台建立。
        private const string _topicName = "${TOPIC}";
        // 您在訊息佇列RocketMQ版控制台建立的Group ID。
        private const string _groupId = "${GROUP_ID}";
        // Topic所屬的執行個體ID,在訊息佇列RocketMQ版控制台建立。
        // 若執行個體有命名空間,則執行個體ID必須傳入;若執行個體無命名空間,則執行個體ID傳入null空值或字串空值。執行個體的命名空間可以在訊息佇列RocketMQ版控制台的執行個體詳情頁面查看。
private const string _instanceId = "${INSTANCE_ID}";
        
        private static MQClient _client = new Aliyun.MQ.MQClient(_accessKeyId, _secretAccessKey, _endpoint);
        static MQConsumer consumer = _client.GetConsumer(_instanceId, _topicName, _groupId, null);

        static void Main(string[] args)
        {
            // 在當前線程迴圈消費訊息,建議多開個幾個線程並發消費訊息。
            while (true)
            {
                try
                {
                    // 長輪詢順序消費訊息, 拉取到的訊息可能是多個分區的(對於分區順序訊息),一個分區內的訊息一定是順序的。
                    // 對於分區順序訊息,只要一個分區記憶體在沒有被確認消費的訊息,那麼該分區下次還會消費到相同的訊息。
                    // 對於一個分區,只有所有訊息確認消費成功才能消費下一批訊息。
                    // 長輪詢表示如果Topic沒有訊息,則請求會在服務端掛起3s,3s內如果有訊息可以消費則服務端立即返迴響應。
                    List<Message> messages = null;

                    try
                    {
                        messages = consumer.ConsumeMessageOrderly(
                            3, // 一次最多消費3條(最多可設定為16條)。
                            3 // 長輪詢時間3秒(最多可設定為30秒)。
                        );
                    }
                    catch (Exception exp1)
                    {
                        if (exp1 is MessageNotExistException)
                        {
                            Console.WriteLine(Thread.CurrentThread.Name + " No new message, " + ((MessageNotExistException)exp1).RequestId);
                            continue;
                        }
                        Console.WriteLine(exp1);
                        Thread.Sleep(2000);
                    }

                    if (messages == null)
                    {
                        continue;
                    }

                    List<string> handlers = new List<string>();
                    Console.WriteLine(Thread.CurrentThread.Name + " Receive Messages:");
                    // 處理商務邏輯。
                    foreach (Message message in messages)
                    {
                        Console.WriteLine(message);
                        Console.WriteLine("Property a is:" + message.GetProperty("a"));
                        handlers.Add(message.ReceiptHandle);
                    }
                    // Message.nextConsumeTime前若不確認訊息消費成功,則訊息會被重複消費。
                    // 訊息控制代碼有時間戳記,同一條訊息每次消費拿到的都不一樣。
                    try
                    {
                        consumer.AckMessage(handlers);
                        Console.WriteLine("Ack message success:");
                        foreach (string handle in handlers)
                        {
                            Console.Write("\t" + handle);
                        }
                        Console.WriteLine();
                    }
                    catch (Exception exp2)
                    {
                        // 某些訊息的控制代碼可能逾時,會導致訊息消費狀態確認不成功。
                        if (exp2 is AckMessageException)
                        {
                            AckMessageException ackExp = (AckMessageException)exp2;
                            Console.WriteLine("Ack message fail, RequestId:" + ackExp.RequestId);
                            foreach (AckMessageErrorItem errorItem in ackExp.ErrorItems)
                            {
                                Console.WriteLine("\tErrorHandle:" + errorItem.ReceiptHandle + ",ErrorCode:" + errorItem.ErrorCode + ",ErrorMsg:" + errorItem.ErrorMessage);
                            }
                        }
                    }
                }
                catch (Exception ex)
                {
                    Console.WriteLine(ex);
                    Thread.Sleep(2000);
                }
            }
        }
    }
}