跳到主要内容

RabbitMQ Stream 教程 - “Hello World！”

简介​

信息

先决条件​

本教程假定您已安装 RabbitMQ，并在 localhost 上运行，并且已启用 stream 插件。标准 stream 端口为 5552。如果您使用不同的主机、端口或凭据，则需要调整连接设置。

使用 Docker​

如果您没有安装 RabbitMQ，则可以在 Docker 容器中运行它

docker run -it --rm --name rabbitmq -p 5552:5552 -p 15672:15672 -p 5672:5672  \
    -e RABBITMQ_SERVER_ADDITIONAL_ERL_ARGS='-rabbitmq_stream advertised_host localhost' \
    rabbitmq:4-management

等待服务器启动，然后启用 stream 和 stream management 插件

docker exec rabbitmq rabbitmq-plugins enable rabbitmq_stream rabbitmq_stream_management

在哪里获得帮助​

如果您在学习本教程时遇到问题，可以通过邮件列表或 Discord 社区服务器联系我们。

RabbitMQ Streams 在 RabbitMQ 3.9 中引入。更多信息请访问此处。

“Hello World”​

（使用 NodeJs Stream Client）​

在本教程的这一部分，我们将用 JavaScript 编写两个程序；一个生产者，它发送一条消息，以及一个消费者，它接收消息并打印出来。我们将略过 JavaScript 客户端 API 中的一些细节，专注于这个非常简单的事情，以便入门。这是 RabbitMQ Streams 的“Hello World”。

Node.js stream 客户端库​

RabbitMQ 使用多种协议。本教程使用 RabbitMQ stream 协议，该协议是 RabbitMQ streams 的专用协议。在 许多不同的语言中，RabbitMQ 都有许多客户端，请参阅每种语言的 stream 客户端库。我们将使用 Coders51 构建和支持的 Node.js stream 客户端。

该客户端支持 Node.js >= 16.x。本教程将使用 Node.js stream 客户端 0.3.1 版本。客户端 0.3.1 及更高版本通过 npm 分发。

本教程假定您在 Windows 上使用 powershell。在 MacOS 和 Linux 上，几乎任何 shell 都可以工作。

设置​

首先，让我们验证您的 PATH 中是否包含 Node.js 工具链

npm --help

运行该命令应生成帮助消息。

现在让我们创建一个项目

npm init

然后安装客户端

npm install rabbitmq-stream-js-client

这是 package.json 应有的样子

{

  "name": "rabbitmq-stream-node-tutorial",
  "version": "1.0.0",
  "description": "Tutorial for the nodejs RabbitMQ stream client",
  "scripts": {
    "send": "node send.js",
    "receive": "node receive.js"
  },
  "dependencies": {
    "rabbitmq-stream-js-client": "^0.3.1"
  }
}

现在创建名为 receive.js 和 send.js 的新文件。现在我们已经设置了 Node.js 项目，我们可以编写一些代码了。

发送​

我们将消息生产者（发送者）称为 send.js，将消息消费者（接收者）称为 receive.js。生产者将连接到 RabbitMQ，发送一条消息，然后退出。

在 send.js 中，我们需要添加客户端

const rabbit = require("rabbitmq-stream-js-client")

然后我们可以创建到服务器的连接

const client = await rabbit.connect({
    hostname: "localhost",
    port: 5552,
    username: "guest",
    password: "guest",
    vhost: "/",
})

客户端的入口点是 Client 类。它用于 stream 管理和发布者实例的创建。

它抽象了套接字连接，并为我们处理协议版本协商和身份验证等。

本教程假定 stream 发布者和消费者连接到本地运行的 RabbitMQ 节点，即 localhost。要连接到不同机器上的节点，只需指定目标主机名或 IP 地址 Client 参数。

接下来，让我们创建一个生产者。

生产者还将声明一个 stream，它将向其发布消息，然后发布一条消息

const streamName = "hello-nodejs-stream";

