RabbitMQ 教程 - "Hello World!"
简介
先决条件
本教程假设 RabbitMQ 已 安装 并在 localhost 上的 标准端口 (5672) 上运行。如果您使用不同的主机、端口或凭据,则需要调整连接设置。
哪里寻求帮助
如果您在学习本教程时遇到困难,可以通过 GitHub Discussions 或 RabbitMQ 社区 Discord 联系我们。
RabbitMQ 是一个消息代理:它接收并转发消息。你可以把它想象成一个邮局:当你把想要寄出的邮件放进邮箱时,你可以确信邮递员最终会将邮件送到你的收件人手中。在这个比喻中,RabbitMQ 就是邮箱、邮局和邮递员。
RabbitMQ 和邮局的主要区别在于,它不处理纸张,而是接收、存储和转发数据的二进制数据块——消息。
RabbitMQ 和消息传递通常会使用一些行话。
-
生产(Producing)指的仅仅是发送。发送消息的程序就是生产者(producer)。
-
队列 是 RabbitMQ 中邮箱的名称。虽然消息在 RabbitMQ 和你的应用程序之间流动,但它们只能存储在队列 中。队列 的大小仅受主机内存和磁盘空间的限制,它本质上是一个大的消息缓冲区。
许多生产者 可以发送消息到同一个队列,许多消费者 可以尝试从同一个队列 接收数据。
这就是我们表示队列的方式
-
消费 的含义与接收类似。消费者 是一个主要等待接收消息的程序。
请注意,生产者、消费者和代理不一定需要驻留在同一台主机上;事实上,在大多数应用程序中它们都不会。一个应用程序也可以同时是生产者和消费者。
"Hello World"
(使用 amqp.node 客户端)
在本教程的这一部分,我们将编写两个小的 Javascript 程序;一个发送单条消息的生产者,以及一个接收并打印消息的消费者。我们会略过 amqp.node API 的一些细节,集中精力在这一非常简单的入门示例上。这就是消息传递领域的“Hello World”。
在下面的图表中,“P”是我们的生产者,“C”是我们的消费者。中间的框是一个队列——RabbitMQ 代表消费者存储的消息缓冲区。
amqp.node 客户端库
RabbitMQ 支持多种协议。本教程使用 AMQP 0-9-1,这是一种开放的、通用的消息传递协议。RabbitMQ 有许多不同语言的客户端。在本教程中,我们将使用 amqp.node 客户端。
首先,使用 npm 安装 amqp.node
npm install amqplib
现在我们已经安装了 amqp.node,可以开始写代码了。
发送
我们将把消息发布者(发送方)命名为 send.js,把消息消费者(接收方)命名为 receive.js。发布者将连接到 RabbitMQ,发送单条消息,然后退出。
在 send.js 中,我们首先需要引入该库
#!/usr/bin/env node
const amqp = require('amqplib');
下面所有的异步操作都运行在一个 async 函数内部,这样我们就可以使用 await。随后的代码片段仅展示相关行;请参考末尾的 完整 send.js 以获取完整的、可运行的程序。
我们连接到 RabbitMQ 服务器
const connection = await amqp.connect('amqp://');
接下来,我们创建一个通道,这是完成大部分操作的 API 所在。
const channel = await connection.createChannel();
为了发送,我们必须声明一个要发送到的队列;然后我们可以将消息发布到该队列。
const queue = 'hello';
const msg = 'Hello World!';
await channel.assertQueue(queue, {
durable: true,
arguments: {
'x-queue-type': 'quorum'
}
});
channel.sendToQueue(queue, Buffer.from(msg));
console.log(" [x] Sent %s", msg);
声明队列是幂等的——只有在队列不存在时才会创建。消息内容是字节数组,因此您可以对其进行任意编码。
最后,我们关闭连接并退出
setTimeout(function() {
connection.close();
process.exit(0)
}, 500);
发送不起作用!
如果这是您第一次使用 RabbitMQ,但没有看到“Sent”消息,您可能会感到困惑,不知道哪里出了问题。也许代理启动时磁盘空间不足(默认需要至少 50 MB 可用空间),因此拒绝接收消息。检查代理的日志文件,看看是否有资源警报已记录,并在必要时降低可用磁盘空间阈值。配置指南将展示如何设置
disk_free_limit。
接收
我们的发布者就到这里了。我们的消费者会监听来自 RabbitMQ 的消息,所以与只发布一条消息的发布者不同,我们将保持消费者的运行状态,监听并打印消息。
这段代码(位于 receive.js 中)与 send 具有相同的引用(require)
#!/usr/bin/env node
const amqp = require('amqplib');
和前面一样,下面的代码运行在一个 async 函数内部;请参阅末尾的 完整 receive.js。
设置过程与发布者相同;我们打开一个连接和一个通道,并声明我们将从中消费的队列。注意,这需要与 sendToQueue 所发布的队列相匹配。
const queue = 'hello';
await channel.assertQueue(queue, {
durable: true,
arguments: {
'x-queue-type': 'quorum'
}
});
请注意,我们在这里也声明了队列。因为我们可能在发布者之前启动消费者,所以我们希望确保在尝试从队列中消费消息之前,队列已经存在。
我们要告诉服务器将队列中的消息传递给我们。由于它是异步推送消息的,我们提供一个回调函数,当 RabbitMQ 向我们的消费者推送消息时,该函数会被执行。这就是 Channel.consume 的作用。
console.log(" [*] Waiting for messages in %s. To exit press CTRL+C", queue);
channel.consume(queue, function(msg) {
console.log(" [x] Received %s", msg.content.toString());
}, {
noAck: true
});
总而言之
现在我们可以运行这两个脚本了。在终端中,进入 rabbitmq-tutorials/javascript-nodejs/src/ 文件夹,运行发布者
./send.js
然后,运行消费者
./receive.js
消费者将打印出它通过 RabbitMQ 从发布者那里收到的消息。消费者将继续运行,等待消息(按 Ctrl-C 停止它),所以尝试从另一个终端运行发布者。
列出队列
您可能希望查看 RabbitMQ 有哪些队列以及其中有多少消息。您可以使用
rabbitmqctl工具(作为特权用户)来完成此操作。sudo rabbitmqctl list_queues在 Windows 上,省略 sudo。
rabbitmqctl.bat list_queues
是时候进入第 2 部分并构建一个简单的工作队列(work queue)了。