收發事務訊息 - ApsaraMQ for RocketMQ

雲訊息佇列 RocketMQ 版提供類似XA或Open XA的分散式交易功能，通過雲訊息佇列 RocketMQ 版事務訊息，能達到分散式交易的最終一致。本文提供使用HTTP協議下的Java SDK收發事務訊息的範例程式碼。

背景資訊

事務訊息的互動流程如下圖所示。

圖片1.png

更多資訊，請參見事務訊息。

前提條件

您已完成以下操作：

安裝Java SDK。更多資訊，請參見準備環境。
建立資源。代碼中涉及的資源資訊，例如執行個體、Topic和Group ID等，需要在控制台上提前建立。更多資訊，請參見建立資源。
擷取阿里雲存取金鑰AccessKey ID和AccessKey Secret。更多資訊，請參見建立AccessKey。

發送事務訊息

發送事務訊息的範例程式碼如下。

import com.aliyun.mq.http.MQClient;
import com.aliyun.mq.http.MQTransProducer;
import com.aliyun.mq.http.common.AckMessageException;
import com.aliyun.mq.http.model.Message;
import com.aliyun.mq.http.model.TopicMessage;

import java.util.List;

public class TransProducer {


    static void processCommitRollError(Throwable e) {
        if (e instanceof AckMessageException) {
            AckMessageException errors = (AckMessageException) e;
            System.out.println("Commit/Roll transaction error, requestId is:" + errors.getRequestId() + ", fail handles:");
            if (errors.getErrorMessages() != null) {
                for (String errorHandle :errors.getErrorMessages().keySet()) {
                    System.out.println("Handle:" + errorHandle + ", ErrorCode:" + errors.getErrorMessages().get(errorHandle).getErrorCode()
                            + ", ErrorMsg:" + errors.getErrorMessages().get(errorHandle).getErrorMessage());
                }
            }
        }
    }

