通常のメッセージは、ApsaraMQ for RocketMQによって提供される機能のないメッセージです。 通常のメッセージは、スケジュールメッセージ、遅延メッセージ、順序付けられたメッセージ、およびトランザクションメッセージを含む、特徴的なメッセージとは異なる。 このトピックでは、HTTPクライアントSDK for PHPを使用して通常のメッセージを送受信する方法に関するサンプルコードを提供します。
の前提条件
開始する前に、次の操作が実行されていることを確認してください。
PHP用SDKをインストールします。 詳細については、「環境の準備」をご参照ください。
ApsaraMQ for RocketMQコンソールのコードで指定するリソースを作成します。 リソースには、インスタンス、トピック、および消費者グループが含まれます。 詳細については、「リソースの作成」 をご参照ください。
Alibaba CloudアカウントのAccessKeyペアを取得します。 詳細については、「AccessKey の作成」をご参照ください。
通常のメッセージを送信する
次のサンプルコードは、HTTPクライアントSDK for PHPを使用して通常のメッセージを送信する方法の例を示しています。
<?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(
// The message content.
"hello mq!"
);
// The custom attributes of the message.
$publishMessage->putProperty("a", $i);
// The message key.
$publishMessage->setMessageKey("MessageKey");
$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();
?>
通常のメッセージを購読する
次のサンプルコードは、HTTPクライアントSDK for PHPを使用して通常のメッセージをサブスクライブする方法の例を示しています。
<?php
use MQ\MQClient;
require "vendor/autoload.php";
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 acknowledgment (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.
// If no message in the topic is available for consumption, the request is suspended on the broker for a period of time. This period of time is known as long polling period. If a message becomes available for consumption within the period of time, the broker immediately sends a response to the consumer.
$messages = $this->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 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, and 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,MessageKey:%s\n",
$message->getMessageId(), $message->getMessageTag(), $message->getMessageBody(),
$message->getPublishTime(), $message->getFirstConsumeTime(), $message->getConsumedTimes(), $message->getNextConsumeTime(),
$message->getMessageKey());
print_r($message->getProperties());
}
// If the broker does not 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();
?>