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

远程过程调用 (RPC)

(使用 Bunny 客户端)

信息

先决条件

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

如何获得帮助

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

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

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

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

客户端接口

为了说明如何使用 RPC 服务，我们将创建一个简单的客户端类。它将公开一个名为 call 的方法，该方法发送 RPC 请求并阻塞，直到收到答案。

client = FibonacciClient.new('rpc_queue')

puts ' [x] Requesting fib(30)'
response = client.call(30)

puts " [.] Got #{response}"

关于 RPC 的说明

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

请牢记以下建议：

• 确保本地函数调用和远程函数调用一目了然。
• 记录您的系统。使组件之间的依赖关系清晰明了。
• 处理错误情况。当 RPC 服务器长时间宕机时，客户端应该如何反应？

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

回调队列

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

queue = channel.queue('', exclusive: true)
exchange = channel.default_exchange

exchange.publish(message, routing_key: 'rpc_queue', reply_to: 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 属性。如果它与请求中的值匹配，它会将响应返回给应用程序。

整合所有部分

斐波那契任务

def fibonacci(value)
  return value if value.zero? || value == 1

  fibonacci(value - 1) + fibonacci(value - 2)
end

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

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

#!/usr/bin/env ruby
require 'bunny'

class FibonacciServer
  def initialize
    @connection = Bunny.new
    @connection.start
    @channel = @connection.create_channel
  end

  def start(queue_name)
    @queue = channel.queue(queue_name)
    @exchange = channel.default_exchange
    subscribe_to_queue
  end

  def stop
    channel.close
    connection.close
  end

  def loop_forever
    # This loop only exists to keep the main thread
    # alive. Many real world apps won't need this.
    loop { sleep 5 }
  end

  private

  attr_reader :channel, :exchange, :queue, :connection

  def subscribe_to_queue
    queue.subscribe do |_delivery_info, properties, payload|
      result = fibonacci(payload.to_i)

      exchange.publish(
        result.to_s,
        routing_key: properties.reply_to,
        correlation_id: properties.correlation_id
      )
    end
  end

  def fibonacci(value)
    return value if value.zero? || value == 1

    fibonacci(value - 1) + fibonacci(value - 2)
  end
end

begin
  server = FibonacciServer.new

  puts ' [x] Awaiting RPC requests'
  server.start('rpc_queue')
  server.loop_forever
rescue Interrupt => _
  server.stop
end

服务器代码相当简单明了：

• 像往常一样，我们首先建立连接、通道并声明队列。
• 我们可能希望运行多个服务器进程。为了将负载平均分配到多个服务器，我们需要在通道上设置 prefetch 设置。
• 我们使用 Bunny::Queue#subscribe 从队列中消费消息。消费者将等待消息传递到自己，完成工作，并将响应发送回去。

我们 RPC 客户端代码 rpc_client.rb

#!/usr/bin/env ruby
require 'bunny'
require 'thread'

class FibonacciClient
  attr_accessor :call_id, :response, :lock, :condition, :connection,
                :channel, :server_queue_name, :reply_queue, :exchange

  def initialize(server_queue_name)
    @connection = Bunny.new(automatically_recover: false)
    @connection.start

    @channel = connection.create_channel
    @exchange = channel.default_exchange
    @server_queue_name = server_queue_name

    setup_reply_queue
  end

  def call(n)
    @call_id = generate_uuid

    exchange.publish(n.to_s,
                     routing_key: server_queue_name,
                     correlation_id: call_id,
                     reply_to: reply_queue.name)

    # wait for the signal to continue the execution
    lock.synchronize { condition.wait(lock) }

    response
  end

  def stop
    channel.close
    connection.close
  end

  private

  def setup_reply_queue
    @lock = Mutex.new
    @condition = ConditionVariable.new
    that = self
    @reply_queue = channel.queue('', exclusive: true)

    reply_queue.subscribe do |_delivery_info, properties, payload|
      if properties[:correlation_id] == that.call_id
        that.response = payload.to_i

        # sends the signal to continue the execution of #call
        that.lock.synchronize { that.condition.signal }
      end
    end
  end

  def generate_uuid
    # very naive but good enough for code examples
    "#{rand}#{rand}#{rand}"
  end
end

client = FibonacciClient.new('rpc_queue')

puts ' [x] Requesting fib(30)'
response = client.call(30)

puts " [.] Got #{response}"

client.stop

现在是查看我们的完整示例源代码（包括基本的异常处理）的好时机，该代码适用于 rpc_client.rb 和 rpc_server.rb。

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

ruby rpc_server.rb
# => [x] Awaiting RPC requests

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

ruby rpc_client.rb
# => [x] Requesting fib(30)

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

• 如果 RPC 服务器太慢，您只需运行另一个服务器即可进行扩展。尝试在新的控制台中运行第二个 rpc_server.rb。
• 在客户端侧，RPC 只需要发送和接收一条消息。不需要像 Bunny::Channel#queue 这样的同步调用。因此，RPC 客户端只需要一次网络往返即可完成单个 RPC 请求。

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

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

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