RabbitMQ 教程 - "Hello World!"
简介
先决条件
本教程假设 RabbitMQ 已 安装 并在 localhost 上的 标准端口 (5672) 上运行。如果您使用不同的主机、端口或凭据,则需要调整连接设置。
哪里寻求帮助
如果您在学习本教程时遇到困难,可以通过 GitHub Discussions 或 RabbitMQ 社区 Discord 联系我们。
RabbitMQ 是一个消息代理:它接收并转发消息。你可以把它想象成一个邮局:当你把想要寄出的邮件放进邮箱时,你可以确信邮递员最终会将邮件送到你的收件人手中。在这个比喻中,RabbitMQ 就是邮箱、邮局和邮递员。
RabbitMQ 和邮局的主要区别在于,它不处理纸张,而是接收、存储和转发数据的二进制数据块——消息。
RabbitMQ 和消息传递通常会使用一些行话。
-
生产(Producing)的意思仅仅是发送。发送消息的程序就是生产者(producer)。
-
队列 是 RabbitMQ 中邮箱的名称。虽然消息在 RabbitMQ 和你的应用程序之间流动,但它们只能存储在队列 中。队列 的大小仅受主机内存和磁盘空间的限制,它本质上是一个大的消息缓冲区。
许多生产者 可以发送消息到同一个队列,许多消费者 可以尝试从同一个队列 接收数据。
这就是我们表示队列的方式
-
消费 的含义与接收类似。消费者 是一个主要等待接收消息的程序。
请注意,生产者、消费者和代理不一定需要驻留在同一台主机上;事实上,在大多数应用程序中它们都不会。一个应用程序也可以同时是生产者和消费者。
"Hello World"
(使用 php-amqplib 客户端)
在本教程的这一部分,我们将编写两个使用 RabbitMQ 进行通信的 PHP 程序。本教程使用的客户端库需要 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;
use PhpAmqpLib\Wire\AMQPTable;
然后,我们可以创建一个到服务器的连接
$connection = new AMQPStreamConnection('localhost', 5672, 'guest', 'guest');
$channel = $connection->channel();
连接抽象了 socket 连接,并为我们处理了协议版本协商、身份验证等工作。在这里,我们连接到本地机器上的 RabbitMQ 节点,因此使用 localhost。如果我们想连接到不同机器上的节点,或者连接到托管了 PHP 客户端推荐代理的主机,只需在此处指定其主机名或 IP 地址即可。
接下来我们创建一个通道(channel),这是实现大部分 API 功能的地方。
为了发送,我们必须声明一个要发送到的队列;然后我们可以将消息发布到该队列。
$channel->queue_declare('hello', false, true, false, false, false, new AMQPTable(['x-queue-type' => 'quorum']));
$msg = new AMQPMessage('Hello World!');
$channel->basic_publish($msg, '', 'hello');
echo " [x] Sent 'Hello World!'\n";
声明队列是幂等的——只有在队列不存在时才会创建。消息内容是字节数组,因此您可以对其进行任意编码。
最后,我们关闭通道和连接。
$channel->close();
$connection->close();
发送不起作用!
如果这是您第一次使用 RabbitMQ,但没有看到“Sent”消息,您可能会感到困惑,不知道哪里出了问题。也许代理启动时磁盘空间不足(默认需要至少 50 MB 可用空间),因此拒绝接收消息。检查代理的日志文件,看看是否有资源警报已记录,并在必要时降低可用磁盘空间阈值。配置指南将展示如何设置
disk_free_limit。
接收
发布者的工作到此结束。我们的接收者会监听来自 RabbitMQ 的消息,因此与只发布单条消息的发布者不同,我们会让接收者保持运行状态,以监听并打印消息。
这段代码(在 receive.php 中)的 include 和 use 部分与 send.php 几乎完全相同。
require_once __DIR__ . '/vendor/autoload.php';
use PhpAmqpLib\Connection\AMQPStreamConnection;
use PhpAmqpLib\Message\AMQPMessage;
use PhpAmqpLib\Wire\AMQPTable;
设置与发布者相同;我们打开一个连接和一个通道,并声明我们将要消费的队列。注意这与 send 发布到的队列相匹配。
$connection = new AMQPStreamConnection('localhost', 5672, 'guest', 'guest');
$channel = $connection->channel();
$channel->queue_declare('hello', false, true, false, false, false, new AMQPTable(['x-queue-type' => 'quorum']));
echo " [*] Waiting for messages. To exit press CTRL+C\n";
请注意,我们在这里也声明了队列。因为我们可能在发布者之前启动消费者,所以我们希望确保在尝试从队列中消费消息之前,队列已经存在。
我们即将告知服务器从队列中分发消息给我们。我们将定义一个 PHP 可调用对象 (callable) 来接收服务器发送的消息。请记住,消息是从服务器异步发送给客户端的。
$callback = function (AMQPMessage $msg) {
echo ' [x] Received ', $msg->getBody(), "\n";
};
$channel->basic_consume('hello', '', false, true, false, false, $callback);
try {
$channel->consume();
} catch (\Throwable $exception) {
echo $exception->getMessage();
}
当我们的 $channel 有回调函数时,代码将会阻塞。每当我们收到消息时,接收到的消息都会被传递给我们的 $callback 函数。
总而言之
现在我们可以运行这两个脚本了。在一个终端中,运行消费者(接收者)
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 所预设的长连接,从而产生一种被称为高连接抖动 (high connection churn) 的状况。
为了避免这种情况,建议 PHP 用户在生产环境中尽可能使用专用代理。该代理可以避免连接抖动,或者至少能显著减少抖动。
现在是时候进入第二部分,构建一个简单的工作队列了。