跳至主内容

RabbitMQ 教程 - “Hello world!”

简介

信息

先决条件

本教程假设 RabbitMQ 已 安装 并在 localhost 上的 标准端口 (5672) 上运行。如果您使用不同的主机、端口或凭据,则需要调整连接设置。

哪里寻求帮助

如果您在学习本教程时遇到困难,可以通过 GitHub DiscussionsRabbitMQ 社区 Discord 联系我们。

RabbitMQ 是一个消息代理:它接收并转发消息。你可以把它想象成一个邮局:当你把想要寄出的邮件放进邮箱时,你可以确信邮递员最终会将邮件送到你的收件人手中。在这个比喻中,RabbitMQ 就是邮箱、邮局和邮递员。

RabbitMQ 和邮局的主要区别在于,它不处理纸张,而是接收、存储和转发数据的二进制数据块——消息

RabbitMQ 和消息传递通常会使用一些行话。

  • 生产者 (Producing) 仅仅意味着发送。发送消息的程序就是 生产者

  • 队列 是 RabbitMQ 中邮箱的名称。虽然消息在 RabbitMQ 和你的应用程序之间流动,但它们只能存储在队列 中。队列 的大小仅受主机内存和磁盘空间的限制,它本质上是一个大的消息缓冲区。

    许多生产者 可以发送消息到同一个队列,许多消费者 可以尝试从同一个队列 接收数据。

    这就是我们表示队列的方式

  • 消费 的含义与接收类似。消费者 是一个主要等待接收消息的程序。

请注意,生产者、消费者和代理不一定需要驻留在同一台主机上;事实上,在大多数应用程序中它们都不会。一个应用程序也可以同时是生产者和消费者。

Hello World!

(使用 amqp Elixir 库)

在本教程的这一部分,我们将用 Elixir 编写两个小程序:一个负责发送单条消息的生产者(发送方),以及一个接收并打印消息的消费者(接收方)。这就是消息传递领域的“Hello World”。

在下面的图表中,“P”是我们的生产者,“C”是我们的消费者。中间的框是一个队列——RabbitMQ 代表消费者存储的消息缓冲区。

我们的整体设计如下所示

RabbitMQ 库

RabbitMQ 支持多种协议。本教程使用 AMQP 0-9-1,这是一种通用的开放消息传递协议。RabbitMQ 在 许多不同的编程语言 中都有客户端库。在本系列教程中,我们将使用 amqp

你可以使用 hex 包管理工具进行安装。让我们创建一个新项目。

mix new rabbitmq_tutorials
cd rabbitmq_tutorials

现在让我们添加对 amqp 库的依赖。请修改 mix.exs 文件中的 applicationsdeps 部分,使其与下文一致

def application do
[applications: [:amqp]]
end
defp deps() do
[
{:amqp, "~> 3.3"},
]
end

mix.exs 中的 application 部分将确保 amqp 依赖项在项目运行时被加载并启动。deps 部分声明了项目所需的外部库。现在我们将使用 mix 来获取并编译 amqp 库。

mix deps.get
mix deps.compile

当通过 mix run 执行项目时,amqp 库将被加载并可供使用。

发送

我们的第一个程序 send.exs 将向队列发送一条消息。我们需要做的第一件事是与 RabbitMQ 服务器建立连接。

{:ok, connection} = AMQP.Connection.open
{:ok, channel} = AMQP.Channel.open(connection)

现在我们已经连接到了本地机器上的代理服务器。默认情况下,AMQP.Connection.open 会连接到 localhost。如果我们想连接到其他机器上的代理,只需在 host: 选项中指定其主机名或 IP 地址即可。

接下来,在发送之前,我们需要确保接收队列存在。如果我们向一个不存在的位置发送消息,RabbitMQ 会直接丢弃该消息。让我们创建一个名为 hello 的队列,消息将投递到该队列中。

AMQP.Queue.declare(channel, "hello", durable: true, arguments: [{"x-queue-type", :longstr, "quorum"}])

至此,我们已经准备好发送消息了。我们的第一条消息仅包含字符串 Hello World!,我们希望将其发送到 hello 队列。

在 RabbitMQ 中,消息永远不能直接发送到队列,它必须经过 交换机 (exchange)。但我们先不去深究细节 —— 你可以在 本教程的第三部分 中阅读关于 交换机 的更多信息。现在我们只需要知道如何使用由空字符串标识的默认交换机。这个交换机比较特殊 —— 它允许我们明确指定消息应该进入哪个队列。队列名称需要在 routing_key 参数中指定。

AMQP.Basic.publish(channel, "", "hello", "Hello World!")
IO.puts " [x] Sent 'Hello World!'"

在退出程序之前,我们需要确保网络缓冲区已刷新,并且消息确实已送达 RabbitMQ。我们可以通过优雅地关闭连接来做到这一点。

AMQP.Connection.close(connection)

这是完整的 send.exs 脚本.

发送不起作用!

