云消息队列 RocketMQ 版提供类似XA或Open XA的分布式事务功能,通过云消息队列 RocketMQ 版事务消息,能达到分布式事务的最终一致。本文提供使用HTTP协议下的Node.js SDK收发事务消息的示例代码。
背景信息
事务消息的交互流程如下图所示。
更多信息,请参见事务消息。
前提条件
您已完成以下操作:
安装Node.js SDK。更多信息,请参见准备环境。
创建资源。代码中涉及的资源信息,例如实例、Topic和Group ID等,需要在控制台上提前创建。更多信息,请参见创建资源。
获取阿里云访问密钥AccessKey ID和AccessKey Secret。更多信息,请参见创建AccessKey。
发送事务消息
发送事务消息的示例代码如下。
const {
MQClient,
MessageProperties
} = require('@aliyunmq/mq-http-sdk');
// 设置HTTP协议客户端接入点,进入消息队列RocketMQ版控制台实例详情页面的接入点区域查看。
const endpoint = "${HTTP_ENDPOINT}";
// 请确保环境变量ALIBABA_CLOUD_ACCESS_KEY_ID、ALIBABA_CLOUD_ACCESS_KEY_SECRET已设置。
// AccessKey ID,阿里云身份验证标识。
const accessKeyId = process.env['ALIBABA_CLOUD_ACCESS_KEY_ID'];
// AccessKey Secret,阿里云身份验证密钥。
const accessKeySecret = process.env['ALIBABA_CLOUD_ACCESS_KEY_SECRET'];
var client = new MQClient(endpoint, accessKeyId, accessKeySecret);
// 消息所属的Topic,在消息队列RocketMQ版控制台创建。
const topic = "${TOPIC}";
// 您在消息队列RocketMQ版控制台创建的Group ID。
const groupId = "${GROUP_ID}";
// Topic所属的实例ID,在消息队列RocketMQ版控制台创建。
// 若实例有命名空间,则实例ID必须传入;若实例无命名空间,则实例ID传入null空值或字符串空值。实例的命名空间可以在消息队列RocketMQ版控制台的实例详情页面查看。
const instanceId = "${INSTANCE_ID}";
const mqTransProducer = client.getTransProducer(instanceId, topic, groupId);
async function processTransResult(res, msgId) {
if (!res) {
return;
}
if (res.code != 204) {
// 如果Commit或Rollback时超过了TransCheckImmunityTime(针对发送事务消息的句柄)或者超过10s(针对consumeHalfMessage的句柄),则Commit或Rollback失败。
console.log("Commit/Rollback Message Fail:");
const failHandles = res.body.map((error) => {
console.log("\tErrorHandle:%s, Code:%s, Reason:%s\n", error.ReceiptHandle, error.ErrorCode, error.ErrorMessage);
return error.ReceiptHandle;
});
} else {
console.log("Commit/Rollback Message suc!!! %s", msgId);
}
}
var halfMessageCount = 0;
var halfMessageConsumeCount = 0;
(async function(){
try {
// 循环发送4条事务消息。
for(var i = 0; i < 4; i++) {
let res;
msgProps = new MessageProperties();
// 设置消息的自定义属性。
msgProps.putProperty("a", i);
// 设置消息的Key。
msgProps.messageKey("MessageKey");
// 设置事务第一次回查的时间,为相对时间。单位:秒,范围:10~300。
// 第一次事务回查后如果消息没有Commit或者Rollback,则之后每隔10s左右会回查一次,共回查24小时。
msgProps.transCheckImmunityTime(10);
res = await mqTransProducer.publishMessage("hello mq.", "tagA", msgProps);
console.log("Publish message: MessageID:%s,BodyMD5:%s,Handle:%s", res.body.MessageId, res.body.MessageBodyMD5, res.body.ReceiptHandle);
if (res && i == 0) {
// 发送完事务消息后能获取到半消息句柄,可以直接Commit或Rollback事务消息。
const msgId = res.body.MessageId;
res = await mqTransProducer.commit(res.body.ReceiptHandle);
console.log("Commit msg when publish, %s", msgId);
// 如果Commit或Rollback时超过了TransCheckImmunityTime则会失败。
processTransResult(res, msgId);
}
}
} catch(e) {
// 消息发送失败,需要进行重试处理,可重新发送这条消息或持久化这条数据进行补偿处理。
console.log(e)
}
})();
// 客户端需要有一个线程或者进程来消费没有确认的事务消息。
// 检查没有确认的事务消息。
(async function() {
// 循环检查事务半消息,类似消费普通消息。
while(halfMessageCount < 3 && halfMessageConsumeCount < 15) {
try {
halfMessageConsumeCount++;
res = await mqTransProducer.consumeHalfMessage(3, 3);
if (res.code == 200) {
// 消息消费处理逻辑。
console.log("Consume Messages, requestId:%s", res.requestId);
res.body.forEach(async (message) => {
console.log("\tMessageId:%s,Tag:%s,PublishTime:%d,NextConsumeTime:%d,FirstConsumeTime:%d,ConsumedTimes:%d,Body:%s" +
",Props:%j,MessageKey:%s,Prop-A:%s",
message.MessageId, message.MessageTag, message.PublishTime, message.NextConsumeTime, message.FirstConsumeTime, message.ConsumedTimes,
message.MessageBody,message.Properties,message.MessageKey,message.Properties.a);
var propA = message.Properties && message.Properties.a ? parseInt(message.Properties.a) : 0;
var opResp;
if (propA == 1 || (propA == 2 && message.ConsumedTimes > 1)) {
opResp = await mqTransProducer.commit(message.ReceiptHandle);
console.log("Commit msg when check half, %s", message.MessageId);
halfMessageCount++;
} else if (propA == 3) {
opResp = await mqTransProducer.rollback(message.ReceiptHandle);
console.log("Rollback msg when check half, %s", message.MessageId);
halfMessageCount++;
}
processTransResult(opResp, message.MessageId);
});
}
} catch(e) {
if (e.Code && e.Code.indexOf("MessageNotExist") > -1) {
// 没有消息,则继续长轮询服务器。
console.log("Consume Transaction Half msg: no new message, RequestId:%s, Code:%s", e.RequestId, e.Code);
} else {
console.log(e);
}
}
}
})();
订阅事务消息
订阅事务消息的示例代码如下。
const {
MQClient
} = require('@aliyunmq/mq-http-sdk');
// 设置HTTP协议客户端接入点,进入消息队列RocketMQ版控制台实例详情页面的接入点区域查看。
const endpoint = "${HTTP_ENDPOINT}";
// 请确保环境变量ALIBABA_CLOUD_ACCESS_KEY_ID、ALIBABA_CLOUD_ACCESS_KEY_SECRET已设置。
// AccessKey ID,阿里云身份验证标识。
const accessKeyId = process.env['ALIBABA_CLOUD_ACCESS_KEY_ID'];
// AccessKey Secret,阿里云身份验证密钥。
const accessKeySecret = process.env['ALIBABA_CLOUD_ACCESS_KEY_SECRET'];
var client = new MQClient(endpoint, accessKeyId, accessKeySecret);
// 消息所属的Topic,在消息队列RocketMQ版控制台创建。
const topic = "${TOPIC}";
// 您在消息队列RocketMQ版控制台创建的Group ID。
const groupId = "${GROUP_ID}";
// Topic所属的实例ID,在消息队列RocketMQ版控制台创建。
// 若实例有命名空间,则实例ID必须传入;若实例无命名空间,则实例ID传入null空值或字符串空值。实例的命名空间可以在消息队列RocketMQ版控制台的实例详情页面查看。
const instanceId = "${INSTANCE_ID}";
const consumer = client.getConsumer(instanceId, topic, groupId);
(async function(){
// 循环消费消息。
while(true) {
try {
// 长轮询消费消息。
// 长轮询表示如果Topic没有消息,则客户端请求会在服务端挂起3s,3s内如果有消息可以消费则立即返回响应。
res = await consumer.consumeMessage(
3, // 一次最多消费3条(最多可设置为16条)。
3 // 长轮询时间3秒(最多可设置为30秒)。
);
if (res.code == 200) {
// 消息消费处理逻辑。
console.log("Consume Messages, requestId:%s", res.requestId);
const handles = res.body.map((message) => {
console.log("\tMessageId:%s,Tag:%s,PublishTime:%d,NextConsumeTime:%d,FirstConsumeTime:%d,ConsumedTimes:%d,Body:%s" +
",Props:%j,MessageKey:%s,Prop-A:%s",
message.MessageId, message.MessageTag, message.PublishTime, message.NextConsumeTime, message.FirstConsumeTime, message.ConsumedTimes,
message.MessageBody,message.Properties,message.MessageKey,message.Properties.a);
return message.ReceiptHandle;
});
// message.NextConsumeTime前若不确认消息消费成功,则消息会被重复消费。
// 消息句柄有时间戳,同一条消息每次消费拿到的都不一样。
res = await consumer.ackMessage(handles);
if (res.code != 204) {
// 某些消息的句柄可能超时,会导致消息消费状态确认不成功。
console.log("Ack Message Fail:");
const failHandles = res.body.map((error)=>{
console.log("\tErrorHandle:%s, Code:%s, Reason:%s\n", error.ReceiptHandle, error.ErrorCode, error.ErrorMessage);
return error.ReceiptHandle;
});
handles.forEach((handle)=>{
if (failHandles.indexOf(handle) < 0) {
console.log("\tSucHandle:%s\n", handle);
}
});
} else {
// 确认消息消费成功。
console.log("Ack Message suc, RequestId:%s\n\t", res.requestId, handles.join(','));
}
}
} catch(e) {
if (e.Code.indexOf("MessageNotExist") > -1) {
// 没有消息,则继续长轮询服务器。
console.log("Consume Message: no new message, RequestId:%s, Code:%s", e.RequestId, e.Code);
} else {
console.log(e);
}
}
}
})();
文档内容是否对您有帮助?