    public static void main(String[] args) throws Throwable {
        MQClient mqClient = new MQClient(
                // 設定HTTP協議用戶端存取點，進入訊息佇列RocketMQ版控制台執行個體詳情頁面的存取點地區查看。
                "${HTTP_ENDPOINT}",
                // 請確保環境變數ALIBABA_CLOUD_ACCESS_KEY_ID、ALIBABA_CLOUD_ACCESS_KEY_SECRET已設定。
                // AccessKey ID，阿里雲身分識別驗證標識。
	              System.getenv("ALIBABA_CLOUD_ACCESS_KEY_ID"),
	              // AccessKey Secret，阿里雲身分識別驗證密鑰。
	              System.getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET")
        );

        // 訊息所屬的Topic，在訊息佇列RocketMQ版控制台建立。
        // 不同訊息類型的Topic不能混用，例如普通訊息的Topic只能用於收發普通訊息，不能用於收發其他類型的訊息。
        final String topic = "${TOPIC}";
        // Topic所屬的執行個體ID，在訊息佇列RocketMQ版控制台建立。
        // 若執行個體有命名空間，則執行個體ID必須傳入；若執行個體無命名空間，則執行個體ID傳入null空值或字串空值。執行個體的命名空間可以在訊息佇列RocketMQ版控制台的執行個體詳情頁面查看。
        final String instanceId = "${INSTANCE_ID}";
        // 您在訊息佇列RocketMQ版控制台建立的Group ID。
        final String groupId = "${GROUP_ID}";

        final MQTransProducer mqTransProducer = mqClient.getTransProducer(instanceId, topic, groupId);

        for (int i = 0; i < 4; i++) {
            TopicMessage topicMessage = new TopicMessage();
            topicMessage.setMessageBody("trans_msg");
            topicMessage.setMessageTag("a");
            topicMessage.setMessageKey(String.valueOf(System.currentTimeMillis()));
            // 設定事務第一次回查的時間，為相對時間。單位：秒，取值範圍：10~300。
            // 第一次事務回查後如果訊息沒有提交或者復原，則之後每隔10s左右會回查一次，共回查24小時。
            topicMessage.setTransCheckImmunityTime(10);
            topicMessage.getProperties().put("a", String.valueOf(i));

            TopicMessage pubResultMsg = null;
            pubResultMsg = mqTransProducer.publishMessage(topicMessage);
            System.out.println("Send---->msgId is: " + pubResultMsg.getMessageId()
                    + ", bodyMD5 is: " + pubResultMsg.getMessageBodyMD5()
                    + ", Handle: " + pubResultMsg.getReceiptHandle()
            );
            if (pubResultMsg != null && pubResultMsg.getReceiptHandle() != null) {
                if (i == 0) {
                    // 發送完事務訊息後能擷取到半訊息控制代碼，可以直接提交或復原事務訊息。
                    try {
                        mqTransProducer.commit(pubResultMsg.getReceiptHandle());
                        System.out.println(String.format("MessageId:%s, commit", pubResultMsg.getMessageId()));
                    } catch (Throwable e) {
                        // 如果提交或復原事務訊息時超過了TransCheckImmunityTime（針對發送事務訊息的控制代碼）設定的時間長度，則會失敗。
                        if (e instanceof AckMessageException) {
                            processCommitRollError(e);
                            continue;
                        }
                    }
                }
            }
        }

        // 用戶端需要有一個線程或者進程來消費沒有確認的事務訊息。
        // 啟動一個線程來檢查沒有確認的事務訊息。
        Thread t = new Thread(new Runnable() {
            public void run() {
                int count = 0;
                while(true) {
                    try {
                        if (count == 3) {
                            break;
                        }
                        List<Message> messages = mqTransProducer.consumeHalfMessage(3, 3);
                        if (messages == null) {
                            System.out.println("No Half message!");
                            continue;
                        }
                        System.out.println(String.format("Half---->MessageId:%s,Properties:%s,Body:%s,Latency:%d",
                                messages.get(0).getMessageId(),
                                messages.get(0).getProperties(),
                                messages.get(0).getMessageBodyString(),
                                System.currentTimeMillis() - messages.get(0).getPublishTime()));

                        for (Message message : messages) {
                            try {
                                if (Integer.valueOf(message.getProperties().get("a")) == 1) {
                                    // 確認提交事務訊息。
                                    mqTransProducer.commit(message.getReceiptHandle());
                                    count++;
                                    System.out.println(String.format("MessageId:%s, commit", message.getMessageId()));
                                } else if (Integer.valueOf(message.getProperties().get("a")) == 2
                                        && message.getConsumedTimes() > 1) {
                                    // 確認提交事務訊息。
                                    mqTransProducer.commit(message.getReceiptHandle());
                                    count++;
                                    System.out.println(String.format("MessageId:%s, commit", message.getMessageId()));
                                } else if (Integer.valueOf(message.getProperties().get("a")) == 3) {
                                    // 確認復原事務訊息。
                                    mqTransProducer.rollback(message.getReceiptHandle());
                                    count++;
                                    System.out.println(String.format("MessageId:%s, rollback", message.getMessageId()));
                                } else {
                                    // 什麼都不做，下次再檢查。
                                    System.out.println(String.format("MessageId:%s, unknown", message.getMessageId()));
                                }
                            } catch (Throwable e) {
                                // 如果提交或復原訊息時超過了TransCheckImmunityTime（針對發送事務訊息的控制代碼）或者超過10s（針對consumeHalfMessage的控制代碼）則會失敗。
                                processCommitRollError(e);
                            }
                        }
                    } catch (Throwable e) {
                        System.out.println(e.getMessage());
                    }
                }
            }
        });

        t.start();

        t.join();

        mqClient.close();
    }

}

訂閱事務訊息

訂閱事務訊息的範例程式碼如下。

import com.aliyun.mq.http.MQClient;
import com.aliyun.mq.http.MQConsumer;
import com.aliyun.mq.http.common.AckMessageException;
import com.aliyun.mq.http.model.Message;

import java.util.ArrayList;
import java.util.List;

