HTTPクライアントSDK for Node.jsを使用して、スケジュールおよび遅延メッセージを送信する - ApsaraMQ for RocketMQ

このトピックでは、Node.js用のHTTPクライアントSDKを使用して、スケジュールされたメッセージと遅延されたメッセージを送受信する方法に関するサンプルコードを提供します。

の背景情報

遅延メッセージは、特定の期間後にApsaraMQ for RocketMQブローカーによってコンシューマに配信されるメッセージです。
スケジュールされたメッセージは、ApsaraMQ for RocketMQブローカーが特定の時点でコンシューマに配信するメッセージです。

スケジュールされたメッセージのコード構成は、HTTP上の遅延メッセージのコード構成と同じです。どちらのタイプのメッセージも、メッセージの属性に基づいて特定の期間後にコンシューマに配信されます。

詳細については、「スケジュールされたメッセージと遅延メッセージ」をご参照ください。

の前提条件

開始する前に、次の操作が実行されていることを確認してください。

SDK for Node.jsをインストールします。詳細については、「環境の準備」をご参照ください。
ApsaraMQ for RocketMQコンソールのコードで指定するリソースを作成します。リソースには、インスタンス、トピック、および消費者グループが含まれます。詳細については、「リソースの作成」をご参照ください。
Alibaba CloudアカウントのAccessKeyペアを取得します。詳細については、「AccessKey の作成」をご参照ください。

スケジュールおよび遅延メッセージの送信

次のサンプルコードは、Node.js用のHTTPクライアントSDKを使用して、スケジュールメッセージと遅延メッセージを送信する方法の例を示しています。

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

// The HTTP endpoint. You can obtain the endpoint in the HTTP Endpoint section of the Instance Details page in the ApsaraMQ for RocketMQ console. 
const endpoint = "${HTTP_ENDPOINT}";
// Make sure that the environment variables ALIBABA_CLOUD_ACCESS_KEY_ID and ALIBABA_CLOUD_ACCESS_KEY_SECRET are configured. 
// The AccessKey ID that is used for authentication. 
const accessKeyId = process.env['ALIBABA_CLOUD_ACCESS_KEY_ID'];
// The AccessKey secret that is used for authentication. 
const accessKeySecret = process.env['ALIBABA_CLOUD_ACCESS_KEY_SECRET'];// The AccessKey ID that is used for authentication. 
const accessKeyId = "${ACCESS_KEY}";
// The AccessKey secret that is used for authentication. 
const accessKeySecret = "${SECRET_KEY}";

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

// The topic in which the message is produced. You must create the topic in the ApsaraMQ for RocketMQ console. 
const topic = "${TOPIC}";
// The ID of the instance to which the topic belongs. You must create the instance in the ApsaraMQ for RocketMQ console. 
// If the instance has a namespace, specify the ID of the instance. If the instance does not have a namespace, set the instanceId parameter to null or an empty string. You can obtain the namespace of the instance on the Instance Details page in the ApsaraMQ for RocketMQ console. 
const instanceId = "${INSTANCE_ID}";

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

(async function(){
  try {
    // Cyclically send four messages. 
    for(var i = 0; i < 4; i++) {
      let res;
      msgProps = new MessageProperties();
      // The custom attributes of the message. 
      msgProps.putProperty("a", i);
      // The message key. 
      msgProps.messageKey("MessageKey");
      // The period of time after which the broker delivers the message to the consumer. In this example, the broker delivers the message to the consumer after a delay of 10 seconds. Set this parameter to a timestamp in milliseconds. 
      // If you want to send a scheduled message, set the parameter to the time difference between the scheduled point in time and the current point in time. 
      msgProps.startDeliverTime(Date.now() + 10 * 1000);
      // The body and tag of the message. 
      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) {
    // Specify the logic that you want to use to resend or persist the message if the message fails to be sent and needs to be sent again. 
    console.log(e)
  }
})();

スケジュールされたメッセージと遅延したメッセージを購読する

次のサンプルコードは、Node.js用のHTTPクライアントSDKを使用して、スケジュールされたメッセージと遅延したメッセージをサブスクライブする方法の例を示しています。

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

// The HTTP endpoint. You can obtain the endpoint in the HTTP Endpoint section of the Instance Details page in the ApsaraMQ for RocketMQ console. 
const endpoint = "${HTTP_ENDPOINT}";
// Make sure that the environment variables ALIBABA_CLOUD_ACCESS_KEY_ID and ALIBABA_CLOUD_ACCESS_KEY_SECRET are configured. 
// The AccessKey ID that is used for authentication. 
const accessKeyId = process.env['ALIBABA_CLOUD_ACCESS_KEY_ID'];
// The AccessKey secret that is used for authentication. 
const accessKeySecret = process.env['ALIBABA_CLOUD_ACCESS_KEY_SECRET'];

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

// The topic in which the message is produced. You must create the topic in the ApsaraMQ for RocketMQ console. 
const topic = "${TOPIC}";
// The ID of the consumer group that you created in the ApsaraMQ for RocketMQ console. 
const groupId = "${GROUP_ID}";
// The ID of the instance to which the topic belongs. You must create the instance in the ApsaraMQ for RocketMQ console. 
// If the instance has a namespace, specify the ID of the instance. If the instance does not have a namespace, set the instanceID parameter to null or an empty string. You can obtain the namespace of the instance on the Instance Details page in the ApsaraMQ for RocketMQ console. 
const instanceId = "${INSTANCE_ID}";

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

(async function(){
  // Cyclically consume messages. 
  while(true) {
    try {
      // Consume messages in long polling mode. 
      // In long polling mode, if no message in the topic is available for consumption, the request is suspended on the broker for the specified period of time. If a message becomes available for consumption within the specified period of time, the broker immediately sends a response to the consumer. In this example, the value is specified as 3 seconds. 
      res = await consumer.consumeMessage(
          3, // The maximum number of messages that can be consumed at a time. In this example, the value is specified as 3. The largest value that you can specify is 16. 
          3 // The duration of a long polling period. Unit: seconds. In this example, the value is specified as 3. The maximum value that you can specify is 30. 
          );

      if (res.code == 200) {
        // The message consumption logic. 
        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;
        });

        // If the broker does not receive an acknowledgment (ACK) for a message from the consumer before the period of time specified by the message.NextConsumeTime parameter elapses, the message is consumed again. 
        // A unique timestamp is specified for the handle of a message each time the message is consumed. 
        res = await consumer.ackMessage(handles);
        if (res.code != 204) {
          // If the handle of the message times out, the broker fails to receive an ACK for the message from the consumer. 
          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 {
          // Obtain an ACK from the consumer. 
          console.log("Ack Message suc, RequestId:%s\n\t", res.requestId, handles.join(','));
        }
      }
    } catch(e) {
      if (e.Code.indexOf("MessageNotExist") > -1) {
        // If no message is available for consumption in the topic, the long polling mode continues to take effect. 
        console.log("Consume Message: no new message, RequestId:%s, Code:%s", e.RequestId, e.Code);
      } else {
        console.log(e);
      }
    }
  }
})();