如果这是您第一次使用 RabbitMQ,但没有看到“Sent”消息,您可能会感到困惑,不知道哪里出了问题。也许代理启动时磁盘空间不足(默认需要至少 50 MB 可用空间),因此拒绝接收消息。检查代理的日志文件,看看是否有资源警报已记录,并在必要时降低可用磁盘空间阈值。配置指南将展示如何设置 disk_free_limit

接收

这就是我们的生产者。我们的消费者会监听来自 RabbitMQ 的消息,因此与只发布一条消息的生产者不同,我们将让消费者保持运行,以监听并打印出消息。

我们的第二个程序 receive.exs 将从队列中接收消息并将其打印在屏幕上。

同样,首先我们需要连接到 RabbitMQ 服务器。负责连接 Rabbit 的代码与之前相同。

下一步,和之前一样,我们需要确保队列存在。使用 AMQP.Queue.declare 创建队列是幂等的 —— 我们可以根据需要多次运行该命令,但最终只会创建一个队列。

AMQP.Queue.declare(channel, "hello", durable: true, arguments: [{"x-queue-type", :longstr, "quorum"}])

你可能会问为什么要再次声明队列 —— 我们已经在之前的代码中声明过它了。如果我们确定队列已经存在,是可以省略这一步的(例如,如果 send.exs 程序已经在之前运行过)。但我们还不确定哪个程序会先运行。在这种情况下,在两个程序中重复声明队列是一种良好的实践。

从队列接收消息会更复杂一些。它通过向 Elixir 进程发送 Elixir 消息来工作。每当客户端库从 RabbitMQ 接收到投递时,一条 {:basic_deliver, payload, metadata} 的 Elixir 消息就会被发送到指定的 Elixir 进程。然后我们就可以按需处理 payload 和 metadata。在本例中,我们将把消息内容打印到屏幕上。

defmodule Receive do
def wait_for_messages do
receive do
{:basic_deliver, payload, _meta} ->
IO.puts " [x] Received #{payload}"
wait_for_messages()
end
end
end

接下来,我们需要告诉 RabbitMQ,这个特定的进程应该从我们的 hello 队列接收消息。

AMQP.Basic.consume(channel,
"hello",
nil, # consumer process, defaults to self()
no_ack: true)

为了使该命令成功,我们必须确保我们想要订阅的队列存在。幸运的是,我们很确定这一点 —— 我们已经在上面通过 AMQP.Queue.declare 创建了该队列。

列出队列

您可能希望查看 RabbitMQ 有哪些队列以及其中有多少消息。您可以使用 rabbitmqctl 工具(作为特权用户)来完成此操作。

sudo rabbitmqctl list_queues

在 Windows 上,省略 sudo。

rabbitmqctl.bat list_queues

no_ack 参数将在 后续章节 中描述。

最后,我们进入一个永不结束的递归,等待数据并在必要时显示消息。

IO.puts " [*] Waiting for messages. To exit press CTRL+C, CTRL+C"
Receive.wait_for_messages()

总而言之

send.exs 的完整代码

{:ok, connection} = AMQP.Connection.open
{:ok, channel} = AMQP.Channel.open(connection)
AMQP.Queue.declare(channel, "hello", durable: true, arguments: [{"x-queue-type", :longstr, "quorum"}])
AMQP.Basic.publish(channel, "", "hello", "Hello World!")
IO.puts " [x] Sent 'Hello World!'"
AMQP.Connection.close(connection)

(send.exs 源码)

receive.exs 的完整代码

defmodule Receive do
def wait_for_messages do
receive do
{:basic_deliver, payload, _meta} ->
IO.puts " [x] Received #{payload}"
wait_for_messages()
end
end
end

{:ok, connection} = AMQP.Connection.open
{:ok, channel} = AMQP.Channel.open(connection)
AMQP.Queue.declare(channel, "hello", durable: true, arguments: [{"x-queue-type", :longstr, "quorum"}])
AMQP.Basic.consume(channel, "hello", nil, no_ack: true)
IO.puts " [*] Waiting for messages. To exit press CTRL+C, CTRL+C"

Receive.wait_for_messages()

(receive.exs 源码)

现在我们可以在终端中尝试运行这些程序。首先,让我们启动消费者,它将持续运行并等待消息投递。

mix run receive.exs
# => [*] Waiting for messages. To exit press CTRL+C, CTRL+C
# ...
# => [x] Received Hello World!

现在启动生产者。生产者程序在每次运行后都会停止。

mix run send.exs
# => [x] Sent 'Hello World!'

万岁!我们成功通过 RabbitMQ 发送了第一条消息。你可能已经注意到,receive.exs 程序并没有退出。它将保持准备状态以接收后续消息,可以通过 Ctrl-C, Ctrl-C 中断。

尝试在新的终端中再次运行 send.exs

我们已经学会了如何从指定队列发送和接收消息。现在是时候进入 第 2 部分 并构建一个简单的 工作队列 (work queue) 了。

© . This site is unofficial and not affiliated with VMware.