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

信息

先决条件

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

获取帮助

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

远程过程调用 (RPC)

(使用 amqp.node 客户端)

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

但是，如果我们需要在远程计算机上运行一个函数并等待结果呢？好吧，这是一个不同的故事。这种模式通常称为远程过程调用或RPC。

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

关于 RPC 的说明

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

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

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

记录您的系统。使组件之间的依赖关系清晰明了。

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

如有疑问，请避免使用 RPC。如果可以，您应该使用异步管道 - 而不是类似 RPC 的阻塞，结果会异步推送到下一个计算阶段。

回调队列

一般来说，通过 RabbitMQ 执行 RPC 很容易。客户端发送请求消息，服务器回复响应消息。为了接收响应，我们需要在请求中发送“回调”队列地址。我们可以使用默认交换机。让我们试试吧

channel.assertQueue('', {
  exclusive: true
});

channel.sendToQueue('rpc_queue', Buffer.from('10'), {
   replyTo: queue_name
});

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

消息属性

AMQP 0-9-1 协议预定义了一组 14 个与消息一起使用的属性。大多数属性很少使用，但以下除外

persistent：将消息标记为持久性 (值为 true) 或瞬态 (false)。您可能还记得第二个教程中的此属性。

content_type：用于描述编码的 mime 类型。例如，对于常用的 JSON 编码，最好将此属性设置为：application/json。

reply_to：通常用于命名回调队列。

correlation_id：有助于将 RPC 响应与请求关联。

总结

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

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

整合

斐波那契函数

function fibonacci(n) {
  if (n == 0 || n == 1)
    return n;
  else
    return fibonacci(n - 1) + fibonacci(n - 2);
}

我们声明了斐波那契函数。它只假设有效的正整数输入。（不要期望它适用于大数字，它可能是最慢的递归实现。）

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

#!/usr/bin/env node

var amqp = require('amqplib/callback_api');

amqp.connect('amqp://127.0.0.1', function(error0, connection) {
  if (error0) {
    throw error0;
  }
  connection.createChannel(function(error1, channel) {
    if (error1) {
      throw error1;
    }
    var queue = 'rpc_queue';

    channel.assertQueue(queue, {
      durable: false
    });
    channel.prefetch(1);
    console.log(' [x] Awaiting RPC requests');
    channel.consume(queue, function reply(msg) {
      var n = parseInt(msg.content.toString());

      console.log(" [.] fib(%d)", n);

      var r = fibonacci(n);

      channel.sendToQueue(msg.properties.replyTo,
        Buffer.from(r.toString()), {
          correlationId: msg.properties.correlationId
        });

      channel.ack(msg);
    });
  });
});

function fibonacci(n) {
  if (n == 0 || n == 1)
    return n;
  else
    return fibonacci(n - 1) + fibonacci(n - 2);
}

服务器代码相当简单

像往常一样，我们首先建立连接、通道并声明队列。
我们可能希望运行多个服务器进程。为了在多个服务器之间平均分配负载，我们需要在通道上设置 prefetch 设置。
我们使用 Channel.consume 从队列中消费消息。然后我们进入回调函数，在那里我们执行工作并将响应发送回去。

我们 RPC 客户端的代码rpc_client.js

#!/usr/bin/env node

var amqp = require('amqplib/callback_api');

var args = process.argv.slice(2);

if (args.length == 0) {
  console.log("Usage: rpc_client.js num");
  process.exit(1);
}

amqp.connect('amqp://127.0.0.1', function(error0, connection) {
  if (error0) {
    throw error0;
  }
  connection.createChannel(function(error1, channel) {
    if (error1) {
      throw error1;
    }
    channel.assertQueue('', {
      exclusive: true
    }, function(error2, q) {
      if (error2) {
        throw error2;
      }
      var correlationId = generateUuid();
      var num = parseInt(args[0]);

      console.log(' [x] Requesting fib(%d)', num);

      channel.consume(q.queue, function(msg) {
        if (msg.properties.correlationId == correlationId) {
          console.log(' [.] Got %s', msg.content.toString());
          setTimeout(function() {
            connection.close();
            process.exit(0)
          }, 500);
        }
      }, {
        noAck: true
      });

      channel.sendToQueue('rpc_queue',
        Buffer.from(num.toString()),{
          correlationId: correlationId,
          replyTo: q.queue });
    });
  });
});

function generateUuid() {
  return Math.random().toString() +
         Math.random().toString() +
         Math.random().toString();
}

现在是查看我们完整示例源代码的好时机，分别为rpc_client.js和rpc_server.js。

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

./rpc_server.js
# => [x] Awaiting RPC requests

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

./rpc_client.js 30
# => [x] Requesting fib(30)

这里介绍的设计并不是 RPC 服务的唯一可能实现，但它具有一些重要的优势

如果 RPC 服务器太慢，您可以通过只需运行另一个服务器来进行扩展。尝试在新控制台中运行第二个 rpc_server.js。
在客户端，RPC 只需要发送和接收一条消息。因此，RPC 客户端只需要一个网络往返即可完成单个 RPC 请求。

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

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

如果您想尝试，可能会发现管理 UI对查看队列很有用。

先决条件​

获取帮助​

远程过程调用 (RPC)​

(使用 amqp.node 客户端)​

关于 RPC 的说明​

回调队列​

消息属性​

相关 ID​

总结​

整合​

先决条件

获取帮助

远程过程调用 (RPC)

(使用 amqp.node 客户端)

关于 RPC 的说明

回调队列

消息属性

相关 ID

总结

整合