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

远程过程调用 (RPC)

（使用 php-amqplib）

信息

先决条件

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

在哪里获得帮助

如果您在学习本教程时遇到问题，可以通过 GitHub Discussions 或 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.php 和 rpc_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 对于查看队列很有用。