跳到主要内容

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

远程过程调用 (RPC)​

(使用 amqp Elixir 库)​

信息

前提条件​

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

在哪里获得帮助​

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

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

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

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

客户端接口​

为了说明如何使用 RPC 服务，我们将创建一个简单的客户端模块。它将包含一个名为 call 的函数，该函数发送 RPC 请求并阻塞，直到收到答案

result = FibonacciRpcClient.call(4)
IO.puts("fib(4) is #{result}")

关于 RPC 的说明​

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

考虑到这一点，请考虑以下建议

  • 确保清楚地知道哪些函数调用是本地的，哪些是远程的。
  • 记录你的系统。明确组件之间的依赖关系。
  • 处理错误情况。当 RPC 服务器长时间宕机时，客户端应该如何响应？

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

回调队列​

总的来说，通过 RabbitMQ 执行 RPC 很简单。客户端发送请求消息，服务器回复响应消息。为了接收响应，客户端需要在请求中发送一个“回调”队列地址。让我们试试看

{:ok, %{queue: callback_queue}} = AMQP.Queue.declare(channel,
                                                     "",
                                                     exclusive: true)

AMQP.Basic.publish(channel,
                   "",
                   "rpc_queue",
                   request,
                   reply_to: callback_queue)
# ... and some code to read a response message from the callback_queue ...

消息属性​

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

  • persistent：将消息标记为持久性（值为 true）或瞬态（任何其他值）。您可能还记得第二个教程中的这个属性。
  • 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 属性。如果它与请求中的值匹配，则将响应返回给应用程序。

整合在一起​

rpc_server.exs 的代码

defmodule FibServer do
  def fib(0), do: 0
  def fib(1), do: 1
  def fib(n) when n > 1, do: fib(n-1) + fib(n-2)

  def wait_for_messages(channel) do
    receive do
      {:basic_deliver, payload, meta} ->
        {n, _} = Integer.parse(payload)
        IO.puts " [.] fib(#{n})"
        response = fib(n)

        AMQP.Basic.publish(channel,
                           "",
                           meta.reply_to,
                           "#{response}",
                           correlation_id: meta.correlation_id)
        AMQP.Basic.ack(channel, meta.delivery_tag)

        wait_for_messages(channel)
    end
  end
end

{:ok, connection} = AMQP.Connection.open
{:ok, channel} = AMQP.Channel.open(connection)

AMQP.Queue.declare(channel, "rpc_queue")
AMQP.Basic.qos(channel, prefetch_count: 1)
AMQP.Basic.consume(channel, "rpc_queue")
IO.puts " [x] Awaiting RPC requests"

FibServer.wait_for_messages(channel)

服务器代码相当简单明了

  • (2-4) 我们声明了斐波那契函数。（不要指望这个函数能处理大数字，这可能是最慢的递归实现）。
  • (25-28) 像往常一样，我们首先建立连接并声明队列。
  • (29) 我们可能想要运行多个服务器进程。为了在多个服务器上平均分配负载，我们需要设置 prefetch_count 设置。
  • (30) 我们等待来自 AMQP.Basic.consume 的消息，这是 RPC 服务器的核心。当收到请求时，它会被执行。它执行工作并将响应发送回去。

rpc_client.exs 的代码

defmodule FibonacciRpcClient do
  def wait_for_messages(_channel, correlation_id) do
    receive do
      {:basic_deliver, payload, %{correlation_id: ^correlation_id}} ->
        {n, _} = Integer.parse(payload)
        n
    end
  end
  def call(n) do
    {:ok, connection} = AMQP.Connection.open
    {:ok, channel} = AMQP.Channel.open(connection)

    {:ok, %{queue: queue_name}} = AMQP.Queue.declare(channel,
                                                     "",
                                                     exclusive: true)
    AMQP.Basic.consume(channel, queue_name, nil, no_ack: true)
    correlation_id =
      :erlang.unique_integer
      |> :erlang.integer_to_binary
      |> Base.encode64

    request = to_string(n)
    AMQP.Basic.publish(channel,
                       "",
                       "rpc_queue",
                       request,
                       reply_to: queue_name,
                       correlation_id: correlation_id)

    FibonacciRpcClient.wait_for_messages(channel, correlation_id)
  end
end

num =
  case System.argv do
    []    -> 30
    param ->
      {x, _} =
        param
        |> Enum.join(" ")
        |> Integer.parse
      x
  end

IO.puts " [x] Requesting fib(#{num})"
response = FibonacciRpcClient.call(num)
IO.puts " [.] Got #{response}"

客户端代码稍微复杂一些

  • (4) 每次响应时执行的 'wait_for_messages' 函数都在做一项非常简单的工作，对于每条响应消息，它都会检查 correlation_id 是否是我们正在寻找的那个。如果是，它将返回该值并停止监听其他消息。
  • (9) 接下来，我们定义我们的主要 call 方法——它执行实际的 RPC 请求。
  • (10-13) 我们建立连接、通道并声明一个独占的 'callback' 队列用于回复。
  • (16) 我们订阅 'callback' 队列，以便我们可以接收 RPC 响应。
  • (17) 在此函数中，我们首先生成一个唯一的 correlation_id 数字——'wait_for_messages' 函数将使用此值来捕获适当的响应。
  • (23) 接下来，我们发布请求消息，其中包含两个属性：reply_to 和 correlation_id。
  • (30) 此时，我们可以坐下来等待，直到收到正确的响应。

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

mix run rpc_server.exs
# => [x] Awaiting RPC requests

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

mix run rpc_client.exs
# => [x] Requesting fib(30)

所提出的设计不是 RPC 服务的唯一可能实现，但它具有一些重要的优势

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

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

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

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

（rpc_client.exs 和 rpc_server.exs 的完整源代码）

© . All rights reserved.