全部產品
Search
文件中心

ApsaraMQ for RocketMQ:收發事務訊息

更新時間:Jul 01, 2024

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

背景資訊

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

圖片1.png

更多資訊,請參見事務訊息

前提條件

您已完成以下操作:

  • 安裝Go SDK。更多資訊,請參見準備環境

  • 建立資源。代碼中涉及的資源資訊,例如執行個體、Topic和Group ID等,需要在控制台上提前建立。更多資訊,請參見建立資源

  • 擷取阿里雲存取金鑰AccessKey ID和AccessKey Secret。更多資訊,請參見建立AccessKey

發送事務訊息

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

package main

import (
    "fmt"
    "github.com/gogap/errors"
    "strconv"
    "strings"
    "time"
    "os"

    "github.com/aliyunmq/mq-http-go-sdk"
)

var loopCount = 0

func ProcessError(err error) {
    // 如果Commit或Rollback時超過了TransCheckImmunityTime(針對發送事務訊息的控制代碼)或者超過10s(針對consumeHalfMessage的控制代碼),則Commit或Rollback失敗。
    if err == nil {
        return
    }
    fmt.Println(err)
    for _, errAckItem := range err.(errors.ErrCode).Context()["Detail"].([]mq_http_sdk.ErrAckItem) {
        fmt.Printf("\tErrorHandle:%s, ErrorCode:%s, ErrorMsg:%s\n",
            errAckItem.ErrorHandle, errAckItem.ErrorCode, errAckItem.ErrorMsg)
    }
}

func ConsumeHalfMsg(mqTransProducer *mq_http_sdk.MQTransProducer) {
    for {
        if loopCount >= 10 {
            return
        }
        loopCount++
        endChan := make(chan int)
        respChan := make(chan mq_http_sdk.ConsumeMessageResponse)
        errChan := make(chan error)
        go func() {
            select {
            case resp := <-respChan:
                {
                    // 處理商務邏輯。
                    var handles []string
                    fmt.Printf("Consume %d messages---->\n", len(resp.Messages))
                    for _, v := range resp.Messages {
                        handles = append(handles, v.ReceiptHandle)
                        fmt.Printf("\tMessageID: %s, PublishTime: %d, MessageTag: %s\n"+
                            "\tConsumedTimes: %d, FirstConsumeTime: %d, NextConsumeTime: %d\n\tBody: %s\n"+
                            "\tProperties:%s, Key:%s, Timer:%d, Trans:%d\n",
                            v.MessageId, v.PublishTime, v.MessageTag, v.ConsumedTimes,
                            v.FirstConsumeTime, v.NextConsumeTime, v.MessageBody,
                            v.Properties, v.MessageKey, v.StartDeliverTime, v.TransCheckImmunityTime)

                        a, _ := strconv.Atoi(v.Properties["a"])
                        var comRollErr error
                        if a == 1 {
                            // 確認提交事務訊息。
                            comRollErr = (*mqTransProducer).Commit(v.ReceiptHandle)
                            fmt.Println("Commit---------->")
                        } else if a == 2 && v.ConsumedTimes > 1 {
                            // 確認提交事務訊息。
                            comRollErr = (*mqTransProducer).Commit(v.ReceiptHandle)
                            fmt.Println("Commit---------->")
                        } else if a == 3 {
                            // 確認復原事務訊息。
                            comRollErr = (*mqTransProducer).Rollback(v.ReceiptHandle)
                            fmt.Println("Rollback---------->")
                        } else {
                            // 什麼都不做,下次再檢查。
                            fmt.Println("Unknown---------->")
                        }
                        ProcessError(comRollErr)
                    }
                    endChan <- 1
                }
            case err := <-errChan:
                {
                    // Topic中沒有訊息可消費。
                    if strings.Contains(err.(errors.ErrCode).Error(), "MessageNotExist") {
                        fmt.Println("\nNo new message, continue!")
                    } else {
                        fmt.Println(err)
                        time.Sleep(time.Duration(3) * time.Second)
                    }
                    endChan <- 1
                }
            case <-time.After(35 * time.Second):
                {
                    fmt.Println("Timeout of consumer message ??")
                    return
                }
            }
        }()

        // 長輪詢檢查半事務訊息。
        // 長輪詢表示如果Topic沒有訊息則請求會在服務端掛起3s,3s內如果有訊息可以消費則立即返迴響應。
        (*mqTransProducer).ConsumeHalfMessage(respChan, errChan,
            3, // 一次最多消費3條(最多可設定為16條)。
            3, // 長輪詢時間3秒(最多可設定為30秒)。
        )
        <-endChan
    }
}

