RabbitMQ 教程 - 工作队列

工作队列

(使用 Kotlin 客户端)

信息

先决条件

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

哪里寻求帮助

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

在第一个教程中，我们编写了用于向命名队列发送和接收消息的程序。在这一篇中，我们将创建一个工作队列（Work Queue），用于在多个工作者（worker）之间分配耗时的任务。

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

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

准备工作

在本教程的上一部分中，我们发送了一条包含“Hello World!”的消息。现在，我们将发送代表复杂任务的字符串。由于我们没有真实的业务场景（例如调整图片大小或渲染 PDF 文件），我们将通过使用 delay() 函数来模拟任务处理的耗时。我们将字符串中点的数量视为任务的复杂度；每一个点代表一秒钟的“工作量”。例如，由 Hello... 描述的虚构任务将花费三秒钟。

我们将稍微修改上一个示例中的 send 函数，以允许将消息作为任务发送。该程序会将任务调度到我们的工作队列中，因此我们将其命名为 newTask。

suspend fun newTask(coroutineScope: CoroutineScope, message: String) {
    val config = amqpConfig {
        server {
            host = "localhost"
        }
    }
    val connection = createAMQPConnection(coroutineScope, config)
    val channel = connection.openChannel()

    channel.queueDeclare(
        "task_queue",
        durable = true,
        exclusive = false,
        autoDelete = false,
        arguments = mapOf("x-queue-type" to Field.LongString("quorum"))
    )

    val properties = properties {
        deliveryMode = 2u  // Persistent message
    }

    channel.basicPublish(
        message.toByteArray(),
        exchange = "",
        routingKey = "task_queue",
        properties = properties
    )
    println(" [x] Sent '$message'")

    channel.close()
    connection.close()
}

我们旧的 receive 函数也需要做一些改动：它需要针对消息体中的每一个点模拟一秒钟的工作时间。它将处理已投递的消息并执行任务，因此我们将其称为 worker。

suspend fun worker(coroutineScope: CoroutineScope) {
    val config = amqpConfig {
        server {
            host = "localhost"
        }
    }
    val connection = createAMQPConnection(coroutineScope, config)
    val channel = connection.openChannel()

    channel.queueDeclare(
        "task_queue",
        durable = true,
        exclusive = false,
        autoDelete = false,
        arguments = mapOf("x-queue-type" to Field.LongString("quorum"))
    )
    println(" [*] Waiting for messages. To exit press CTRL+C")

    val consumer = channel.basicConsume("task_queue", noAck = true)

    for (delivery in consumer) {
        val message = delivery.message.body.decodeToString()
        println(" [x] Received '$message'")

        try {
            doWork(message)
        } finally {
            println(" [x] Done")
        }
    }

    channel.close()
    connection.close()
}

我们用于模拟执行时间的虚构任务

private suspend fun doWork(task: String) {
    for (ch in task) {
        if (ch == '.') {
            delay(1000) // Sleep for 1 second per dot
        }
    }
}

轮询分发

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

默认情况下，RabbitMQ 会按顺序将每条消息发送给下一个消费者。平均而言，每个消费者将获得相同数量的消息。这种分发消息的方式称为轮询（round-robin）。

消息确认

完成一项任务可能需要几秒钟，您可能会想，如果一个消费者开始一项长时间任务然后终止了怎么办？使用我们当前的代码，一旦 RabbitMQ 将消息传递给消费者，它会立即将其标记为删除。在这种情况下，如果您终止一个工作者，它正在处理的消息就会丢失。分派给该特定工作者但尚未处理的消息也会丢失。

但是我们不想丢失任何任务。如果一个工作进程死亡，我们希望将任务分发给另一个工作进程。

为了确保消息永远不会丢失，RabbitMQ 支持消息确认。ack（确认）由消费者发送回来，告知 RabbitMQ 特定消息已收到、已处理，并且 RabbitMQ 可以删除它。

如果消费者死亡（其通道关闭、连接关闭或 TCP 连接丢失）而未发送 ack，RabbitMQ 将理解消息未完全处理，并会将其重新排队。如果当时有其他消费者在线，它将迅速将其重新分发给另一个消费者。这样，您可以确信没有消息会丢失，即使工作进程偶尔会死亡。

强制执行消费者交付确认的超时（默认为 30 分钟）。这有助于检测从未确认交付的错误（卡住）的消费者。您可以按照交付确认超时中的说明增加此超时。

在之前的示例中，手动消息确认默认是关闭的。现在是时候通过 noAck = false 标志将其开启，并在完成任务后从工作者那里发送正确的确认了。

channel.basicQos(count = 1u, global = false)

