注文メッセージは、ApsaraMQ for RocketMQによって提供されるメッセージの一種です。 順序付けられたメッセージは、厳密な先入れ先出し (FIFO) の順序で発行および消費されます。 このトピックでは、HTTPクライアントSDK for PHPを使用して順序付きメッセージを送受信する方法に関するサンプルコードを提供します。
背景情報
注文されたメッセージは、次のタイプに分類されます。
グローバルに順序付けられたメッセージ: トピック内のメッセージがこのタイプの場合、メッセージはFIFO順序で発行され、消費されます。
パーティション順メッセージ: トピック内のメッセージがこのタイプの場合、メッセージはシャーディングキーを使用して異なるパーティションに分散されます。 各パーティションのメッセージはFIFO順に消費されます。 シャーディングキーは、パーティションを識別するために順序付けられたメッセージに使用されるキーフィールドです。 シャーディングキーはメッセージキーとは異なります。
詳細については、「注文メッセージ」をご参照ください。
の前提条件
開始する前に、次の操作が実行されていることを確認してください。
PHP用SDKをインストールします。 詳細については、「環境の準備」をご参照ください。
ApsaraMQ for RocketMQコンソールのコードで指定するリソースを作成します。 リソースには、インスタンス、トピック、および消費者グループが含まれます。 詳細については、「リソースの作成」 をご参照ください。
Alibaba CloudアカウントのAccessKeyペアを取得します。 詳細については、「AccessKey の作成」をご参照ください。
順序付けられたメッセージを送信する
ApsaraMQ for RocketMQブローカーは、送信者が単一のプロデューサーまたはスレッドを使用してメッセージを送信する順序に基づいて、メッセージが生成される順序を決定します。 送信者が複数のプロデューサまたはスレッドを使用してメッセージを同時に送信する場合、メッセージの順序は、ApsaraMQ for RocketMQブローカーがメッセージを受信した順序によって決まります。 この注文は、ビジネス側の送信注文とは異なる場合があります。
次のサンプルコードは、PHP用HTTPクライアントSDKを使用して順序付きメッセージを送信する方法の例を示しています。
<?php
require "vendor/autoload.php";
use MQ\Model\TopicMessage;
use MQ\MQClient;
class ProducerTest
{
private $client;
private $producer;
public function __construct()
{
$this->client = new MQClient(
// The HTTP endpoint. You can obtain the endpoint in the HTTP Endpoint section of the Instance Details page in the ApsaraMQ for RocketMQ console.
"${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.
getenv("ALIBABA_CLOUD_ACCESS_KEY_ID"),
// The AccessKey secret that is used for authentication.
getenv('ALIBABA_CLOUD_ACCESS_KEY_SECRET')
);
// The topic in which the message is produced. You must create the topic in the ApsaraMQ for RocketMQ console.
$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.
$instanceId = "${INSTANCE_ID}";
$this->producer = $this->client->getProducer($instanceId, $topic);
}
public function run()
{
try
{
for ($i=1; $i<=4; $i++)
{
$publishMessage = new TopicMessage(
"hello mq! "// The message content.
);
// The custom attributes of the message.
$publishMessage->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.
$publishMessage->setShardingKey($i % 2);
$result = $this->producer->publishMessage($publishMessage);
print "Send mq message success. msgId is:" . $result->getMessageId() . ", bodyMD5 is:" . $result->getMessageBodyMD5() . "\n";
}
} catch (\Exception $e) {
print_r($e->getMessage() . "\n");
}
}
}
$instance = new ProducerTest();
$instance->run();
?>
注文されたメッセージを購読する
次のサンプルコードは、PHP用のHTTPクライアントSDKを使用して順序付きメッセージをサブスクライブする方法の例を示しています。
<?php
require "vendor/autoload.php";
use MQ\MQClient;
class ConsumerTest
{
private $client;
private $consumer;
public function __construct()
{
$this->client = new MQClient(
// The HTTP endpoint. You can obtain the endpoint in the HTTP Endpoint section of the Instance Details page in the ApsaraMQ for RocketMQ console.
"${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.
getenv("ALIBABA_CLOUD_ACCESS_KEY_ID"),
// The AccessKey secret that is used for authentication.
getenv('ALIBABA_CLOUD_ACCESS_KEY_SECRET')
);
// The topic in which the message is produced. You must create the topic in the ApsaraMQ for RocketMQ console.
$topic = "${TOPIC}";
// The ID of the consumer group that you created in the ApsaraMQ for RocketMQ console.
$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.
$instanceId = "${INSTANCE_ID}";
$this->consumer = $this->client->getConsumer($instanceId, $topic, $groupId);
}
public function ackMessages($receiptHandles)
{
try {
$this->consumer->ackMessage($receiptHandles);
} catch (\Exception $e) {
if ($e instanceof MQ\Exception\AckMessageException) {
// If the handle of a message times out, the broker cannot receive an acknowledgement (ACK) for the message from the consumer.
printf("Ack Error, RequestId:%s\n", $e->getRequestId());
foreach ($e->getAckMessageErrorItems() as $errorItem) {
printf("\tReceiptHandle:%s, ErrorCode:%s, ErrorMsg:%s\n", $errorItem->getReceiptHandle(), $errorItem->getErrorCode(), $errorItem->getErrorCode());
}
}
}
}
public function run()
{
// Cyclically consume messages in the current thread. We recommend that you use multiple threads to concurrently 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 the consumer pulls partitionally ordered messages from one partition. If the broker fails to receive an ACK for a message from the consumer, the broker delivers the message to the consumer again.
// The consumer can consume the next batch of messages from a partition only after all the messages pulled from the partition in the previous batch are acknowledged as consumed.
// Consume messages in long polling mode. If no message in the topic is available for consumption, the request is suspended on the broker for a period of time, which is known as the long polling period. If a message becomes available for consumption within this period of time, the broker immediately sends a response to the consumer.
$messages = $this->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 maximum 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.
);
} catch (\MQ\Exception\MessageResolveException $e) {
// If messages cannot be parsed due to invalid characters in the message body, this exception is thrown.
// The messages that can be parsed as expected.
$messages = $e->getPartialResult()->getMessages();
// The messages that cannot be parsed as expected.
$failMessages = $e->getPartialResult()->getFailResolveMessages();
$receiptHandles = array();
foreach ($messages as $message) {
// The message consumption logic.
$receiptHandles[] = $message->getReceiptHandle();
printf("MsgID %s\n", $message->getMessageId());
}
foreach ($failMessages as $failMessage) {
// Handle the message that cannot be parsed due to invalid characters in the message body.
$receiptHandles[] = $failMessage->getReceiptHandle();
printf("Fail To Resolve Message. MsgID %s\n", $failMessage->getMessageId());
}
$this->ackMessages($receiptHandles);
continue;
} catch (\Exception $e) {
if ($e instanceof MQ\Exception\MessageNotExistException) {
// If no message is available for consumption in the topic, the long polling mode continues to take effect.
printf("No message, contine long polling!RequestId:%s\n", $e->getRequestId());
continue;
}
print_r($e->getMessage() . "\n");
sleep(3);
continue;
}
print "======>consume finish, messages:\n";
// The message consumption logic.
$receiptHandles = array();
foreach ($messages as $message) {
$receiptHandles[] = $message->getReceiptHandle();
printf("MessageID:%s TAG:%s BODY:%s \nPublishTime:%d, FirstConsumeTime:%d, \nConsumedTimes:%d, NextConsumeTime:%d,ShardingKey:%s\n",
$message->getMessageId(), $message->getMessageTag(), $message->getMessageBody(),
$message->getPublishTime(), $message->getFirstConsumeTime(), $message->getConsumedTimes(), $message->getNextConsumeTime(),
$message->getShardingKey());
print_r($message->getProperties());
}
// If the broker fails to receive an ACK for a message from the consumer before the period of time specified in $message->getNextConsumeTime() 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.
print_r($receiptHandles);
$this->ackMessages($receiptHandles);
print "=======>ack finish\n";
}
}
}
$instance = new ConsumerTest();
$instance->run();
?>