func main() {
    // 設定HTTP協議用戶端存取點,進入訊息佇列RocketMQ版控制台執行個體詳情頁面的存取點地區查看。
    endpoint := "${HTTP_ENDPOINT}"
    // 請確保環境變數ALIBABA_CLOUD_ACCESS_KEY_ID、ALIBABA_CLOUD_ACCESS_KEY_SECRET已設定。
    // AccessKey ID,阿里雲身分識別驗證標識。
    accessKey := os.Getenv("ALIBABA_CLOUD_ACCESS_KEY_ID")
    // AccessKey Secret,阿里雲身分識別驗證密鑰。
    secretKey := os.Getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET")
    // 訊息所屬的Topic,在訊息佇列RocketMQ版控制台建立。   
    //不同訊息類型的Topic不能混用,例如普通訊息的Topic只能用於收發普通訊息,不能用於收發其他類型的訊息。
    topic := "${TOPIC}"
    // Topic所屬的執行個體ID,在訊息佇列RocketMQ版控制台建立。
    // 若執行個體有命名空間,則執行個體ID必須傳入;若執行個體無命名空間,則執行個體ID傳入null空值或字串空值。執行個體的命名空間可以在訊息佇列RocketMQ版控制台的執行個體詳情頁面查看。
    instanceId := "${INSTANCE_ID}"
    // 您在控制台建立的Group ID。
    groupId := "${GROUP_ID}"

    client := mq_http_sdk.NewAliyunMQClient(endpoint, accessKey, secretKey, "")

    mqTransProducer := client.GetTransProducer(instanceId, topic, groupId)

    // 用戶端需要有一個線程或者進程來消費沒有確認的事務訊息。
    // 啟動一個Goroutines來檢查沒有確認的事務訊息。
    go ConsumeHalfMsg(&mqTransProducer)

    // 發送4條事務訊息,1條發送完就提交,其餘3條通過檢查半事務訊息處理。
    for i := 0; i < 4; i++ {
        msg := mq_http_sdk.PublishMessageRequest{
            MessageBody:"I am transaction msg!",
            Properties: map[string]string{"a":strconv.Itoa(i)},
        }
        // 設定事務第一次回查的時間,為相對時間。單位:秒,範圍:10~300。
        // 第一次事務回查後如果訊息沒有Commit或者Rollback,則之後每隔10s左右會回查一次,共回查24小時。
        msg.TransCheckImmunityTime = 10

        resp, pubErr := mqTransProducer.PublishMessage(msg)
        if pubErr != nil {
            fmt.Println(pubErr)
            return
        }
        fmt.Printf("Publish ---->\n\tMessageId:%s, BodyMD5:%s, Handle:%s\n",
            resp.MessageId, resp.MessageBodyMD5, resp.ReceiptHandle)
        if i == 0 {
            // 發送完事務訊息後能擷取到半訊息控制代碼,可以直接Commit或Rollback事務訊息。
            ackErr := mqTransProducer.Commit(resp.ReceiptHandle)
            fmt.Println("Commit---------->")
            ProcessError(ackErr)
        }
    }

    for ; loopCount < 10 ; {
        time.Sleep(time.Duration(1) * time.Second)
    }
}

訂閱事務訊息

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

package main

import (
    "fmt"
    "github.com/gogap/errors"
    "strings"
    "time"
    "os"

    "github.com/aliyunmq/mq-http-go-sdk"
)