val consumer = channel.basicConsume("task_queue", noAck = false)

for (delivery in consumer) {
    val message = delivery.message.body.decodeToString()
    println(" [x] Received '$message'")

    try {
        doWork(message)
        println(" [x] Done")
    } finally {
        channel.basicAck(delivery.message, multiple = false)
    }
}

使用这段代码，你可以确保即使你在使用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 节点重启。为此，我们需要将其声明为持久

channel.queueDeclare(
    "task_queue",
    durable = true,
    exclusive = false,
    autoDelete = false,
    arguments = mapOf("x-queue-type" to Field.LongString("quorum"))
)

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

channel.queueDeclare(
    "task_queue",
    durable = true,
    exclusive = false,
    autoDelete = false,
    arguments = mapOf("x-queue-type" to Field.LongString("quorum"))
)

此 durable（持久化）选项的更改需要同时应用于生产者和消费者的代码。

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

• 通过将 deliveryMode 属性设置为 2u。

val properties = properties {
    deliveryMode = 2u  // Persistent message
}

channel.basicPublish(
    message.toByteArray(),
    exchange = "",
    routingKey = "task_queue",
    properties = properties
)

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

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

公平分派

您可能已经注意到调度仍然不能完全按我们想要的方式工作。例如，在有两个工作进程的情况下，当所有奇数消息都很重而偶数消息都很轻时，一个工作进程将持续忙碌，而另一个工作进程几乎不做任何工作。好吧，RabbitMQ 对此一无所知，它仍然会均匀地分发消息。

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

为了解决这个问题，我们可以使用带有 count = 1u 设置的 basicQos 方法。这告诉 RabbitMQ 不要一次给一个工作者发送多条消息。或者换句话说，在工作者处理并确认上一条消息之前，不要向其分发新消息。相反，它会将消息分发给下一个不忙的工作者。

channel.basicQos(count = 1u, global = false)

关于队列大小的说明

如果所有的工作者都很忙，您的队列可能会填满。您需要留意这种情况，并考虑增加更多工作者，或者使用消息 TTL。

总而言之

我们 newTask 函数的最终代码

import dev.kourier.amqp.Field
import dev.kourier.amqp.connection.amqpConfig
import dev.kourier.amqp.connection.createAMQPConnection
import dev.kourier.amqp.properties
import kotlinx.coroutines.CoroutineScope

suspend fun newTask(coroutineScope: CoroutineScope, message: String) {
    val config = amqpConfig {
        server {
            host = "localhost"
        }
    }
    val connection = createAMQPConnection(coroutineScope, config)
    val channel = connection.openChannel()

    channel.queueDeclare(
        "task_queue",
        durable = true,
        exclusive = false,
        autoDelete = false,
        arguments = mapOf("x-queue-type" to Field.LongString("quorum"))
    )

    val properties = properties {
        deliveryMode = 2u  // Persistent message
    }

    channel.basicPublish(
        message.toByteArray(),
        exchange = "",
        routingKey = "task_queue",
        properties = properties
    )
    println(" [x] Sent '$message'")

    channel.close()
    connection.close()
}

以及我们的 worker 代码

import dev.kourier.amqp.Field
import dev.kourier.amqp.connection.amqpConfig
import dev.kourier.amqp.connection.createAMQPConnection
import kotlinx.coroutines.CoroutineScope
import kotlinx.coroutines.delay

suspend fun worker(coroutineScope: CoroutineScope) {
    val config = amqpConfig {
        server {
            host = "localhost"
        }
    }
    val connection = createAMQPConnection(coroutineScope, config)
    val channel = connection.openChannel()

    channel.queueDeclare(
        "task_queue",
        durable = true,
        exclusive = false,
        autoDelete = false,
        arguments = mapOf("x-queue-type" to Field.LongString("quorum"))
    )
    println(" [*] Waiting for messages. To exit press CTRL+C")

    channel.basicQos(count = 1u, global = false)

    val consumer = channel.basicConsume("task_queue", noAck = false)

    for (delivery in consumer) {
        val message = delivery.message.body.decodeToString()
        println(" [x] Received '$message'")

        try {
            doWork(message)
            println(" [x] Done")
        } finally {
            channel.basicAck(delivery.message, multiple = false)
        }
    }

    channel.close()
    connection.close()
}

private suspend fun doWork(task: String) {
    for (ch in task) {
        if (ch == '.') {
            delay(1000) // Sleep for 1 second per dot
        }
    }
}

通过使用消息确认和 basicQos，您可以建立一个工作队列。持久化选项可以让任务即使在 RabbitMQ 重启后也能存活。

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