收發事務訊息 - ApsaraMQ for RocketMQ

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

背景資訊

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

圖片1.png

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

前提條件

您已完成以下操作：

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

發送事務訊息

發送事務訊息的範例程式碼如下。

const {
  MQClient,
  MessageProperties
} = require('@aliyunmq/mq-http-sdk');

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

var client = new MQClient(endpoint, accessKeyId, accessKeySecret);

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

const mqTransProducer = client.getTransProducer(instanceId, topic, groupId);

async function processTransResult(res, msgId) {
    if (!res) {
        return;
    }
    if (res.code != 204) {
      // 如果Commit或Rollback時超過了TransCheckImmunityTime（針對發送事務訊息的控制代碼）或者超過10s（針對consumeHalfMessage的控制代碼），則Commit或Rollback失敗。
      console.log("Commit/Rollback Message Fail:");
      const failHandles = res.body.map((error) => {
        console.log("\tErrorHandle:%s, Code:%s, Reason:%s\n", error.ReceiptHandle, error.ErrorCode, error.ErrorMessage);
        return error.ReceiptHandle;
      });
    } else {
      console.log("Commit/Rollback Message suc!!! %s", msgId);
    }
}

var halfMessageCount = 0;
var halfMessageConsumeCount = 0;

(async function(){
  try {
    // 迴圈發送4條事務訊息。
    for(var i = 0; i < 4; i++) {
      let res;
      msgProps = new MessageProperties();
      // 設定訊息的自訂屬性。
      msgProps.putProperty("a", i);
      // 設定訊息的Key。
      msgProps.messageKey("MessageKey");
      // 設定事務第一次回查的時間，為相對時間。單位：秒，範圍：10~300。
      // 第一次事務回查後如果訊息沒有Commit或者Rollback，則之後每隔10s左右會回查一次，共回查24小時。
      msgProps.transCheckImmunityTime(10);
      res = await mqTransProducer.publishMessage("hello mq.", "tagA", msgProps);
      console.log("Publish message: MessageID:%s,BodyMD5:%s,Handle:%s", res.body.MessageId, res.body.MessageBodyMD5, res.body.ReceiptHandle);
      if (res && i == 0) {
         // 發送完事務訊息後能擷取到半訊息控制代碼，可以直接Commit或Rollback事務訊息。
          const msgId = res.body.MessageId;
          res = await mqTransProducer.commit(res.body.ReceiptHandle);
          console.log("Commit msg when publish, %s", msgId);
          // 如果Commit或Rollback時超過了TransCheckImmunityTime則會失敗。
        processTransResult(res, msgId);
      }
    }
  } catch(e) {
    // 訊息發送失敗，需要進行重試處理，可重新發送這條訊息或持久化這條資料進行補償處理。
    console.log(e)
  }
})();

// 用戶端需要有一個線程或者進程來消費沒有確認的事務訊息。
// 檢查沒有確認的事務訊息。
(async function() {
  // 迴圈檢查事務半訊息，類似消費普通訊息。
  while(halfMessageCount < 3 && halfMessageConsumeCount < 15) {
    try {
        halfMessageConsumeCount++;
      res = await mqTransProducer.consumeHalfMessage(3, 3);
      if (res.code == 200) {
        // 訊息消費處理邏輯。
        console.log("Consume Messages, requestId:%s", res.requestId);
        res.body.forEach(async (message) => {
          console.log("\tMessageId:%s,Tag:%s,PublishTime:%d,NextConsumeTime:%d,FirstConsumeTime:%d,ConsumedTimes:%d,Body:%s" +
            ",Props:%j,MessageKey:%s,Prop-A:%s",
              message.MessageId, message.MessageTag, message.PublishTime, message.NextConsumeTime, message.FirstConsumeTime, message.ConsumedTimes,
              message.MessageBody,message.Properties,message.MessageKey,message.Properties.a);

          var propA = message.Properties && message.Properties.a ? parseInt(message.Properties.a) : 0;
                  var opResp;
                  if (propA == 1 || (propA == 2 && message.ConsumedTimes > 1)) {
                      opResp = await mqTransProducer.commit(message.ReceiptHandle);
                      console.log("Commit msg when check half, %s", message.MessageId);
                      halfMessageCount++;
                  } else if (propA == 3) {
                      opResp = await mqTransProducer.rollback(message.ReceiptHandle);
                      console.log("Rollback msg when check half, %s", message.MessageId);
                      halfMessageCount++;
                  }
                  processTransResult(opResp, message.MessageId);
        });
      }
    } catch(e) {
      if (e.Code && e.Code.indexOf("MessageNotExist") > -1) {
        // 沒有訊息，則繼續長輪詢伺服器。
        console.log("Consume Transaction Half msg: no new message, RequestId:%s, Code:%s", e.RequestId, e.Code);
      } else {
        console.log(e);
      }
    }
  }
})();

訂閱事務訊息

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

const {
  MQClient
} = require('@aliyunmq/mq-http-sdk');

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

var client = new MQClient(endpoint, accessKeyId, accessKeySecret);

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

const consumer = client.getConsumer(instanceId, topic, groupId);

(async function(){
  // 迴圈消費訊息。
  while(true) {
    try {
      // 長輪詢消費訊息。
      // 長輪詢表示如果Topic沒有訊息，則用戶端請求會在服務端掛起3s，3s內如果有訊息可以消費則立即返迴響應。
      res = await consumer.consumeMessage(
          3, // 一次最多消費3條（最多可設定為16條）。
          3 // 長輪詢時間3秒（最多可設定為30秒）。
          );

      if (res.code == 200) {
        // 訊息消費處理邏輯。
        console.log("Consume Messages, requestId:%s", res.requestId);
        const handles = res.body.map((message) => {
          console.log("\tMessageId:%s,Tag:%s,PublishTime:%d,NextConsumeTime:%d,FirstConsumeTime:%d,ConsumedTimes:%d,Body:%s" + 
            ",Props:%j,MessageKey:%s,Prop-A:%s",
              message.MessageId, message.MessageTag, message.PublishTime, message.NextConsumeTime, message.FirstConsumeTime, message.ConsumedTimes,
              message.MessageBody,message.Properties,message.MessageKey,message.Properties.a);
          return message.ReceiptHandle;
        });

        // message.NextConsumeTime前若不確認訊息消費成功，則訊息會被重複消費。
        // 訊息控制代碼有時間戳記，同一條訊息每次消費拿到的都不一樣。
        res = await consumer.ackMessage(handles);
        if (res.code != 204) {
          // 某些訊息的控制代碼可能逾時，會導致訊息消費狀態確認不成功。
          console.log("Ack Message Fail:");
          const failHandles = res.body.map((error)=>{
            console.log("\tErrorHandle:%s, Code:%s, Reason:%s\n", error.ReceiptHandle, error.ErrorCode, error.ErrorMessage);
            return error.ReceiptHandle;
          });
          handles.forEach((handle)=>{
            if (failHandles.indexOf(handle) < 0) {
              console.log("\tSucHandle:%s\n", handle);
            }
          });
        } else {
          // 確認訊息消費成功。
          console.log("Ack Message suc, RequestId:%s\n\t", res.requestId, handles.join(','));
        }
      }
    } catch(e) {
      if (e.Code.indexOf("MessageNotExist") > -1) {
        // 沒有訊息，則繼續長輪詢伺服器。
        console.log("Consume Message: no new message, RequestId:%s, Code:%s", e.RequestId, e.Code);
      } else {
        console.log(e);
      }
    }
  }
})();