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

远程过程调用 (RPC)

(使用 .NET 客户端)

信息

先决条件

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

哪里寻求帮助

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

在第二个教程中，我们学习了如何使用工作队列（Work Queues）将耗时的任务分发给多个工作者。

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

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

客户端接口

为了说明 RPC 服务的使用方法，我们将创建一个简单的客户端类。它将公开一个名为 CallAsync 的方法，用于发送 RPC 请求并等待响应。

dotnet/RPCClient/RPCClient.cs

loading...

在 GitHub 上查看

关于 RPC 的说明

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

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

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

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

回调队列

RabbitMQ 中的请求-应答模式涉及服务器和客户端之间的直接交互。

客户端发送请求消息，服务器用响应消息进行答复。

为了接收答复，我们需要在请求中发送一个“回调”队列名称。这样的队列通常是服务器命名的，也可以有一个众所周知的名称（客户端命名）。

然后，服务器将使用该名称通过默认交换机进行答复。

dotnet/RPCClient/RPCClient.cs

loading...

在 GitHub 上查看

消息属性

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

• Persistent：将消息标记为持久化（值为 true）或瞬态（任何其他值）。请参阅第二个教程。
• DeliveryMode：熟悉该协议的用户可以选择使用此属性而不是 Persistent。它们控制的是同一件事。
• ContentType：用于描述编码的 MIME 类型。例如，对于常用的 JSON 编码，建议将此属性设置为：application/json。
• ReplyTo：通常用于指定回调队列的名称。
• CorrelationId：用于将 RPC 响应与请求进行关联。

相关 ID

为每个 RPC 请求创建一个回调队列效率低下。更好的方法是为每个客户端创建一个回调队列。

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

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

总结

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

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

总而言之

斐波那契任务

dotnet/RPCServer/RPCServer.cs

loading...

在 GitHub 上查看

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

我们的 RPC 服务器代码如下所示

dotnet/RPCServer/RPCServer.cs

loading...

在 GitHub 上查看

服务器代码相当直接。

• 像往常一样，我们首先建立连接、通道并声明队列。
• 我们可能希望运行多个服务器进程。为了在多个服务器之间平均分配负载，我们需要在 channel.BasicQosAsync 中设置 prefetchCount。
• 我们使用 BasicConsumeAsync 来访问队列。然后，我们注册一个投递处理程序，在其中完成工作并发送响应。

我们的 RPC 客户端代码

dotnet/RPCClient/RPCClient.cs

loading...

在 GitHub 上查看

客户端代码稍微复杂一些。

• 我们建立连接和通道，并声明一个用于回复的独占（exclusive）“回调”队列。
• 我们订阅“回调”队列，以便接收 RPC 响应。
• 我们的 CallAsync 方法执行实际的 RPC 请求。
• 在这里，我们首先生成一个唯一的 CorrelationId 数字并将其保存，以便在响应到达时识别出相应的请求。
• 接下来，我们发布请求消息，并附带两个属性：ReplyTo 和 CorrelationId。
• 此时，我们可以坐下来等待合适的响应到达。
• 对于每一条响应消息，客户端都会检查 CorrelationId 是否为我们正在寻找的那个。如果是，它将保存该响应。
• 最后，我们将响应返回给用户。

发起客户端请求

dotnet/RPCClient/RPCClient.cs

loading...

在 GitHub 上查看

按惯例进行设置（请参阅第一个教程）

我们的 RPC 服务现在已准备就绪。我们可以启动服务器：

cd RPCServer
dotnet run
# => [x] Awaiting RPC requests

要请求一个斐波那契数，请运行客户端：

cd RPCClient
dotnet run
# => [x] Requesting fib(30)

这里提出的设计并不是 RPC 服务唯一可能的实现方式，但它具有一些重要的优点：

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

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

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

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