跳至主要内容

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 进行 RPC 很容易。客户端发送一个请求消息，服务器用一个响应消息回复。为了接收响应，我们需要将“回调”队列地址与请求一起发送。我们可以使用默认队列（在 Java 客户端中是排他的）。让我们尝试一下

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 响应与请求关联起来。

关联 ID​

在上面介绍的方法中，我们建议为每个 RPC 请求创建一个回调队列。这效率非常低，但幸运的是，还有更好的方法 - 让我们为每个客户端创建一个回调队列。

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

您可能会问，为什么我们应该忽略回调队列中的未知消息，而不是出现错误？这是因为服务器端可能存在竞争条件。虽然不太可能，但 RPC 服务器有可能在向我们发送答案后但在发送请求的确认消息之前崩溃。如果发生这种情况，重新启动的 RPC 服务器将再次处理该请求。这就是为什么我们在客户端必须优雅地处理重复响应的原因，并且 RPC 应该理想情况下是幂等的。

总结​

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

  • 对于 RPC 请求，客户端发送一条包含两个属性的消息：replyTo，它设置为专门为请求创建的匿名排他队列，以及correlationId，它设置为每个请求的唯一值。
  • 请求被发送到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 对查看队列很有用。

© 2024 RabbitMQ. All rights reserved.