跳至主要内容

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

远程过程调用 (RPC)​

(使用 amqp Elixir 库)​

信息

先决条件​

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

如何获取帮助​

如果你在完成本教程时遇到问题，可以通过GitHub 讨论或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) 我们建立了一个连接、通道，并声明一个用于回复的独占“回调”队列。
  • (16) 我们订阅了“回调”队列，以便我们可以接收 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 的完整源代码)

© 2024 RabbitMQ. All rights reserved.