順序訊息（FIFO訊息）是雲訊息佇列 RocketMQ 版提供的一種嚴格按照順序來發布和消費的訊息類型。本文提供使用HTTP協議下的PHP SDK收發順序訊息的範例程式碼。
背景資訊
順序訊息分為兩類：
全域順序：對於指定的一個Topic，所有訊息按照嚴格的先入先出FIFO（First In First Out）的順序進行發布和消費。
分區順序：對於指定的一個Topic，所有訊息根據Sharding Key進行區塊分區。同一個分區內的訊息按照嚴格的FIFO順序進行發布和消費。Sharding Key是順序訊息中用來區分不同分區的關鍵字段，和普通訊息的Key是完全不同的概念。
更多資訊，請參見順序訊息。
前提條件
您已完成以下操作：
安裝PHP SDK。更多資訊，請參見準備環境。
建立資源。代碼中涉及的資源資訊，例如執行個體、Topic和Group ID等，需要在控制台上提前建立。更多資訊，請參見建立資源。
擷取阿里雲存取金鑰AccessKey ID和AccessKey Secret。更多資訊，請參見建立AccessKey。
發送順序訊息
重要
雲訊息佇列 RocketMQ 版服務端判定訊息產生的順序性是參照單一生產者、單一線程並發下訊息發送的時序。如果發送方有多個生產者或者有多個線程並發發送訊息，則此時只能以到達雲訊息佇列 RocketMQ 版服務端的時序作為訊息順序的依據，和業務側的發送順序未必一致。
發送順序訊息的範例程式碼如下。
<?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(
// 設定HTTP協議用戶端存取點，進入訊息佇列RocketMQ版控制台執行個體詳情頁面的存取點地區查看。
"${HTTP_ENDPOINT}",
// 請確保環境變數ALIBABA_CLOUD_ACCESS_KEY_ID、ALIBABA_CLOUD_ACCESS_KEY_SECRET已設定。
// AccessKey ID，阿里雲身分識別驗證標識。
getenv("ALIBABA_CLOUD_ACCESS_KEY_ID"),
// AccessKey Secret，阿里雲身分識別驗證密鑰。
getenv('ALIBABA_CLOUD_ACCESS_KEY_SECRET')
);
// 訊息所屬的Topic，在訊息佇列RocketMQ版控制台建立。
$topic = "${TOPIC}";
// Topic所屬的執行個體ID，在訊息佇列RocketMQ版控制台建立。
// 若執行個體有命名空間，則執行個體ID必須傳入；若執行個體無命名空間，則執行個體ID傳入null空值或字串空值。執行個體的命名空間可以在訊息佇列RocketMQ版控制台的執行個體詳情頁面查看。
$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!"// 訊息內容。
);
// 設定訊息的自訂屬性。
$publishMessage->putProperty("a", $i);
// 設定分區順序訊息的Sharding Key，用於標識不同的分區。Sharding Key與訊息的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
require "vendor/autoload.php";
use MQ\MQClient;
class ConsumerTest
{
private $client;
private $consumer;
public function __construct()
{
$this->client = new MQClient(
// 設定HTTP協議用戶端存取點，進入訊息佇列RocketMQ版控制台執行個體詳情頁面的存取點地區查看。
"${HTTP_ENDPOINT}",
// 請確保環境變數ALIBABA_CLOUD_ACCESS_KEY_ID、ALIBABA_CLOUD_ACCESS_KEY_SECRET已設定。
// AccessKey ID，阿里雲身分識別驗證標識。
getenv("ALIBABA_CLOUD_ACCESS_KEY_ID"),
// AccessKey Secret，阿里雲身分識別驗證密鑰。
getenv('ALIBABA_CLOUD_ACCESS_KEY_SECRET')
);
// 訊息所屬的Topic，在訊息佇列RocketMQ版控制台建立。
$topic = "${TOPIC}";
// 您在訊息佇列RocketMQ版控制台建立的Group ID。
$groupId = "${GROUP_ID}";
// Topic所屬的執行個體ID，在訊息佇列RocketMQ版控制台建立。
// 若執行個體有命名空間，則執行個體ID必須傳入；若執行個體無命名空間，則執行個體ID傳入null空值或字串空值。執行個體的命名空間可以在訊息佇列RocketMQ版控制台的執行個體詳情頁面查看。
$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) {
// 某些訊息的控制代碼可能逾時，會導致消費確認失敗。
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()
{
// 在當前線程迴圈消費訊息，建議多開個幾個線程並發消費訊息。
while (True) {
try {
// 長輪詢順序消費訊息, 拉取到的訊息可能是多個分區的（對於分區順序訊息），一個分區內的訊息一定是順序的。
// 對於分區順序訊息，只要一個分區記憶體在沒有被確認消費的訊息，那麼該分區下次還會消費到相同的訊息。
// 對於一個分區，只有所有訊息確認消費成功才能消費下一批訊息。
// 長輪詢消費訊息。若Topic內沒有訊息，請求會在服務端掛起一段時間（長輪詢時間），期間如果有訊息可以消費則立即返回用戶端。
$messages = $this->consumer->consumeMessageOrderly(
3, // 一次最多消費3條（最多可設定為16條）。
3 // 長輪詢時間3秒（最多可設定為30秒）。
);
} catch (\MQ\Exception\MessageResolveException $e) {
// 當出現訊息Body存在不合法字元，無法解析的時候，會拋出此異常。
// 可以正常解析的訊息列表。
$messages = $e->getPartialResult()->getMessages();
// 無法正常解析的訊息列表。
$failMessages = $e->getPartialResult()->getFailResolveMessages();
$receiptHandles = array();
foreach ($messages as $message) {
// 處理商務邏輯。
$receiptHandles[] = $message->getReceiptHandle();
printf("MsgID %s\n", $message->getMessageId());
}
foreach ($failMessages as $failMessage) {
// 處理存在不合法字元，無法解析的訊息。
$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) {
// 沒有訊息，則繼續長輪詢伺服器。
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";
// 處理商務邏輯。
$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());
}
// $message->getNextConsumeTime()前若不確認訊息消費成功，則訊息會被重複消費。
// 訊息控制代碼有時間戳記，同一條訊息每次消費拿到的都不一樣。
print_r($receiptHandles);
$this->ackMessages($receiptHandles);
print "=======>ack finish\n";
}
}
}
$instance = new ConsumerTest();
$instance->run();
?>