云消息队列 RocketMQ 版提供类似XA或Open XA的分布式事务功能,通过云消息队列 RocketMQ 版事务消息,能达到分布式事务的最终一致。本文提供使用HTTP协议下的Go SDK收发事务消息的示例代码。
背景信息
事务消息的交互流程如下图所示。
更多信息,请参见事务消息。
前提条件
您已完成以下操作:
安装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
}
}