public class Consumer {

    public static void main(String[] args) {
        MQClient mqClient = new MQClient(
                // 設定HTTP協議用戶端存取點，進入訊息佇列RocketMQ版控制台執行個體詳情頁面的存取點地區查看。
                "${HTTP_ENDPOINT}",
                // 請確保環境變數ALIBABA_CLOUD_ACCESS_KEY_ID、ALIBABA_CLOUD_ACCESS_KEY_SECRET已設定。
                // AccessKey ID，阿里雲身分識別驗證標識。
	              System.getenv("ALIBABA_CLOUD_ACCESS_KEY_ID"),
	              // AccessKey Secret，阿里雲身分識別驗證密鑰。
	              System.getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET")
        );

        // 訊息所屬的Topic，在訊息佇列RocketMQ版控制台建立。
        //不同訊息類型的Topic不能混用，例如普通訊息的Topic只能用於收發普通訊息，不能用於收發其他類型的訊息。
        final String topic = "${TOPIC}";
        // 您在訊息佇列RocketMQ版控制台建立的Group ID。
        final String groupId = "${GROUP_ID}";
        // Topic所屬的執行個體ID，在訊息佇列RocketMQ版控制台建立。
        // 若執行個體有命名空間，則執行個體ID必須傳入；若執行個體無命名空間，則執行個體ID傳入null空值或字串空值。執行個體的命名空間可以在訊息佇列RocketMQ版控制台的執行個體詳情頁面查看。
        final String instanceId = "${INSTANCE_ID}";

        final MQConsumer consumer;
        if (instanceId != null && instanceId != "") {
            consumer = mqClient.getConsumer(instanceId, topic, groupId, null);
        } else {
            consumer = mqClient.getConsumer(topic, groupId);
        }

        // 在當前線程迴圈消費訊息，建議多開個幾個線程並發消費訊息。
        do {
            List<Message> messages = null;

            try {
                // 長輪詢消費訊息。
                // 長輪詢表示如果Topic沒有訊息,則請求會在服務端掛起3s，3s內如果有訊息可以消費則立即返回用戶端。
                messages = consumer.consumeMessage(
                        3,// 一次最多消費3條訊息（最多可設定為16條）。
                        3// 長輪詢時間3秒（最多可設定為30秒）。
                );
            } catch (Throwable e) {
                e.printStackTrace();
                try {
                    Thread.sleep(2000);
                } catch (InterruptedException e1) {
                    e1.printStackTrace();
                }
            }
            // Topic中沒有訊息可消費。
            if (messages == null || messages.isEmpty()) {
                System.out.println(Thread.currentThread().getName() + ": no new message, continue!");
                continue;
            }

            // 處理商務邏輯。
            for (Message message : messages) {
                System.out.println("Receive message: " + message);
            }

            // 訊息重試時間到達前若不確認訊息消費成功，則訊息會被重複消費。
            // 訊息控制代碼有時間戳記，同一條訊息每次消費的時間戳記都不一樣。
            {
                List<String> handles = new ArrayList<String>();
                for (Message message : messages) {
                    handles.add(message.getReceiptHandle());
                }

                try {
                    consumer.ackMessage(handles);
                } catch (Throwable e) {
                    // 某些訊息的控制代碼可能逾時，會導致訊息消費狀態確認不成功。
                    if (e instanceof AckMessageException) {
                        AckMessageException errors = (AckMessageException) e;
                        System.out.println("Ack message fail, requestId is:" + errors.getRequestId() + ", fail handles:");
                        if (errors.getErrorMessages() != null) {
                            for (String errorHandle :errors.getErrorMessages().keySet()) {
                                System.out.println("Handle:" + errorHandle + ", ErrorCode:" + errors.getErrorMessages().get(errorHandle).getErrorCode()
                                        + ", ErrorMsg:" + errors.getErrorMessages().get(errorHandle).getErrorMessage());
                            }
                        }
                        continue;
                    }
                    e.printStackTrace();
                }
            }
        } while (true);
    }
}