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

远程过程调用 (RPC)

(使用 Java 客户端)

信息

先决条件

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

哪里寻求帮助

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

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

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

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

客户端接口

为了说明 RPC 服务如何使用，我们将创建一个简单的客户端类。它将公开一个名为 call 的方法，该方法发送 RPC 请求并阻塞直到收到答复。

FibonacciRpcClient fibonacciRpc = new FibonacciRpcClient();
String result = fibonacciRpc.call("4");
System.out.println( "fib(4) is " + result);

关于 RPC 的说明

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

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

确保明确哪些函数调用是本地的，哪些是远程的。

记录你的系统。明确组件之间的依赖关系。

处理错误情况。当 RPC 服务器长时间关闭时，客户端应该如何反应？

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

回调队列

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

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

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

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

callbackQueueName = channel.queueDeclare().getQueue();

BasicProperties props = new BasicProperties
                            .Builder()
                            .replyTo(callbackQueueName)
                            .build();

channel.basicPublish("", "rpc_queue", props, message.getBytes());

// ... then code to read a response message from the callback_queue ...

我们需要这个新的导入

import com.rabbitmq.client.AMQP.BasicProperties;

消息属性

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

deliveryMode: 将消息标记为持久（值为2）或瞬态（任何其他值）。您可能还记得第二个教程中的这个属性。

contentType: 用于描述编码的 MIME 类型。例如，对于常用的 JSON 编码，将其设置为：application/json 是一个好习惯。

replyTo: 通常用于命名一个回调队列。

correlationId: 用于关联 RPC 响应与请求。

总结

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

客户端启动时，它会创建一个排他的回调队列。
对于 RPC 请求，客户端发送一个带有两个属性的消息：reply_to，设置为回调队列；correlation_id，设置为每个请求的唯一值。
请求被发送到 rpc_queue 队列。
RPC 工作节点（又称：服务器）在该队列上等待请求。当出现请求时，它会完成工作，并使用replyTo字段中的队列将带有结果的消息发送回客户端。
客户端等待回复队列中的数据。当出现消息时，它会检查correlationId属性。如果与请求中的值匹配，它会将响应返回给应用程序。

总而言之

斐波那契任务

private static int fib(int n) {
    if (n == 0) return 0;
    if (n == 1) return 1;
    return fib(n-1) + fib(n-2);
}

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

我们的 RPC 服务器代码可以在这里找到：RPCServer.java。

服务器代码相当直接。

像往常一样，我们首先建立连接、通道并声明队列。
我们可能希望运行多个服务器进程。为了在多个服务器之间平均分配负载，我们需要在 channel.basicQos 中设置prefetchCount设置。
我们使用basicConsume来访问队列，并提供一个对象形式的回调（DeliverCallback），该对象将执行工作并将响应发送回。

我们的 RPC 客户端代码可以在这里找到：RPCClient.java。

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

我们建立连接和通道。
我们的call方法执行实际的 RPC 请求。
在这里，我们首先生成一个唯一的correlationId数字并保存它——我们的消费者回调将使用此值来匹配相应的响应。
然后，我们创建一个专用的独占队列用于回复，并订阅它。
接下来，我们发布请求消息，并带有两个属性：replyTo和correlationId。
此时，我们可以坐下来，等待适当的响应到达。
由于我们的消费者投递处理发生在单独的线程中，因此我们需要某种方法在响应到达之前暂停main线程。使用CompletableFuture是实现这一目标的一种可能解决方案。
消费者正在执行一个非常简单的任务，对于每个消耗的响应消息，它都会检查correlationId是否是我们正在寻找的。如果是，它会完成CompletableFuture。
同时，main线程正在等待CompletableFuture完成。
最后，我们将响应返回给用户。

现在是时候查看我们完整的示例源代码（包括基本的异常处理）了，包括 RPCClient.java 和 RPCServer.java。

像往常一样编译并设置类路径（请参阅第一个教程）

javac -cp $CP RPCClient.java RPCServer.java

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

java -cp $CP RPCServer
# => [x] Awaiting RPC requests

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

java -cp $CP RPCClient
# => [x] Requesting fib(30)

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

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

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

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

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

远程过程调用 (RPC)​

(使用 Java 客户端)​

先决条件​

哪里寻求帮助​

客户端接口​

关于 RPC 的说明​

回调队列​

消息属性​

相关 ID​

总结​

总而言之​