跳至主要内容

RabbitMQ 教程 - “Hello World!”

简介

信息

先决条件

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

获取帮助

如果您在学习本教程时遇到问题,可以通过GitHub 讨论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 并且您没有看到“已发送”消息,那么您可能会挠头想知道哪里出了问题。也许代理在启动时没有足够的可用磁盘空间(默认情况下,它至少需要 50 MB 的可用空间),因此拒绝接受消息。检查代理日志文件,查看是否记录了资源警报,如有必要,降低可用磁盘空间阈值。配置指南将向您展示如何设置 disk_free_limit

接收

这就是我们的发布者。我们的接收者监听来自 RabbitMQ 的消息,因此与发布一条消息的发布者不同,我们将使接收者保持运行以监听消息并将其打印出来。

代码(在receive.php 中)与 send 具有几乎相同的 includeuse

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 部分并构建一个简单的工作队列了。

© 2024 RabbitMQ. All rights reserved.