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 中的请求-应答模式涉及服务器和客户端之间的直接交互。

客户端发送请求消息，服务器用响应消息进行答复。

为了接收答复，我们需要在请求中发送一个“回调”队列名称。这样的队列通常是服务器命名的，也可以有一个众所周知的名称（客户端命名）。

然后，服务器将使用该名称通过默认交换机进行答复。

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

$msg = new AMQPMessage(
    $payload,
    ['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 响应与请求关联起来。

总结

我们的 RPC 将按如下方式工作：

客户端启动时，它会创建一个排他的回调队列。
对于 RPC 请求，客户端发送一个带有两个属性的消息：reply_to，设置为回调队列；correlation_id，设置为每个请求的唯一值。
请求被发送到 rpc_queue 队列。
RPC 工作进程（也称为服务器）在该队列上等待请求。当出现请求时，它会执行任务，并使用 reply_to 字段中的队列将带有结果的消息发送回客户端。
客户端等待回调队列上的数据。当出现消息时，它会检查 correlation_id 属性。如果它与请求中的值匹配，则将响应返回给应用程序。

总而言之

斐波那契任务

function fib(int $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(int $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 (AMQPMessage $req) {
    $n = intval($req->getBody());
    echo ' [.] fib(', $n, ")\n";

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

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

$channel->basic_qos(0, 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\Channel\AMQPChannel;
use PhpAmqpLib\Message\AMQPMessage;

class FibonacciRpcClient
{
    private AMQPStreamConnection $connection;
    private AMQPChannel $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,
            [
                $this,
                'onResponse'
            ]
        );
    }

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

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

        $msg = new AMQPMessage(
            (string) $n,
            [
                '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 服务器来扩展。尝试在新控制台中运行第二个 rpc_server.php。
在客户端，RPC 要求只发送和接收一条消息。不需要像 queue_declare 这样的同步调用。因此，RPC 客户端仅需一次网络往返即可完成一次 RPC 请求。

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

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

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

远程过程调用 (RPC)​

(使用 php-amqplib)​

先决条件​

哪里寻求帮助​

客户端接口​

关于 RPC 的说明​

回调队列​

消息属性​

相关 ID​

总结​

总而言之​