RabbitMQ 教程 - 发布/订阅
发布/订阅
(使用 php-amqplib)
前提条件
本教程假设 RabbitMQ 已安装并在 localhost
上运行,使用标准端口 (5672)。如果您使用不同的主机、端口或凭据,则需要调整连接设置。
在哪里获得帮助
如果您在学习本教程时遇到问题,可以通过 GitHub Discussions 或 RabbitMQ 社区 Discord 联系我们。
在上一篇教程中,我们创建了一个工作队列。工作队列背后的假设是每个任务都只传递给一个工作者。在这一部分,我们将做一些完全不同的事情——我们将向多个消费者传递消息。这种模式被称为“发布/订阅”。
为了说明这种模式,我们将构建一个简单的日志系统。它将由两个程序组成——第一个程序将发出日志消息,第二个程序将接收并打印它们。
在我们的日志系统中,接收程序的每个运行副本都将收到消息。这样,我们将能够运行一个接收器并将日志定向到磁盘;同时,我们将能够运行另一个接收器并在屏幕上查看日志。
本质上,发布的日志消息将被广播到所有接收器。
交换机
在教程的前面部分,我们向队列发送消息并从队列接收消息。现在是时候介绍 Rabbit 中完整的消息模型了。
让我们快速回顾一下我们在之前的教程中涵盖的内容
- 生产者是发送消息的用户应用程序。
- 队列是存储消息的缓冲区。
- 消费者是接收消息的用户应用程序。
RabbitMQ 消息模型的核心思想是生产者永远不会直接向队列发送任何消息。实际上,通常生产者甚至不知道消息是否会被传递到任何队列。
相反,生产者只能将消息发送到交换机。交换机是一个非常简单的东西。一方面,它从生产者接收消息,另一方面,它将消息推送到队列。交换机必须确切地知道如何处理它接收到的消息。应该将其附加到特定队列吗?应该将其附加到多个队列吗?还是应该将其丢弃。这些规则由交换机类型定义。
有几种可用的交换机类型:direct
、topic
、headers
和 fanout
。我们将重点关注最后一个——fanout。让我们创建一个这种类型的交换机,并将其命名为 logs
$channel->exchange_declare('logs', 'fanout', false, false, false);
fanout 交换机非常简单。正如您可能从名称中猜到的那样,它只是将接收到的所有消息广播到它知道的所有队列。这正是我们的日志记录器所需要的。
列出交换机
要列出服务器上的交换机,您可以运行非常有用的
rabbitmqctl
sudo rabbitmqctl list_exchanges
在此列表中,将有一些
amq.*
交换机和默认(未命名)交换机。这些是默认创建的,但您目前不太可能需要使用它们。
默认交换机
在教程的前面部分,我们对交换机一无所知,但仍然能够向队列发送消息。这是可能的,因为我们使用了默认交换机,我们用空字符串 (
""
) 标识它。回想一下我们之前是如何发布消息的
$channel->basic_publish($msg, '', 'hello');
这里我们使用默认或匿名交换机:消息被路由到由
routing_key
指定名称的队列(如果存在)。路由键是basic_publish
的第三个参数
现在,我们可以发布到我们命名的交换机了
$channel->exchange_declare('logs', 'fanout', false, false, false);
$channel->basic_publish($msg, 'logs');
临时队列
您可能还记得,之前我们使用的队列都有特定的名称(还记得 hello
和 task_queue
吗?)。能够命名队列对我们至关重要——我们需要将工作者指向同一个队列。当您想在生产者和消费者之间共享队列时,为队列命名非常重要。
但这不适用于我们的日志记录器。我们想听到所有日志消息,而不仅仅是其中的一部分。我们也只对当前流动的消息感兴趣,而不是旧消息。为了解决这个问题,我们需要做两件事。
首先,每当我们连接到 Rabbit 时,我们需要一个全新的空队列。为此,我们可以创建一个具有随机名称的队列,或者,更好的是 - 让服务器为我们选择一个随机队列名称。
其次,一旦我们断开消费者的连接,队列应自动删除。
在 php-amqplib 客户端中,当我们提供空字符串作为队列名称时,我们创建一个具有生成名称的非持久队列
list($queue_name, ,) = $channel->queue_declare("");
当方法返回时,$queue_name
变量包含 RabbitMQ 生成的随机队列名称。例如,它可能看起来像 amq.gen-JzTY20BRgKO-HjmUJj0wLg
。
当声明它的连接关闭时,队列将被删除,因为它被声明为独占的。您可以在队列指南中了解有关 exclusive
标志和其他队列属性的更多信息。
绑定
我们已经创建了一个 fanout 交换机和一个队列。现在我们需要告诉交换机将消息发送到我们的队列。交换机和队列之间的这种关系称为绑定。
$channel->queue_bind($queue_name, 'logs');
从现在开始,logs
交换机将消息附加到我们的队列。
列出绑定
您可以使用以下命令列出现有绑定,您猜对了,
rabbitmqctl list_bindings
整合在一起
发出日志消息的生产者程序与之前的教程看起来没有太大区别。最重要的变化是我们现在想将消息发布到我们的 logs
交换机,而不是匿名交换机。以下是 emit_log.php
脚本的代码
<?php
require_once __DIR__ . '/vendor/autoload.php';
use PhpAmqpLib\Connection\AMQPStreamConnection;
use PhpAmqpLib\Message\AMQPMessage;
$connection = new AMQPStreamConnection('localhost', 5672, 'guest', 'guest');
$channel = $connection->channel();
$channel->exchange_declare('logs', 'fanout', false, false, false);
$data = implode(' ', array_slice($argv, 1));
if (empty($data)) {
$data = "info: Hello World!";
}
$msg = new AMQPMessage($data);
$channel->basic_publish($msg, 'logs');
echo ' [x] Sent ', $data, "\n";
$channel->close();
$connection->close();
如您所见,建立连接后,我们声明了交换机。此步骤是必要的,因为禁止发布到不存在的交换机。
如果尚无队列绑定到交换机,消息将会丢失,但这对于我们来说没问题;如果尚无消费者正在监听,我们可以安全地丢弃消息。
receive_logs.php
的代码
<?php
require_once __DIR__ . '/vendor/autoload.php';
use PhpAmqpLib\Connection\AMQPStreamConnection;
$connection = new AMQPStreamConnection('localhost', 5672, 'guest', 'guest');
$channel = $connection->channel();
$channel->exchange_declare('logs', 'fanout', false, false, false);
list($queue_name, ,) = $channel->queue_declare("", false, false, true, false);
$channel->queue_bind($queue_name, 'logs');
echo " [*] Waiting for logs. To exit press CTRL+C\n";
$callback = function ($msg) {
echo ' [x] ', $msg->getBody(), "\n";
};
$channel->basic_consume($queue_name, '', false, true, false, false, $callback);
try {
$channel->consume();
} catch (\Throwable $exception) {
echo $exception->getMessage();
}
$channel->close();
$connection->close();
如果您想将日志保存到文件,只需打开控制台并键入
php receive_logs.php > logs_from_rabbit.log
如果您希望在屏幕上查看日志,请启动一个新的终端并运行
php receive_logs.php
当然,要发出日志,请键入
php emit_log.php
使用 rabbitmqctl list_bindings
您可以验证代码是否实际创建了我们想要的绑定和队列。运行两个 receive_logs.php
程序,您应该看到类似以下内容
sudo rabbitmqctl list_bindings
# => Listing bindings ...
# => logs exchange amq.gen-JzTY20BRgKO-HjmUJj0wLg queue []
# => logs exchange amq.gen-vso0PVvyiRIL2WoV3i48Yg queue []
# => ...done.
结果的解释很简单:来自交换机 logs
的数据流向两个具有服务器分配名称的队列。这正是我们想要的。
要了解如何监听消息的子集,请继续学习教程 4