跳至主要内容

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

远程过程调用 (RPC)

(使用 php-amqplib)

信息

先决条件

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

在哪里寻求帮助

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

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

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

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

客户端接口

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

$fibonacci_rpc = new FibonacciRpcClient();
$response = $fibonacci_rpc->call(30);
echo ' [.] Got ', $response, "\n";

关于 RPC 的说明

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

请记住以下建议

  • 确保清楚哪些函数调用是本地的,哪些是远程的。
  • 记录您的系统。使组件之间的依赖关系清晰明了。
  • 处理错误情况。当 RPC 服务器长时间停机时,客户端应该如何反应?

如有疑问,请避免使用 RPC。如果可以,您应该使用异步管道 - 而不是类似 RPC 的阻塞,结果会被异步推送到下一个计算阶段。

回调队列

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

list($queue_name, ,) = $channel->queue_declare("", false, false, true, false);

$msg = new AMQPMessage(
$payload,
array('reply_to' => $queue_name)
);

$channel->basic_publish($msg, '', 'rpc_queue');

# ... then code to read a response message from the callback_queue ...

消息属性

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

  • delivery_mode:将消息标记为持久性(值为 2)或瞬态(1)。您可能还记得 第二个教程中的此属性。
  • 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 fib($n)
{
if ($n == 0) {
return 0;
}
if ($n == 1) {
return 1;
}
return fib($n-1) + fib($n-2);
}

我们声明我们的斐波那契函数。它只假设有效的正整数输入。(不要期望它对大数字有效,它可能是可能的最慢的递归实现)。

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

<?php

require_once __DIR__ . '/vendor/autoload.php';
use PhpAmqpLib\Connection\AMQPStreamConnection;
use PhpAmqpLib\Message\AMQPMessage;

$connection = new AMQPStreamConnection('localhost', 5672, 'guest', 'guest');
$channel = $connection->channel();

$channel->queue_declare('rpc_queue', false, false, false, false);

function fib($n)
{
if ($n == 0) {
return 0;
}
if ($n == 1) {
return 1;
}
return fib($n-1) + fib($n-2);
}

echo " [x] Awaiting RPC requests\n";
$callback = function ($req) {
$n = intval($req->getBody());
echo ' [.] fib(', $n, ")\n";

$msg = new AMQPMessage(
(string) fib($n),
array('correlation_id' => $req->get('correlation_id'))
);

$req->getChannel()->basic_publish(
$msg,
'',
$req->get('reply_to')
);
$req->ack();
};

$channel->basic_qos(null, 1, false);
$channel->basic_consume('rpc_queue', '', false, false, false, false, $callback);

try {
$channel->consume();
} catch (\Throwable $exception) {
echo $exception->getMessage();
}

$channel->close();
$connection->close();

服务器代码非常简单

  • 像往常一样,我们首先建立连接、通道并声明队列。
  • 我们可能希望运行多个服务器进程。为了将负载平均分配到多个服务器上,我们需要在 $channel.basic_qos 中设置 prefetch_count 设置。
  • 我们使用 basic_consume 访问队列。然后我们进入 while 循环,在其中等待请求消息,执行工作并将响应发送回。

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

<?php

require_once __DIR__ . '/vendor/autoload.php';
use PhpAmqpLib\Connection\AMQPStreamConnection;
use PhpAmqpLib\Message\AMQPMessage;

class FibonacciRpcClient
{
private $connection;
private $channel;
private $callback_queue;
private $response;
private $corr_id;

public function __construct()
{
$this->connection = new AMQPStreamConnection(
'localhost',
5672,
'guest',
'guest'
);
$this->channel = $this->connection->channel();
list($this->callback_queue, ,) = $this->channel->queue_declare(
"",
false,
false,
true,
false
);
$this->channel->basic_consume(
$this->callback_queue,
'',
false,
true,
false,
false,
array(
$this,
'onResponse'
)
);
}

public function onResponse($rep)
{
if ($rep->get('correlation_id') == $this->corr_id) {
$this->response = $rep->body;
}
}

public function call($n)
{
$this->response = null;
$this->corr_id = uniqid();

$msg = new AMQPMessage(
(string) $n,
array(
'correlation_id' => $this->corr_id,
'reply_to' => $this->callback_queue
)
);
$this->channel->basic_publish($msg, '', 'rpc_queue');
while (!$this->response) {
$this->channel->wait();
}
return intval($this->response);
}
}

$fibonacci_rpc = new FibonacciRpcClient();
$response = $fibonacci_rpc->call(30);
echo ' [.] Got ', $response, "\n";

现在是查看我们的完整示例源代码的好时机,rpc_client.phprpc_server.php

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

php rpc_server.php
# => [x] Awaiting RPC requests

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

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

此处提供的设计并非 RPC 服务的唯一可能的实现,但它具有一些重要的优势

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

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

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

如果您想尝试,您可能会发现 管理 UI 对查看队列很有用。

© 2024 RabbitMQ. All rights reserved.