Message Queue for Apache RocketMQ provides a distributed transaction processing feature similar to X/Open XA to ensure transaction consistency in Message Queue for Apache RocketMQ. This topic provides the sample code about how to send and subscribe to transactional messages by using HTTP client SDK for PHP.

Background information

The following figure shows the interaction process of transactional messages. 事务消息流程图For more information, see Transactional messages.

Prerequisites

Before you begin, make sure that the following operations are complete:

  • SDK for PHP is installed. For more information, see Prepare the environment.
  • Resources are created. The resources that you want to specify in the code are created in advance. For example, the instance, topic, and group ID that you want to specify in the code are created in the Message Queue for Apache RocketMQ console in advance. For more information, see Create resources.

Send transactional messages

The following sample code provides an example on how to send transactional messages:

<?php

require "vendor/autoload.php";

use MQ\Model\TopicMessage;
use MQ\MQClient;

class ProducerTest
{
    private $client;
    private $transProducer;
    private $count;
    private $popMsgCount;

    public function __construct()
    {
        $this->client = new MQClient(
            // The HTTP endpoint. To obtain the HTTP endpoint, log on to the Message Queue for Apache RocketMQ console. In the left-side navigation pane, click Instances. On the Instances page, click the name of your instance. On the Instance Details page, scroll to the Basic Information section and view the endpoint on the Endpoints tab. 
            "${HTTP_ENDPOINT}",
            // The AccessKey ID that you created in the Resource Access Management (RAM) console for identity authentication. 
            "${ACCESS_KEY}",
            // The AccessKey secret that you created in the RAM console for identity authentication. 
            "${SECRET_KEY}"
        );

        // The topic of the message. The topic must have been created in the Message Queue for Apache RocketMQ console. 
        $topic = "${TOPIC}";        
        // The group ID that you created in the Message Queue for Apache RocketMQ console. 
        $groupId = "${GROUP_ID}";
        // The ID of the instance to which the topic belongs. The instance must have been created in the Message Queue for Apache RocketMQ console. 
        // If the instance has a namespace, the instance ID must be passed in. If the instance does not have a namespace, pass in null or an empty string. Check whether your instance has a namespace on the Instance Details page in the Message Queue for Apache RocketMQ console.
        $instanceId = "${INSTANCE_ID}";

        $this->transProducer = $this->client->getTransProducer($instanceId,$topic, $groupId);
        $this->count = 0;
        $this->popMsgCount = 0;
    }

    function processAckError($e) {
        if ($e instanceof MQ\Exception\AckMessageException) {
            // If the transactional message is committed or rolled back after the time specified by the TransCheckImmunityTime parameter for the handle of the transactional message elapses or the time specified by the NextConsumeTime parameter for the handle of consumeHalfMessage elapses, the commit or rollback fails. 
            printf("Commit/Rollback 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());
            }
        } else {
            print_r($e);
        }
    }

    function consumeHalfMsg() {
        while($this->count < 3 && $this->popMsgCount < 15) {
            $this->popMsgCount++;

            try {
                $messages = $this->transProducer->consumeHalfMessage(4, 3);
            } catch (\Exception $e) {
                if ($e instanceof MQ\Exception\MessageNotExistException) {
                    print "no half transaction message\n";
                    continue;
                }
                print_r($e->getMessage() . "\n");
                sleep(3);
                continue;
            }

            foreach ($messages as $message) {
                printf("ID:%s TAG:%s BODY:%s \nPublishTime:%d, FirstConsumeTime:%d\nConsumedTimes:%d, NextConsumeTime:%d\nPropA:%s\n",
                    $message->getMessageId(), $message->getMessageTag(), $message->getMessageBody(),
                    $message->getPublishTime(), $message->getFirstConsumeTime(), $message->getConsumedTimes(), $message->getNextConsumeTime(),
                    $message->getProperty("a"));
                print_r($message->getProperties());
                $propA = $message->getProperty("a");
                $consumeTimes = $message->getConsumedTimes();
                try {
                    if ($propA == "1") {
                        print "\n commit transaction msg: " . $message->getMessageId() . "\n";
                        $this->transProducer->commit($message->getReceiptHandle());
                        $this->count++;
                    } else if ($propA == "2" && $consumeTimes > 1) {
                        print "\n commit transaction msg: " . $message->getMessageId() . "\n";
                        $this->transProducer->commit($message->getReceiptHandle());
                        $this->count++;
                    } else if ($propA == "3") {
                        print "\n rollback transaction msg: " . $message->getMessageId() . "\n";
                        $this->transProducer->rollback($message->getReceiptHandle());
                        $this->count++;
                    } else {
                        print "\n unknown transaction msg: " . $message->getMessageId() . "\n";
                    }
                } catch (\Exception $e) {
                    processAckError($e);
                }
            }
        }
    }