console.log("Connecting...");
const client = await rabbit.connect({
        vhost: "/",
        port: 5552,
        hostname: "localhost",
        username: "guest",
        password: "guest",
    });

console.log("Making sure the stream exists...");
const streamSizeRetention = 5 * 1e9
await client.createStream({ stream: streamName, arguments: { "max-length-bytes": streamSizeRetention } });

const publisher = await client.declarePublisher({ stream: streamName });

console.log("Sending a message...");
await publisher.send(Buffer.from("Test message"));

stream 声明操作是幂等的：仅当 stream 尚不存在时，才会创建 stream。

Stream 是一种仅追加日志抽象，允许重复消费消息，直到消息过期。始终定义保留策略是一个好习惯。在上面的示例中，stream 的大小限制为 5 GiB。

消息内容是一个字节数组。应用程序可以使用任何适当的格式（例如 JSON、MessagePack 等）对他们需要传输的数据进行编码。

当上面的代码完成运行时，生产者连接和 stream 系统连接将关闭。这就是我们的生产者。

每次运行生产者时，它都会向服务器发送一条消息，并且该消息将附加到 stream。

完整的 send.js 文件可以在 GitHub 上找到。

发送不起作用​

如果这是您第一次使用 RabbitMQ，并且没有看到“Sent”消息，那么您可能会挠头想知道哪里出错了。可能是 broker 启动时没有足够的可用磁盘空间（默认情况下至少需要 50 MB 可用空间），因此拒绝接受消息。检查 broker 日志文件，查看是否记录了资源警报，并在必要时降低可用磁盘空间阈值。配置指南将向您展示如何设置 disk_free_limit。

另一个原因可能是程序在消息到达 broker 之前退出。在某些客户端库中，发送是异步的：函数立即返回，但消息在通过线路传输之前会在 IO 层排队。发送程序要求用户按键以完成该过程：消息有足够的时间到达 broker。stream 协议提供了一种确认机制，以确保 broker 接收到出站消息，但为了简单起见，本教程未使用此机制。

接收​

本教程的另一部分，消费者，将连接到 RabbitMQ 节点并等待消息被推送到它。与本教程中发布单条消息并停止的生产者不同，消费者将持续运行，消费 RabbitMQ 将推送给它的消息，并打印接收到的有效负载。

与 send.js 类似，receive.js 需要使用客户端

const rabbit = require("rabbitmq-stream-js-client")

在初始设置方面，消费者部分与生产者部分非常相似；我们使用默认连接设置并声明消费者将从中消费的 stream。

const client = await rabbit.connect({
    hostname: "localhost",
    port: 5552,
    username: "guest",
    password: "guest",
    vhost: "/",
})
const streamSizeRetention = 5 * 1e9
await client.createStream({ stream: streamName, arguments: { "max-length-bytes": streamSizeRetention } });

请注意，消费者部分也声明了 stream。这是为了允许任何一部分首先启动，无论是生产者还是消费者。

我们使用 declareConsumer 方法来创建消费者。我们提供一个回调来处理传递的消息。

offset 定义了消费者的起点。在本例中，消费者从 stream 中可用的第一条消息开始。

await client.declareConsumer({ stream: streamName, offset: rabbit.Offset.first() }, (message) => {
        console.log(`Received message ${message.content.toString()}`)
})

完整的 receive.js 文件可以在 GitHub 上找到。

将它们放在一起​

为了运行这两个示例，请打开两个终端（shell）选项卡。

本教程的两个部分可以按任何顺序运行，因为它们都声明了 stream。让我们首先运行消费者，以便在第一个发布者启动时，消费者将打印它

npm run receive

然后运行生产者

npm run send

消费者将打印它从发布者通过 RabbitMQ 获取的消息。消费者将保持运行，等待新的交付。尝试多次重新运行发布者以观察这一点。

Streams 与队列的不同之处在于，它们是可以重复消费的消息的仅追加日志。当多个消费者从一个 stream 消费时，他们将从第一条可用消息开始。

© . All rights reserved.