ApsaraMQ for RocketMQ:Send and receive ordered messages

Background information

For more information, see Ordered messages.

Prerequisites

Before you start, make sure that the following operations are performed:

• Install the SDK for Node.js. For more information, see Prepare the environment.

• Create the resources that you want to specify in the code in the ApsaraMQ for RocketMQ console. The resources include instances, topics, and consumer groups. For more information, see Create resources.

• Obtain the AccessKey pair of your Alibaba Cloud account. For more information, see Create an AccessKey pair.

Send ordered messages

The following sample code provides an example on how to send ordered messages by using the HTTP client SDK for Node.js:

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'];

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 eight messages. 
    for(var i = 0; i < 8; i++) {
      msgProps = new MessageProperties();
      // The custom attributes of the message. 
      msgProps.putProperty("a", i);
      // The sharding key that is used to distribute ordered messages to a specific partition. Sharding keys can be used to identify partitions. A sharding key is different from a message key. 
      msgProps.shardingKey(i % 2);
      // The body and tag of the message. 
      res = await producer.publishMessage("hello mq.", "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)
  }
})();

Subscribe to ordered messages

The following sample code provides an example on how to subscribe to ordered messages by using the HTTP client SDK for Node.js:

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 = "GID_http";
// 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. The consumer may pull partitionally ordered messages from multiple partitions. The consumer consumes messages from the same partition in the order that the messages are sent. 
      // Assume that a consumer pulls partitionally ordered messages from one partition. If the broker does not receive an acknowledgment (ACK) for a message from the consumer, the broker delivers the message in the partition to the consumer again. 
      // The consumer can consume the next batch of messages from a partition only after all messages that are pulled from the partition in the previous batch are acknowledged as consumed. 
      // In long polling mode, if no message is available for consumption in the topic, requests are suspended on the broker for the specified period of time. If a message becomes available for consumption during 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.consumeMessageOrderly(
          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,ShardingKey:%s,Prop-A:%s,Tag:%s",
              message.MessageId, message.MessageTag, message.PublishTime, message.NextConsumeTime, message.FirstConsumeTime, message.ConsumedTimes,
              message.MessageBody,message.Properties,message.ShardingKey,message.Properties.a);
          return message.ReceiptHandle;
        });

        // If the broker fails to receive an ACK for a message from the consumer before the period of time specified by the message.NextConsumeTime parameter elapses, the broker delivers the message to the consumer 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);
      }
    }
  }
})();