RabbitMQ 教程 - 工作队列

工作队列

（使用 php-amqplib）

信息

先决条件

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

在哪里获得帮助

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

在第一个教程中，我们编写了程序来发送和接收来自命名队列的消息。在本教程中，我们将创建一个工作队列，它将用于在多个工作者之间分配耗时的任务。

工作队列（又名：任务队列）背后的主要思想是避免立即执行资源密集型任务并等待其完成。相反，我们安排任务稍后完成。我们将任务封装为消息并将其发送到队列。在后台运行的工作进程将弹出任务并最终执行作业。当您运行多个工作者时，任务将在它们之间共享。

这个概念在 Web 应用程序中尤其有用，在 Web 应用程序中，在短暂的 HTTP 请求窗口期间处理复杂任务是不可能的。

准备工作

在本教程的前一部分中，我们发送了一条包含“Hello World!”的消息。现在我们将发送代表复杂任务的字符串。我们没有像调整大小的图像或要渲染的 pdf 文件这样的真实世界任务，所以让我们通过假装我们很忙来伪造它 - 通过使用 sleep() 函数。我们将字符串中点的数量作为其复杂性；每个点将代表一秒钟的“工作”。例如，由 Hello... 描述的虚假任务将花费三秒钟。

我们将稍微修改之前示例中的 send.php 代码，以允许从命令行发送任意消息。此程序将任务调度到我们的工作队列，因此我们将其命名为 new_task.php

$data = implode(' ', array_slice($argv, 1));
if (empty($data)) {
    $data = "Hello World!";
}
$msg = new AMQPMessage($data);

$channel->basic_publish($msg, '', 'hello');

echo ' [x] Sent ', $data, "\n";

我们旧的 receive.php 脚本也需要一些更改：它需要为消息正文中的每个点伪造一秒钟的工作。它将从队列中弹出消息并执行任务，因此我们将其称为 worker.php

$callback = function ($msg) {
  echo ' [x] Received ', $msg->getBody(), "\n";
  sleep(substr_count($msg->getBody(), '.'));
  echo " [x] Done\n";
};

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

请注意，我们的虚假任务模拟了执行时间。

像在第一个教程中那样运行它们

# shell 1
php worker.php

# shell 2
php new_task.php "A very hard task which takes two seconds.."

轮询分发

使用任务队列的优势之一是能够轻松地并行化工作。如果我们正在建立工作积压，我们可以简单地添加更多工作者，从而轻松扩展。

首先，让我们尝试同时运行两个 worker.php 脚本。它们都将从队列中获取消息，但具体是如何获取的？ 让我们看看。

您需要打开三个控制台。两个将运行 worker.php 脚本。这些控制台将是我们的两个消费者 - C1 和 C2。

# shell 1
php worker.php
# => [*] Waiting for messages. To exit press CTRL+C

# shell 2
php worker.php
# => [*] Waiting for messages. To exit press CTRL+C

在第三个控制台中，我们将发布新任务。启动消费者后，您可以发布一些消息

# shell 3
php new_task.php First message.
php new_task.php Second message..
php new_task.php Third message...
php new_task.php Fourth message....
php new_task.php Fifth message.....

让我们看看交付给我们的工作者是什么

# shell 1
php worker.php
# => [*] Waiting for messages. To exit press CTRL+C
# => [x] Received 'First message.'
# => [x] Received 'Third message...'
# => [x] Received 'Fifth message.....'

# shell 2
php worker.php
# => [*] Waiting for messages. To exit press CTRL+C
# => [x] Received 'Second message..'
# => [x] Received 'Fourth message....'

默认情况下，RabbitMQ 将按顺序将每条消息发送给下一个消费者。平均而言，每个消费者将获得相同数量的消息。这种分发消息的方式称为轮询。用三个或更多工作者尝试一下。

消息确认

执行任务可能需要几秒钟，您可能想知道如果消费者开始一项长时间的任务并在完成之前终止会发生什么。使用我们当前的代码，一旦 RabbitMQ 将消息传递给消费者，它会立即将其标记为删除。在这种情况下，如果您终止工作者，则刚刚处理的消息将丢失。已分派给此特定工作者但尚未处理的消息也会丢失。

但我们不想丢失任何任务。如果工作者死掉，我们希望任务被传递给另一个工作者。

为了确保消息永远不会丢失，RabbitMQ 支持消息确认。确认 (acknowledgement) 是由消费者发回的，以告知 RabbitMQ 某个特定消息已被接收、处理，并且 RabbitMQ 可以自由删除它。

如果消费者死亡（其通道关闭、连接关闭或 TCP 连接丢失）而未发送确认，RabbitMQ 将理解消息未被完全处理并将重新排队。如果同时有其他消费者在线，它将快速地将其重新传递给另一个消费者。这样，您可以确保即使工作者偶尔死掉，也不会丢失任何消息。

消费者传递确认强制执行超时（默认为 30 分钟）。这有助于检测从不确认交付的有缺陷（卡住）的消费者。您可以按照交付确认超时中所述增加此超时。

消息确认之前被我们自己关闭了。现在是时候通过将 basic_consume 的第四个参数设置为 false（true 表示无确认）来打开它们，并在我们完成任务后从工作者发送适当的确认。

