RabbitMQ 教程 - 远程过程调用 (RPC)

远程过程调用 (RPC)

(使用 Kotlin 客户端)

信息

先决条件

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

哪里寻求帮助

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

在第二个教程中，我们学习了如何使用工作队列（Work Queues）在多个工作进程之间分配耗时任务。

但是，如果我们需要在远程计算机上运行一个函数并等待结果呢？嗯，那又是另一回事了。这种模式通常被称为远程过程调用或RPC。

在本教程中，我们将使用 RabbitMQ 来构建一个 RPC 系统：一个客户端和一个可扩展的 RPC 服务器。由于我们没有什么值得分发的耗时任务，我们将创建一个返回斐波那契数的虚拟 RPC 服务。

客户端接口

为了说明如何使用 RPC 服务，我们将创建一个简单的客户端函数。它将发送一个 RPC 请求并等待接收到应答。

val result = rpcClient(this, 30)
println("fib(30) = $result")

关于 RPC 的说明

尽管 RPC 在计算领域是一种相当普遍的模式，但它经常受到批评。当程序员不知道函数调用是本地的还是慢速的 RPC 时，就会出现问题。这样的混淆会导致系统不可预测，并增加调试的复杂性。滥用的 RPC 可能导致难以维护的意大利面条式代码，而不是简化软件。

牢记这一点，请考虑以下建议：

• 确保明确哪些函数调用是本地的，哪些是远程的。
• 记录你的系统。明确组件之间的依赖关系。
• 处理错误情况。当 RPC 服务器长时间关闭时，客户端应该如何反应？

如果不确定，请避免使用 RPC。如果可能，你应该使用异步管道——而不是 RPC 类的阻塞，结果会异步推送到下一个计算阶段。

回调队列

通常情况下，通过 RabbitMQ 进行 RPC 操作很容易。客户端发送请求消息，服务器回复响应消息。为了接收响应，我们需要随请求一起发送一个“回调”队列地址。我们可以使用默认队列。让我们来尝试一下。

val callbackQueueDeclared = channel.queueDeclare(
    name = "",
    durable = false,
    exclusive = true,
    autoDelete = true,
    arguments = emptyMap()
)
val callbackQueueName = callbackQueueDeclared.queueName

val requestProps = properties {
    replyTo = callbackQueueName
}

channel.basicPublish(
    "30".toByteArray(),
    exchange = "",
    routingKey = "rpc_queue",
    properties = requestProps
)

// ... then code to read a response message from the callback queue ...

消息属性

AMQP 0-9-1 协议预定义了一组 14 个消息属性。大多数属性很少使用，除了以下几点：

• deliveryMode：将消息标记为持久化（值为 2）或非持久化（任何其他值）。
• contentType：用于描述编码的 MIME 类型。例如，对于常用的 JSON 编码，将此属性设置为 application/json 是一个好习惯。
• replyTo：通常用于命名回调队列。
• correlationId：用于将 RPC 响应与请求进行关联。

相关 ID

在上面介绍的方法中，我们建议为每个 RPC 请求创建一个回调队列。这样做效率相当低，但幸运的是有一种更好的方法——让我们为每个客户端创建一个单一的回调队列。

这引发了一个新问题：在队列中收到响应时，不清楚该响应属于哪个请求。这时就需要使用 correlationId 属性了。我们将为每个请求将其设置为一个唯一值。稍后，当我们收到回调队列中的消息时，我们将查看此属性，并据此将响应与请求匹配。如果我们看到一个未知的 correlationId 值，我们可以安全地丢弃该消息——它不属于我们的任何请求。

你可能会问，为什么我们应该忽略回调队列中的未知消息，而不是以错误告终？这是因为服务器端存在竞态条件的可能性。虽然不太可能，但 RPC 服务器可能在发送答复后，但在发送请求的确认消息之前就已死机。如果发生这种情况，重新启动的 RPC 服务器将再次处理该请求。因此，在客户端，我们必须优雅地处理重复的响应，并且 RPC 最好是幂等的。

总结

我们的 RPC 将按如下方式工作：

• 对于 RPC 请求，客户端发送带有两个属性的消息：replyTo（设置为仅为该请求创建的回调队列）和 correlationId（为每个请求设置为唯一值）。
• 请求被发送到 rpc_queue 队列。
• RPC 工作进程（即服务器）在该队列上等待请求。当请求出现时，它会执行任务，并使用 replyTo 字段中的队列将带有结果的消息发回给客户端。
• 客户端在回调队列上等待数据。当消息出现时，它会检查 correlationId 属性。如果它与请求中的值匹配，则将响应返回给应用程序。

总而言之

斐波那契（Fibonacci）函数

