跳到主要内容

RabbitMQ 教程 - “Hello World!”

简介​

信息

前提条件​

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

在哪里获得帮助​

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

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

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

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

  • 生产仅仅意味着发送。发送消息的程序称为生产者

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

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

    这是我们表示队列的方式

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

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

“Hello World”​

（使用 php-amqplib 客户端）​

在本教程的这一部分，我们将用 PHP 编写两个程序，它们使用 RabbitMQ 进行通信。本教程使用的客户端库需要 PHP 7.x 或 8.x。

第一个程序将是一个生产者，它发送一条消息，第二个程序将是一个消费者，它接收消息并将其打印出来。我们将忽略 php-amqplib API 中的一些细节，专注于这个非常简单的事情，以便开始入门。这是消息传递的“Hello World”。

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

php-amqplib 客户端库​

RabbitMQ 支持多种协议。本教程涵盖 AMQP 0-9-1，这是一种开放的、通用的消息传递协议。RabbitMQ 有许多不同语言的客户端。在本教程中，我们将使用 php-amqplib，并使用 Composer 进行依赖管理。

在您的项目中添加 composer.json 文件

{
    "require": {
        "php-amqplib/php-amqplib": "^3.2"
    }
}

假设您已安装并运行 Composer，您可以运行以下命令

php composer.phar install

还有一个适用于 Windows 的 Composer 安装程序。

现在我们已经安装了 php-amqplib 库，我们可以编写一些代码了。

发送​

我们将把消息发布者（发送者）命名为 send.php，消息接收者命名为 receive.php。发布者将连接到 RabbitMQ，发送一条消息，然后退出。

在 send.php 中，我们需要包含库并 use 必要的类

require_once __DIR__ . '/vendor/autoload.php';
use PhpAmqpLib\Connection\AMQPStreamConnection;
use PhpAmqpLib\Message\AMQPMessage;

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

$connection = new AMQPStreamConnection('localhost', 5672, 'guest', 'guest');
$channel = $connection->channel();

连接抽象了套接字连接，并为我们处理协议版本协商和身份验证等。这里我们连接到本地计算机上的 RabbitMQ 节点——因此是localhost。如果我们想连接到另一台机器上的节点或托管 PHP 客户端推荐的代理的主机，我们只需在此处指定其主机名或 IP 地址。

接下来我们创建一个通道，这是完成大多数 API 操作的地方。

要发送消息，我们必须声明一个要发送到的队列；然后我们可以将消息发布到队列

$channel->queue_declare('hello', false, false, false, false);

$msg = new AMQPMessage('Hello World!');
$channel->basic_publish($msg, '', 'hello');

echo " [x] Sent 'Hello World!'\n";

声明队列是幂等的——它只会在队列尚不存在时才被创建。消息内容是一个字节数组，因此您可以在其中编码任何您喜欢的内容。

最后，我们关闭通道和连接。

$channel->close();
$connection->close();

这是完整的 send.php 类.

发送不起作用！​

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

接收​

我们的发布者就到此为止。我们的接收器监听来自 RabbitMQ 的消息，因此与发布单个消息的发布者不同，我们将保持接收器运行以监听消息并将其打印出来。

代码（在 receive.php 中）与 send 具有几乎相同的 include 和 use

require_once __DIR__ . '/vendor/autoload.php';
use PhpAmqpLib\Connection\AMQPStreamConnection;

设置与发布者相同；我们打开一个连接和一个通道，并声明我们要从中消费消息的队列。请注意，这与 send 发布到的队列相匹配。

$connection = new AMQPStreamConnection('localhost', 5672, 'guest', 'guest');
$channel = $connection->channel();

$channel->queue_declare('hello', false, false, false, false);

echo " [*] Waiting for messages. To exit press CTRL+C\n";

请注意，我们在这里也声明了队列。因为我们可能会在发布者之前启动消费者，所以我们希望确保队列在我们尝试从中消费消息之前存在。

我们即将告诉服务器从队列中向我们传递消息。我们将定义一个 PHP 可调用对象，它将接收服务器发送的消息。请记住，消息是从服务器异步发送到客户端的。

$callback = function ($msg) {
  echo ' [x] Received ', $msg->body, "\n";
};

$channel->basic_consume('hello', '', false, true, false, false, $callback);

try {
    $channel->consume();
} catch (\Throwable $exception) {
    echo $exception->getMessage();
}

我们的代码将在 $channel 具有回调时阻塞。每当我们收到消息时，我们的 $callback 函数将被传递收到的消息。

这是完整的 receive.php 类

将它们放在一起​

现在我们可以运行这两个脚本了。在一个终端中，运行消费者（接收器）

php receive.php

然后，运行发布者（发送者）

php send.php

消费者将打印它通过 RabbitMQ 从发送者收到的消息。接收器将保持运行，等待消息（使用 Ctrl-C 停止它），因此尝试从另一个终端运行发送器。

列出队列​

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

sudo rabbitmqctl list_queues

在 Windows 上，省略 sudo

rabbitmqctl.bat list_queues

PHP 连接代理​

虽然本教程力求保持简单并侧重于解释 RabbitMQ 概念，但重要的是要指出一些 PHP 应用程序特有的东西。在许多情况下，PHP 应用程序将无法使用 RabbitMQ 假设的长连接，从而导致称为高连接抖动的情况。

为了避免这种情况，建议 PHP 用户在生产环境中尽可能使用特殊的代理。该代理避免了连接抖动或至少显着减少了连接抖动。

现在是时候继续学习第 2 部分并构建一个简单的工作队列了。

© . All rights reserved.