    public function run()
    {   
        // Cyclically send four transactional messages. 
        for ($i = 0; $i < 4; $i++) {
            $pubMsg = new TopicMessage("hello,mq");
            // The custom attributes of the message. 
            $pubMsg->putProperty("a", $i);
            // The key of the message. 
            $pubMsg->setMessageKey("MessageKey");
            // The time interval between the sending time of the transactional message and the start time of the first back-check for the status of the local transaction. The time interval is a relative time interval. Unit: seconds. Valid values: 10 to 300. 
            // If the message is not committed or rolled back after the first back-check for the status of the local transaction, the broker initiates a back-check request for the status of the local transaction every 10 seconds within the 24 hours. 
            $pubMsg->setTransCheckImmunityTime(10);
            $topicMessage = $this->transProducer->publishMessage($pubMsg);

            print "\npublish -> \n\t" . $topicMessage->getMessageId() . " " . $topicMessage->getReceiptHandle() . "\n";

            if ($i == 0) {
                try {
                    // After the producer sends the transactional message, the broker obtains the handle of the half message that corresponds to the transactional message, and can directly commit or roll back the half message. 
                    $this->transProducer->commit($topicMessage->getReceiptHandle());
                    print "\n commit transaction msg when publish: " . $topicMessage->getMessageId() . "\n";
                } catch (\Exception $e) {
                    // If the transactional message is committed or rolled back after the time specified by the TransCheckImmunityTime parameter elapses, the commit or rollback fails. 
                    processAckError($e);
                }
            }
        }

        // The producer needs a thread or process to process unacknowledged transactional messages. 
        // Process unacknowledged transactional messages. 
        $this->consumeHalfMsg();
    }
}


$instance = new ProducerTest();
$instance->run();

?>

Subscribe to transactional messages

The following sample code provides an example on how to subscribe to transactional messages:

<?php

require "vendor/autoload.php";

use MQ\Model\TopicMessage;
use MQ\MQClient;

class ConsumerTest
{
    private $client;
    private $producer;

    public function __construct()
    {
        $this->client = new MQClient(
            // The HTTP endpoint. To obtain the HTTP endpoint, log on to the Message Queue for Apache RocketMQ console. In the left-side navigation pane, click Instances. On the Instances page, click the name of your instance. On the Instance Details page, scroll to the Basic Information section and view the endpoint on the Endpoints tab. 
            "${HTTP_ENDPOINT}",
            // The AccessKey ID that you created in the RAM console for identity authentication. 
            "${ACCESS_KEY}",
            // The AccessKey secret that you created in the RAM console for identity authentication. 
            "${SECRET_KEY}"
        );

        // The topic of the message. The topic must have been created in the Message Queue for Apache RocketMQ console. 
        $topic = "${TOPIC}";
        // The group ID that you created in the Message Queue for Apache RocketMQ console. 
        $groupId = "${GROUP_ID}";
        // The ID of the instance to which the topic belongs. The instance must have been created in the Message Queue for Apache RocketMQ console. 
        // If the instance has a namespace, the instance ID must be passed in. If the instance does not have a namespace, pass in null or an empty string. Check whether your instance has a namespace on the Instance Details page in the Message Queue for Apache RocketMQ console.
        $instanceId = "${INSTANCE_ID}";

        $this->consumer = $this->client->getConsumer($instanceId, $topic, $groupId);
    }

    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. 
                // In long polling mode, if no message in the topic is available for consumption, the request is suspended on the broker for a specified period of time. If a message is available for consumption within the duration, a response is immediately sent to the consumer. In this example, the duration is 3 seconds. 
                $messages = $this->consumer->consumeMessage(
                    3, // The maximum number of messages that can be consumed at a time. In this example, the value is set to 3. The largest value you can set is 16. 
                    3  // The duration of a long polling cycle. Unit: seconds. In this example, the value is set to 3. The largest value you can set is 30. 
                );
            } catch (\Exception $e) {
                if ($e instanceof MQ\Exception\MessageNotExistException) {
                    // If no messages in the topic are available for consumption, the consumer requests the broker in long polling mode. 
                    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";

            // Specify the business processing 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 acknowledgment (ACK) from the consumer before the period of time specified in $message->getNextConsumeTime() elapses, the message will be consumed again. 
            // A unique timestamp is specified for the handle of a message each time the message is consumed. 
            print_r($receiptHandles);
            try {
                $this->consumer->ackMessage($receiptHandles);
            } catch (\Exception $e) {
                if ($e instanceof MQ\Exception\AckMessageException) {
                    // The broker may fail to receive an ACK for a message from the consumer if the handle of the message times out. 
                    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());
                    }
                }
            }
            print "ack finish\n";


        }

    }
}


$instance = new ConsumerTest();
$instance->run();

?>