跳到主要内容

RabbitMQ 教程 - “Hello world!”

简介​

信息

先决条件​

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

在哪里获得帮助​

如果您在学习本教程时遇到问题，可以通过 GitHub Discussions 或 RabbitMQ 社区 Discord 联系我们。

RabbitMQ 是一个消息代理：它接收并转发消息。您可以将其视为邮局：当您将要邮寄的邮件放入邮箱时，您可以确信邮递员最终会将邮件递送给您的收件人。在这个类比中，RabbitMQ 是邮箱、邮局和邮递员。

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

RabbitMQ 和消息传递通常使用一些术语。

  • Producing 仅仅意味着发送。发送消息的程序是 producer （生产者）

  • Queue （队列）是 RabbitMQ 中邮箱的名称。虽然消息流经 RabbitMQ 和您的应用程序，但它们只能存储在 queue （队列）中。Queue （队列）仅受主机内存和磁盘限制的约束，它本质上是一个大型消息缓冲区。

    许多 producer （生产者）可以发送消息到一个队列，而许多 consumer （消费者）可以尝试从一个 queue （队列）接收数据。

    这是我们表示队列的方式

  • Consuming （消费）与接收具有相似的含义。Consumer （消费者）是一个主要等待接收消息的程序

请注意，producer （生产者）、consumer （消费者）和 broker （代理）不必驻留在同一主机上；实际上，在大多数应用程序中，它们不是。一个应用程序也可以同时是 producer （生产者）和 consumer （消费者）。

Hello World!

（使用 amqp Elixir 库）​

在本教程的这一部分，我们将用 Elixir 编写两个小程序；一个 producer （生产者）（发送者），它发送一条消息，以及一个 consumer （消费者）（接收者），它接收消息并将其打印出来。这是消息传递的 “Hello World”。

在下图中，“P” 是我们的 producer （生产者），“C” 是我们的 consumer （消费者）。中间的框是一个 queue （队列） - RabbitMQ 代表 consumer （消费者）维护的消息缓冲区。

我们的总体设计将如下所示

RabbitMQ 库​

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

要安装它，您可以使用 hex 包管理工具。让我们创建一个新项目。

mix new rabbitmq_tutorials
cd rabbitmq_tutorials

现在让我们添加对 amqp 库的依赖。请修改您的 mix.exs 文件的 applications 和 deps 部分以匹配以下内容

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

amqp 库现在将被加载，并通过 mix run 执行时可供您的项目使用。

发送​

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

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

我们现在已连接到本地计算机上的代理。默认情况下，AMQP.Connection.open 连接到 localhost。如果我们想连接到不同计算机上的代理，我们只需将其名称或 IP 地址指定为 host: 选项。

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

AMQP.Queue.declare(channel, "hello")

那时，我们准备好发送消息了。我们的第一条消息将只包含字符串 Hello World!，并且我们想将其发送到我们的 hello 队列。

在 RabbitMQ 中，消息永远不能直接发送到队列，它总是需要通过 exchange （交换机）。但是，我们不要被细节所困扰 ‒ 您可以在本教程的第三部分中阅读有关 exchange （交换机）的更多信息。我们现在需要知道的是如何使用由空字符串标识的默认 exchange （交换机）。这个 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 可用空间），因此拒绝接受消息。检查代理日志文件，看看是否有资源警报记录，并在必要时降低可用磁盘空间阈值。《Configuration guide》（配置指南）将向您展示如何设置 disk_free_limit。

接收​

我们的 producer （生产者）就到此为止。我们的 consumer （消费者）监听来自 RabbitMQ 的消息，因此与发布单条消息的 producer （生产者）不同，我们将保持 consumer （消费者）运行以监听消息并将其打印出来。

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

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

下一步，就像之前一样，是确保队列存在。使用 AMQP.Queue.declare 创建队列是幂等的 ‒ 我们可以根据需要多次运行该命令，并且只会创建一个队列。

AMQP.Queue.declare(channel, "hello")

您可能会问为什么我们再次声明队列 ‒ 我们已经在之前的代码中声明了它。如果我们确定队列已经存在，我们可以避免这种情况。例如，如果之前运行了 send.exs 程序。但我们还不确定首先运行哪个程序。在这种情况下，在两个程序中重复声明队列是一个好的做法。

从队列接收消息更复杂。它通过向 Elixir 进程发送 Elixir 消息来工作。每当客户端库收到来自 RabbitMQ 的传递时，就会向指定的 Elixir 进程发送一个 {:basic_deliver, payload, metadata} 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")
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")
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 源代码）

现在我们可以在终端中试用我们的程序。首先，让我们启动一个 consumer （消费者），它将持续运行等待传递

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

现在启动 producer （生产者）。Producer （生产者）程序将在每次运行后停止

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

万岁！我们能够通过 RabbitMQ 发送我们的第一条消息。您可能已经注意到，receive.exs 程序不会退出。它将保持准备好接收更多消息，并且可以用 Ctrl-C, Ctrl-C 中断。

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

我们已经学习了如何从命名队列发送和接收消息。现在是时候继续学习第 2 部分并构建一个简单的工作队列了。

© . All rights reserved.