跳到主要内容

RabbitMQ 教程 - 工作队列

工作队列

(使用 Java 客户端)

信息

前提条件

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

在哪里获得帮助

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

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

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

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

准备工作

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

我们将稍微修改上一个示例中的 Send.java 代码,以允许从命令行发送任意消息。此程序将任务调度到我们的工作队列,因此我们将其命名为 NewTask.java

String message = String.join(" ", argv);

channel.basicPublish("", "hello", null, message.getBytes());
System.out.println(" [x] Sent '" + message + "'");

我们的旧 Recv.java 程序也需要进行一些更改:它需要为消息正文中的每个点伪造一秒钟的工作。它将处理传递的消息并执行任务,因此我们将其称为 Worker.java

DeliverCallback deliverCallback = (consumerTag, delivery) -> {
String message = new String(delivery.getBody(), "UTF-8");

System.out.println(" [x] Received '" + message + "'");
try {
doWork(message);
} finally {
System.out.println(" [x] Done");
}
};
boolean autoAck = true; // acknowledgment is covered below
channel.basicConsume(TASK_QUEUE_NAME, autoAck, deliverCallback, consumerTag -> { });

我们用来模拟执行时间的假任务

private static void doWork(String task) throws InterruptedException {
for (char ch: task.toCharArray()) {
if (ch == '.') Thread.sleep(1000);
}
}

