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

信息

先决条件

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

哪里寻求帮助

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

远程过程调用 (RPC)

(使用 amqp.node 客户端)

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

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

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

关于 RPC 的说明

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

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

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

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

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

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

回调队列

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

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

为了接收响应，客户端需要随请求一起发送一个“回调”队列地址。一种方法是为每个客户端创建一个服务器命名的排他队列。然而，这种做法效率低下：为每个 RPC 交换创建和删除队列代价高昂，尤其是在所有节点必须就队列元数据达成一致的集群环境中。

一个更好的替代方案是直接回复（Direct Reply-to）：客户端无需声明真实的队列，而是从伪队列 amq.rabbitmq.reply-to 中消费，并将其设置为请求消息的 replyTo 属性。RabbitMQ 随后会将回复直接路由到客户端的通道，而无需创建任何队列。这在集群中更高效、更稳健。

直接回复（Direct Reply-to）要求消费者使用 noAck: true（自动确认模式），因为如果客户端断开连接或拒绝消息，没有真实的队列可以将消息退回。

channel.consume('amq.rabbitmq.reply-to', function(msg) {
  // ... handle the response message ...
}, { noAck: true });

channel.sendToQueue('rpc_queue', Buffer.from('10'), {
   replyTo: 'amq.rabbitmq.reply-to'
});

消息属性

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

persistent：将消息标记为持久化（值为 true）或瞬态（false）。您可能还记得第二个教程中提到的这个属性。

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

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

correlation_id：用于将 RPC 响应与请求关联起来。

总结

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

当客户端启动时，它会使用直接回复（Direct Reply-to）从伪队列 amq.rabbitmq.reply-to 中进行消费。无需声明队列。
对于 RPC 请求，客户端发送带有两个属性的消息：reply_to（设置为 amq.rabbitmq.reply-to）和 correlation_id（为每个请求设置为唯一值）。
请求被发送到 rpc_queue 队列。
RPC 工作进程（也称为服务器）在该队列上等待请求。当出现请求时，它会执行任务，并使用 reply_to 字段中的队列将带有结果的消息发送回客户端。
客户端在回复伪队列上等待数据。当消息出现时，它会检查 correlation_id 属性。如果它与请求中的值匹配，它就会将响应返回给应用程序。

总而言之

斐波那契（Fibonacci）函数

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

const amqp = require('amqplib');

async function main() {
  const connection = await amqp.connect('amqp://');
  const channel = await connection.createChannel();

  const queue = 'rpc_queue';

  await channel.assertQueue(queue, {
    durable: true,
    arguments: {
      'x-queue-type': 'quorum'
    }
  });
  channel.prefetch(1);
  console.log(' [x] Awaiting RPC requests');
  channel.consume(queue, function reply(msg) {
    const n = parseInt(msg.content.toString());

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

    const 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);
}

main();

服务器代码相当直接。

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

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

#!/usr/bin/env node

const amqp = require('amqplib');

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

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

async function main() {
  const connection = await amqp.connect('amqp://');
  const channel = await connection.createChannel();

  const correlationId = generateUuid();
  const num = parseInt(args[0]);

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

  const result = await new Promise((resolve) => {
    // Consume from the Direct Reply-to pseudo-queue (automatic acknowledgement mode is mandatory)
    channel.consume('amq.rabbitmq.reply-to', (msg) => {
      if (msg.properties.correlationId === correlationId) {
        resolve(msg.content.toString());
      }
    }, { noAck: true });

    channel.sendToQueue('rpc_queue',
      Buffer.from(num.toString()), {
        correlationId: correlationId,
        replyTo: 'amq.rabbitmq.reply-to'
      });
  });

  console.log(' [.] Got %s', result);
  await connection.close();
}

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

main();

现在是查看我们 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

总结

总而言之