收發事務訊息 - ApsaraMQ for RocketMQ

雲訊息佇列 RocketMQ 版提供類似XA或Open XA的分散式交易功能，通過雲訊息佇列 RocketMQ 版事務訊息，能達到分散式交易的最終一致。本文提供使用HTTP協議下的C# SDK收發事務訊息的範例程式碼。

背景資訊

事務訊息的互動流程如下圖所示。

圖片1.png

更多資訊，請參見事務訊息。

前提條件

您已完成以下操作：

安裝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 TransProducerSample
    {
        // 設定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}";
        // 您在訊息佇列RocketMQ版控制台建立的Group ID。
        private const string _groupId = "${GROUP_ID}";

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

        private static readonly MQTransProducer transProducer = _client.GetTransProdcuer(_instanceId, _topicName, _groupId);

        static void ProcessAckError(Exception exception)
        {
            // 如果Commit或Rollback時超過了TransCheckImmunityTime（針對發送事務訊息的控制代碼）或者超過10s（針對consumeHalfMessage的控制代碼），則Commit或Rollback會失敗。
            if (exception is AckMessageException)
            {
                AckMessageException ackExp = (AckMessageException)exception;
                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);
                }
            }
        }

        static void ConsumeHalfMessage()
        {
            int count = 0;
            while (true)
            {
                if (count == 3)
                    break;
                try
                {
                    // 檢查事務半訊息，類似消費普通訊息。
                    List<Message> messages = null;
                    try
                    {
                        messages = transProducer.ConsumeHalfMessage(3, 3);
                    } catch (Exception exp1) {
                        if (exp1 is MessageNotExistException)
                        {
                            Console.WriteLine(Thread.CurrentThread.Name + " No half message, " + ((MessageNotExistException)exp1).RequestId);
                            continue;
                        }
                        Console.WriteLine(exp1);
                        Thread.Sleep(2000);
                    }

                    if (messages == null)
                        continue;
                    // 處理商務邏輯。
                    foreach (Message message in messages)
                    {
                        Console.WriteLine(message);
                        int a = int.Parse(message.GetProperty("a"));
                        uint consumeTimes = message.ConsumedTimes;
                        try {
                            if (a == 1) {
                                // 確認提交事務訊息。
                                transProducer.Commit(message.ReceiptHandle);
                                count++;
                                Console.WriteLine("Id:" + message.Id + ", commit");
                            } else if (a == 2 && consumeTimes > 1) {
                                // 確認提交事務訊息。
                                transProducer.Commit(message.ReceiptHandle);
                                count++;
                                Console.WriteLine("Id:" + message.Id + ", commit");
                            } else if (a == 3) {
                                // 確認復原事務訊息。
                                transProducer.Rollback(message.ReceiptHandle);
                                count++;
                                Console.WriteLine("Id:" + message.Id + ", rollback");
                            } else {
                                // 什麼都不做，下次再檢查。
                                Console.WriteLine("Id:" + message.Id + ", unkonwn");
                            }
                        } catch (Exception ackError) {
                            ProcessAckError(ackError);
                        }
                    }
                }
                catch (Exception ex)
                {
                    Console.WriteLine(ex);
                    Thread.Sleep(2000);
                }
            }
        }

        static void Main(string[] args)
        {
            // 用戶端需要有一個線程或者進程來消費沒有確認的事務訊息。
            // 啟動一個線程來檢查沒有確認的事務訊息。
            Thread consumeHalfThread = new Thread(ConsumeHalfMessage);
            consumeHalfThread.Start();

            try
            {
                // 迴圈發送4條事務訊息，第一條直接在發送完提交事務, 其它三條根據條件處理。
                for (int i = 0; i < 4; i++)
                {
                    TopicMessage sendMsg = new TopicMessage("trans_msg");
                    sendMsg.MessageTag = "a";
                    sendMsg.MessageKey = "MessageKey";
                    sendMsg.PutProperty("a", i.ToString());
                    // 設定事務第一次回查的時間，為相對時間。單位：秒，範圍：10~300。
                    // 第一次事務回查後如果訊息沒有Commit或者Rollback，則之後每隔10s左右會回查一次，共回查24小時。
                    sendMsg.TransCheckImmunityTime = 10;

                    TopicMessage result = transProducer.PublishMessage(sendMsg);
                    Console.WriteLine("publis message success:" + result);
                    try {
                        if (!string.IsNullOrEmpty(result.ReceiptHandle) && i == 0)
                        {
                            // 發送完事務訊息後能擷取到半訊息控制代碼，可以直接Commit或Rollback事務訊息。
                            transProducer.Commit(result.ReceiptHandle);
                            Console.WriteLine("Id:" + result.Id + ", commit");
                        }
                    } catch (Exception ackError) {
                        ProcessAckError(ackError);
                    }
                }
            } catch (Exception ex) {
                Console.Write(ex);
            }

            consumeHalfThread.Join();
        }
    }
}

訂閱事務訊息

訂閱事務訊息的範例程式碼如下。

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 ConsumerSample
    {
        // 設定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}";
        // 您在訊息佇列RocketMQ版控制台建立的Group ID。
        private const string _groupId = "${GROUP_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.ConsumeMessage(
                            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);
                }
            }
        }
    }
}