像教程一中那样编译它们(jar 文件在工作目录中,环境变量为 CP

javac -cp $CP NewTask.java Worker.java

轮询分发

使用任务队列的优点之一是能够轻松地并行化工作。如果我们正在构建工作积压,我们可以添加更多的工作进程,从而轻松扩展。

首先,让我们尝试同时运行两个工作进程实例。它们都将从队列中获取消息,但究竟是如何获取的?让我们看看。

您需要打开三个控制台。两个将运行工作进程程序。这些控制台将是我们的两个消费者 - C1 和 C2。

# shell 1
java -cp $CP Worker
# => [*] Waiting for messages. To exit press CTRL+C
# shell 2
java -cp $CP Worker
# => [*] Waiting for messages. To exit press CTRL+C

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

# shell 3
java -cp $CP NewTask First message.
# => [x] Sent 'First message.'
java -cp $CP NewTask Second message..
# => [x] Sent 'Second message..'
java -cp $CP NewTask Third message...
# => [x] Sent 'Third message...'
java -cp $CP NewTask Fourth message....
# => [x] Sent 'Fourth message....'
java -cp $CP NewTask Fifth message.....
# => [x] Sent 'Fifth message.....'

让我们看看传递给我们的工作进程的内容

java -cp $CP Worker
# => [*] Waiting for messages. To exit press CTRL+C
# => [x] Received 'First message.'
# => [x] Received 'Third message...'
# => [x] Received 'Fifth message.....'
java -cp $CP Worker
# => [*] Waiting for messages. To exit press CTRL+C
# => [x] Received 'Second message..'
# => [x] Received 'Fourth message....'

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

消息确认

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

但是我们不想丢失任何任务。如果工作进程死掉,我们希望将任务传递给另一个工作进程。

为了确保消息永远不会丢失,RabbitMQ 支持消息确认。确认是由消费者发回的,以告知 RabbitMQ 已收到并处理了特定消息,并且 RabbitMQ 可以自由删除它。

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

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

手动消息确认默认情况下处于启用状态。在之前的示例中,我们通过 autoAck=true 标志显式地禁用了它们。现在是时候将此标志设置为 false,并在我们完成任务后从工作进程发送正确的确认。

channel.basicQos(1); // accept only one unack-ed message at a time (see below)

DeliverCallback deliverCallback = (consumerTag, delivery) -> {
String message = new String(delivery.getBody(), "UTF-8");

System.out.println(" [x] Received '" + message + "'");
try {
doWork(message);
} finally {
System.out.println(" [x] Done");
channel.basicAck(delivery.getEnvelope().getDeliveryTag(), false);
}
};
boolean autoAck = false;
channel.basicConsume(TASK_QUEUE_NAME, autoAck, deliverCallback, consumerTag -> { });

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

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

忘记确认

错过 basicAck 是一个常见的错误。这是一个容易犯的错误,但后果很严重。当您的客户端退出时,消息将被重新传递(这可能看起来像是随机重新传递),但 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 节点重启后仍然存在。为了做到这一点,我们需要将其声明为持久

boolean durable = true;
channel.queueDeclare("hello", durable, false, false, null);

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

boolean durable = true;
channel.queueDeclare("task_queue", durable, false, false, null);

queueDeclare 更改需要应用于生产者和消费者代码。

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

  • 通过将 MessageProperties(实现 BasicProperties)设置为值 PERSISTENT_TEXT_PLAIN
import com.rabbitmq.client.MessageProperties;

channel.basicPublish("", "task_queue",
MessageProperties.PERSISTENT_TEXT_PLAIN,
message.getBytes());

关于消息持久性的注意事项

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

公平分发

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

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

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

int prefetchCount = 1;
channel.basicQos(prefetchCount);

关于队列大小的注意事项

如果所有工作进程都很忙,您的队列可能会填满。您需要密切关注这一点,并可能添加更多工作进程,或采取其他策略。

总结

我们的 NewTask.java 类的最终代码

import com.rabbitmq.client.Channel;
import com.rabbitmq.client.Connection;
import com.rabbitmq.client.ConnectionFactory;
import com.rabbitmq.client.MessageProperties;

public class NewTask {

private static final String TASK_QUEUE_NAME = "task_queue";

public static void main(String[] argv) throws Exception {
ConnectionFactory factory = new ConnectionFactory();
factory.setHost("localhost");
try (Connection connection = factory.newConnection();
Channel channel = connection.createChannel()) {
channel.queueDeclare(TASK_QUEUE_NAME, true, false, false, null);

String message = String.join(" ", argv);

channel.basicPublish("", TASK_QUEUE_NAME,
MessageProperties.PERSISTENT_TEXT_PLAIN,
message.getBytes("UTF-8"));
System.out.println(" [x] Sent '" + message + "'");
}
}

}

(NewTask.java 源代码)

以及我们的 Worker.java

import com.rabbitmq.client.Channel;
import com.rabbitmq.client.Connection;
import com.rabbitmq.client.ConnectionFactory;
import com.rabbitmq.client.DeliverCallback;

public class Worker {

private static final String TASK_QUEUE_NAME = "task_queue";

public static void main(String[] argv) throws Exception {
ConnectionFactory factory = new ConnectionFactory();
factory.setHost("localhost");
final Connection connection = factory.newConnection();
final Channel channel = connection.createChannel();

channel.queueDeclare(TASK_QUEUE_NAME, true, false, false, null);
System.out.println(" [*] Waiting for messages. To exit press CTRL+C");

channel.basicQos(1);

DeliverCallback deliverCallback = (consumerTag, delivery) -> {
String message = new String(delivery.getBody(), "UTF-8");

System.out.println(" [x] Received '" + message + "'");
try {
doWork(message);
} finally {
System.out.println(" [x] Done");
channel.basicAck(delivery.getEnvelope().getDeliveryTag(), false);
}
};
channel.basicConsume(TASK_QUEUE_NAME, false, deliverCallback, consumerTag -> { });
}

private static void doWork(String task) {
for (char ch : task.toCharArray()) {
if (ch == '.') {
try {
Thread.sleep(1000);
} catch (InterruptedException _ignored) {
Thread.currentThread().interrupt();
}
}
}
}
}

(Worker.java 源代码)

使用消息确认和 prefetchCount,您可以设置工作队列。持久性选项使任务即使在 RabbitMQ 重新启动后也能继续存在。

有关 Channel 方法和 MessageProperties 的更多信息,您可以浏览在线 JavaDocs

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

© . All rights reserved.