rocketmq-sdk-ts
v0.1.1
Published
Pure TypeScript RocketMQ 4.x Remoting client with ACL and TLS
Maintainers
Readme
rocketmq-sdk-ts
纯 TypeScript 实现的 RocketMQ 4.x Remoting SDK,运行于 Node.js 和 Bun,支持 ACL 与 TLS, 不依赖 gRPC 或原生扩展。
提供同步 Producer 和集群模式 PushConsumer,包括 ACL、TLS、心跳、队列分配、 TAG 过滤、长轮询、消费进度提交和失败重投。
npm install rocketmq-sdk-tsimport { createProducer } from "rocketmq-sdk-ts";
const producer = createProducer({
nameServers: ["rocketmq.example.com:9876"],
accessKey: process.env.ROCKETMQ_ACCESS_KEY!,
secretKey: process.env.ROCKETMQ_SECRET_KEY!,
tls: true,
});
await producer.start();
const result = await producer.send({
topic: "order_events",
tag: "created",
body: JSON.stringify({ event: "created" }),
});
await producer.close();import { createPushConsumer } from "rocketmq-sdk-ts";
const consumer = createPushConsumer(
{
nameServers: ["rocketmq.example.com:9876"],
accessKey: process.env.ROCKETMQ_ACCESS_KEY!,
secretKey: process.env.ROCKETMQ_SECRET_KEY!,
groupName: "GID_order_service_consumer",
subscriptions: {
order_events: "created || updated",
},
tls: true,
maxAttempts: 3,
},
async (message) => {
const payload = JSON.parse(message.body.toString("utf8"));
await handleEvent(payload);
return "success";
},
);
await consumer.start();
process.once("SIGTERM", () => void consumer.close());消费处理器返回 "retry" 或抛出异常时,消息会重投并按 Broker 的重试策略再次投递。
同一 groupName 的多个实例会自动平均分配队列。不同业务应使用不同的消费组前缀。
使用云托管 RocketMQ 时,需要先在控制台创建对应的消费组。
tls 默认启用。为兼容 RocketMQ 4.x 服务端自签名证书,默认不校验证书链;
提供可信 CA 后可传 tls: { rejectUnauthorized: true, ca } 开启校验。
只有服务端明确未启用 TLS 时才传 tls: false。