$callback = function ($msg) {
  echo ' [x] Received ', $msg->getBody(), "\n";
  sleep(substr_count($msg->getBody(), '.'));
  echo " [x] Done\n";
  $msg->ack();
};

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

使用此代码，您可以确保即使您在使用 CTRL+C 终止正在处理消息的工作者时，也不会丢失任何内容。工作者终止后不久，所有未确认的消息都会被重新传递。

确认必须在接收交付的同一通道上发送。尝试使用不同的通道进行确认将导致通道级协议异常。请参阅关于确认的文档指南以了解更多信息。

忘记确认

错过 ack 是一个常见的错误。这是一个容易犯的错误，但后果很严重。当您的客户端退出时（这可能看起来像是随机的重新传递），消息将被重新传递，但是 RabbitMQ 将占用越来越多的内存，因为它将无法释放任何未确认的消息。

为了调试这种错误，您可以使用 rabbitmqctl 打印 messages_unacknowledged 字段

sudo rabbitmqctl list_queues name messages_ready messages_unacknowledged

在 Windows 上，删除 sudo

rabbitmqctl.bat list_queues name messages_ready messages_unacknowledged

消息持久性

我们已经学习了如何确保即使消费者死掉，任务也不会丢失。但是，如果 RabbitMQ 服务器停止，我们的任务仍然会丢失。

当 RabbitMQ 退出或崩溃时，它会忘记队列和消息，除非您告诉它不要这样做。需要做两件事来确保消息不会丢失：我们需要将队列和消息都标记为持久。

首先，我们需要确保队列在 RabbitMQ 节点重启后仍然存在。为了做到这一点，我们需要将其声明为持久。为此，我们将 queue_declare 的第三个参数传递为 true

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

尽管此命令本身是正确的，但在我们当前的设置中它不起作用。那是因为我们已经定义了一个名为 hello 的队列，它不是持久的。RabbitMQ 不允许您使用不同的参数重新定义现有队列，并且会向任何尝试这样做的程序返回错误。但是有一个快速的解决方法 - 让我们声明一个具有不同名称的队列，例如 task_queue

$channel->queue_declare('task_queue', false, true, false, false);

设置为 true 的此标志需要应用于生产者和消费者代码。

此时，我们确信即使 RabbitMQ 重新启动，task_queue 队列也不会丢失。现在我们需要将我们的消息标记为持久性

• 通过设置 delivery_mode = 2 消息属性，AMQPMessage 将其作为属性数组的一部分。

$msg = new AMQPMessage(
    $data,
    array('delivery_mode' => AMQPMessage::DELIVERY_MODE_PERSISTENT)
);

关于消息持久性的说明

将消息标记为持久性并不能完全保证消息不会丢失。尽管它告诉 RabbitMQ 将消息保存到磁盘，但在 RabbitMQ 接受消息但尚未保存消息时，仍然存在一个短暂的时间窗口。此外，RabbitMQ 不会为每条消息执行 fsync(2) - 它可能只是保存到缓存而不是真正写入磁盘。持久性保证不强，但对于我们简单的任务队列来说已经足够了。如果您需要更强的保证，那么您可以使用发布者确认。

公平分发

您可能已经注意到，分发仍然没有完全按照我们的意愿工作。例如，在有两个工作者的情况下，当所有奇数消息都很重而偶数消息都很轻时，一个工作者将一直很忙，而另一个工作者几乎不做任何工作。好吧，RabbitMQ 对此一无所知，仍然会均匀地分发消息。

发生这种情况是因为 RabbitMQ 只是在消息进入队列时分发消息。它不查看消费者的未确认消息的数量。它只是盲目地将每第 n 条消息分发给第 n 个消费者。

为了克服这个问题，我们可以使用 basic_qos 方法，并将 prefetch_count 设置为 1。这告诉 RabbitMQ 一次不要给一个工作者超过一条消息。或者，换句话说，在工作者处理并确认上一条消息之前，不要向其分发新消息。相反，它将把它分发给下一个不忙的工作者。

$channel->basic_qos(null, 1, false);

关于队列大小的说明

如果所有工作者都很忙，您的队列可能会被填满。您需要注意这一点，并且可能添加更多工作者，或者采取其他策略。

整合在一起

我们的 new_task.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->queue_declare('task_queue', false, true, false, false);

$data = implode(' ', array_slice($argv, 1));
if (empty($data)) {
    $data = "Hello World!";
}
$msg = new AMQPMessage(
    $data,
    array('delivery_mode' => AMQPMessage::DELIVERY_MODE_PERSISTENT)
);

$channel->basic_publish($msg, '', 'task_queue');

echo ' [x] Sent ', $data, "\n";

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

（new_task.php 源代码）

以及我们的 worker.php

<?php

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

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

$channel->queue_declare('task_queue', false, true, false, false);

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

$callback = function ($msg) {
    echo ' [x] Received ', $msg->getBody(), "\n";
    sleep(substr_count($msg->getBody(), '.'));
    echo " [x] Done\n";
    $msg->ack();
};

$channel->basic_qos(null, 1, false);
$channel->basic_consume('task_queue', '', false, false, false, false, $callback);

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

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

（worker.php 源代码）

使用消息确认和 prefetch，您可以设置一个工作队列。持久性选项使任务即使在 RabbitMQ 重新启动后也能幸存。

现在我们可以继续学习教程 3，学习如何将同一消息传递给多个消费者。