func main() {
    // 設定HTTP協議用戶端存取點,進入訊息佇列RocketMQ版控制台執行個體詳情頁面的存取點地區查看。
    endpoint := "${HTTP_ENDPOINT}"
    // 請確保環境變數ALIBABA_CLOUD_ACCESS_KEY_ID、ALIBABA_CLOUD_ACCESS_KEY_SECRET已設定。
    // AccessKey ID,阿里雲身分識別驗證標識。
    accessKey := os.Getenv("ALIBABA_CLOUD_ACCESS_KEY_ID")
    // AccessKey Secret,阿里雲身分識別驗證密鑰。
    secretKey := os.Getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET")
    // 訊息所屬的Topic,在訊息佇列RocketMQ版控制台建立。
    //不同訊息類型的Topic不能混用,例如普通訊息的Topic只能用於收發普通訊息,不能用於收發其他類型的訊息。
    topic := "${TOPIC}"
    // Topic所屬的執行個體ID,在訊息佇列RocketMQ版控制台建立。
    // 若執行個體有命名空間,則執行個體ID必須傳入;若執行個體無命名空間,則執行個體ID傳入null空值或字串空值。執行個體的命名空間可以在訊息佇列RocketMQ版控制台的執行個體詳情頁面查看。
    instanceId := "${INSTANCE_ID}"
    // 您在控制台建立的Group ID。
    groupId := "${GROUP_ID}"

    client := mq_http_sdk.NewAliyunMQClient(endpoint, accessKey, secretKey, "")

    mqConsumer := client.GetConsumer(instanceId, topic, groupId, "")

    for {
        endChan := make(chan int)
        respChan := make(chan mq_http_sdk.ConsumeMessageResponse)
        errChan := make(chan error)
        go func() {
            select {
            case resp := <-respChan:
                {
                    // 處理商務邏輯。
                    var handles []string
                    fmt.Printf("Consume %d messages---->\n", len(resp.Messages))
                    for _, v := range resp.Messages {
                        handles = append(handles, v.ReceiptHandle)
                        fmt.Printf("\tMessageID: %s, PublishTime: %d, MessageTag: %s\n"+
                            "\tConsumedTimes: %d, FirstConsumeTime: %d, NextConsumeTime: %d\n"+
                            "\tBody: %s\n"+
                            "\tProps: %s\n",
                            v.MessageId, v.PublishTime, v.MessageTag, v.ConsumedTimes,
                            v.FirstConsumeTime, v.NextConsumeTime, v.MessageBody, v.Properties)
                    }

                    // NextConsumeTime前若不確認訊息消費成功,則訊息會被重複消費。
                    // 訊息控制代碼有時間戳記,同一條訊息每次消費拿到的都不一樣。
                    ackerr := mqConsumer.AckMessage(handles)
                    if ackerr != nil {
                        // 某些訊息的控制代碼可能逾時,會導致訊息消費狀態確認不成功。
                        fmt.Println(ackerr)
                        if errAckItems, ok := ackerr.(errors.ErrCode).Context()["Detail"].([]mq_http_sdk.ErrAckItem); ok {
                           for _, errAckItem := range errAckItems {
                             fmt.Printf("\tErrorHandle:%s, ErrorCode:%s, ErrorMsg:%s\n",
                               errAckItem.ErrorHandle, errAckItem.ErrorCode, errAckItem.ErrorMsg)
                           }
                        } else {
                           fmt.Println("ack err =", ackerr)
                        }
                        time.Sleep(time.Duration(3) * time.Second)
                    } else {
                        fmt.Printf("Ack ---->\n\t%s\n", handles)
                    }

                    endChan <- 1
                }
            case err := <-errChan:
                {
                    // Topic中沒有訊息可消費。
                    if strings.Contains(err.(errors.ErrCode).Error(), "MessageNotExist") {
                        fmt.Println("\nNo new message, continue!")
                    } else {
                        fmt.Println(err)
                        time.Sleep(time.Duration(3) * time.Second)
                    }
                    endChan <- 1
                }
            case <-time.After(35 * time.Second):
                {
                    fmt.Println("Timeout of consumer message ??")
                    endChan <- 1
                }
            }
        }()

        // 長輪詢消費訊息,網路逾時時間預設為35s。
        // 長輪詢表示如果Topic沒有訊息,則用戶端請求會在服務端掛起3s,3s內如果有訊息可以消費則立即返迴響應。
        mqConsumer.ConsumeMessage(respChan, errChan,
            3, // 一次最多消費3條(最多可設定為16條)。
            3, // 長輪詢時間3s(最多可設定為30s)。
        )
        <-endChan
    }
}