private fun fib(n: Int): Int {
    return when {
        n == 0 -> 0
        n == 1 -> 1
        else -> fib(n - 1) + fib(n - 2)
    }
}

我们声明了我们的斐波那契函数。它假定输入是有效的正整数。（不要指望这个函数能处理大数字，而且它可能是最慢的递归实现。）

我们的 RPC 服务器代码

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 rpcServer(coroutineScope: CoroutineScope) {
    val config = amqpConfig {
        server {
            host = "localhost"
        }
    }
    val connection = createAMQPConnection(coroutineScope, config)
    val channel = connection.openChannel()

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

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

    println(" [x] Awaiting RPC requests")

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

    for (delivery in consumer) {
        val props = delivery.message.properties
        val correlationId = props.correlationId
        val replyTo = props.replyTo

        val requestMessage = delivery.message.body.decodeToString()
        val n = requestMessage.toIntOrNull() ?: 0

        println(" [.] fib($n)")
        val response = fib(n)

        val replyProps = properties {
            this.correlationId = correlationId
        }

        if (replyTo != null) {
            channel.basicPublish(
                response.toString().toByteArray(),
                exchange = "",
                routingKey = replyTo,
                properties = replyProps
            )
        }

        channel.basicAck(delivery.message, multiple = false)
    }

    channel.close()
    connection.close()
}

private fun fib(n: Int): Int {
    return when {
        n == 0 -> 0
        n == 1 -> 1
        else -> fib(n - 1) + fib(n - 2)
    }
}

服务器代码相当直接。

• 像往常一样，我们首先建立连接并声明队列。
• 我们可能想要运行多个服务器进程。为了在多个服务器之间平均分配负载，我们需要设置 basicQos 配置。
• 我们使用 basicConsume 来访问队列，并提供执行工作并将响应发回的回调函数。

我们的 RPC 客户端代码

import dev.kourier.amqp.connection.amqpConfig
import dev.kourier.amqp.connection.createAMQPConnection
import dev.kourier.amqp.properties
import kotlinx.coroutines.CoroutineScope
import java.util.UUID

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

    val callbackQueueDeclared = channel.queueDeclare(
        name = "",
        durable = false,
        exclusive = true,
        autoDelete = true,
        arguments = emptyMap()
    )
    val callbackQueueName = callbackQueueDeclared.queueName

    val correlationId = UUID.randomUUID().toString()

    val consumer = channel.basicConsume(callbackQueueName, noAck = true)
    var result = 0

    val requestProps = properties {
        this.correlationId = correlationId
        this.replyTo = callbackQueueName
    }

    channel.basicPublish(
        n.toString().toByteArray(),
        exchange = "",
        routingKey = "rpc_queue",
        properties = requestProps
    )
    println(" [x] Requesting fib($n)")

    for (delivery in consumer) {
        val responseCorrelationId = delivery.message.properties.correlationId

        if (responseCorrelationId == correlationId) {
            result = delivery.message.body.decodeToString().toInt()
            println(" [.] Got $result")
            break
        }
    }

    channel.close()
    connection.close()

    return result
}

我们建立连接和通道。我们声明一个排他性的回调队列用于接收回复。我们订阅回调队列，以便可以接收 RPC 响应。我们生成一个唯一的 correlationId 数字并保存它。循环会等待适当的响应，每当我们得到一个响应时，我们都会检查 correlationId 是否是我们正在寻找的那一个。如果是，我们就保存该响应。

发送 RPC 请求

import kotlinx.coroutines.delay
import kotlinx.coroutines.launch
import kotlinx.coroutines.runBlocking

fun main() = runBlocking {
    // Start RPC server
    launch {
        rpcServer(this)
    }

    delay(1000)

    // Make RPC call
    val result = rpcClient(this, 30)
    println("fib(30) = $result")
}

所介绍的设计并不是 RPC 服务的唯一实现方式，但它具有一些重要的优势：

• 如果 RPC 服务器太慢，你可以通过再运行一个服务器来扩展。尝试运行第二个 RPC 服务器。
• 在客户端，RPC 只需发送和接收一条消息。不需要像 queueDeclare 这样的同步调用。因此，RPC 客户端对于单个 RPC 请求只需要一次网络往返。

我们的代码仍然非常简单，并且没有试图解决更复杂（但重要）的问题，例如：

• 如果没有任何服务器正在运行，客户端应该如何反应？
• 客户端是否应该为 RPC 设置某种超时？
• 如果服务器发生故障并引发异常，是否应将其转发给客户端？
• 在处理之前，保护免受无效传入消息（例如检查边界、类型）。

如果你想进行实验，可能会发现管理 UI 对于查看队列很有用。

继续阅读教程 7 以了解发布者确认（Publisher Confirms）。