跳到主要内容

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

信息

先决条件​

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

在哪里获得帮助​

如果您在学习本教程时遇到问题，您可以通过 GitHub Discussions 或 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 响应与请求关联起来。

关联 ID​

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

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

您可能会问，为什么我们应该忽略回调队列中未知消息，而不是因错误而失败？这是因为服务器端可能存在竞争条件。虽然不太可能，但 RPC 服务器可能会在向我们发送答案之后，但在为请求发送确认消息之前死掉。如果发生这种情况，重新启动的 RPC 服务器将再次处理该请求。这就是为什么在客户端我们必须优雅地处理重复响应，并且 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://localhost', 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://localhost', 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 对于查看队列很有用。

© . All rights reserved.