HTTP協議Node.jsSDK收發定時、延時訊息的樣本 - ApsaraMQ for RocketMQ

本文提供使用HTTP協議下的Node.js SDK收發定時訊息和延時訊息的範例程式碼。

背景資訊

延時訊息：Producer將訊息發送到雲訊息佇列 RocketMQ 版服務端，但並不期望立馬投遞這條訊息，而是延遲一定時間後才投遞到Consumer進行消費，該訊息即延時訊息。
定時訊息：Producer將訊息發送到雲訊息佇列 RocketMQ 版服務端，但並不期望立馬投遞這條訊息，而是延遲到在目前時間點之後的某一個時間投遞到Consumer進行消費，該訊息即定時訊息。

在HTTP協議下，定時訊息和延時訊息的代碼配置相同，本質都是根據訊息中的屬性延遲固定時間後才投遞給消費者。

更多資訊，請參見定時和延時訊息。

前提條件

您已完成以下操作：

安裝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'];// AccessKey ID，阿里雲身分識別驗證標識。
const accessKeyId = "${ACCESS_KEY}";
// AccessKey Secret，阿里雲身分識別驗證密鑰。
const accessKeySecret = "${SECRET_KEY}";

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

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

const producer = client.getProducer(instanceId, topic);

(async function(){
  try {
    // 迴圈發送4條訊息。
    for(var i = 0; i < 4; i++) {
      let res;
      msgProps = new MessageProperties();
      // 設定訊息的自訂屬性。
      msgProps.putProperty("a", i);
      // 設定訊息的Key。
      msgProps.messageKey("MessageKey");
      // 延時訊息，發送時間為10s後。該參數格式為毫秒層級的時間戳記。
      // 若發送定時訊息，設定該參數時需要計算定時時間與目前時間的時間差。
      msgProps.startDeliverTime(Date.now() + 10 * 1000);
      // 設定發送的訊息內容和訊息Tag。
      res = await producer.publishMessage("hello mq. timer msg!", "TagA", msgProps);
      console.log("Publish message: MessageID:%s,BodyMD5:%s", res.body.MessageId, res.body.MessageBodyMD5);
    }

  } catch(e) {
    // 訊息發送失敗，需要進行重試處理，可重新發送這條訊息或持久化這條資料進行補償處理。
    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);
      }
    }
  }
})();