顺序消息(FIFO消息)是消息队列RocketMQ版提供的一种严格按照顺序来发布和消费的消息类型。本文提供使用HTTP协议下的C# SDK收发顺序消息的示例代码。

背景信息

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

更多信息,请参见顺序消息

前提条件

您已完成以下操作:

  • 安装C# SDK。更多信息,请参见准备环境
  • 创建资源。代码中涉及的资源信息,例如实例、Topic和Group ID等,需要在控制台上提前创建。更多信息,请参见创建资源

发送顺序消息

发送顺序消息的示例代码如下。

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}";
        // AccessKey ID阿里云身份验证,在阿里云RAM控制台创建。
        private const string _accessKeyId = "${ACCESS_KEY}";
        // AccessKey Secret阿里云身份验证,在阿里云RAM控制台创建。
        private const string _secretAccessKey = "${SECRET_KEY}";
        // 消息所属的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}";
        // AccessKey ID阿里云身份验证,在阿里云RAM控制台创建。
        private const string _accessKeyId = "${ACCESS_KEY}";
        // AccessKey Secret阿里云身份验证,在阿里云RAM控制台创建。
        private const string _secretAccessKey = "${SECRET_KEY}";
        // 消息所属的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);
                }
            }
        }
    }
}