RabbitMQ 实现远程过程调用 (RPC)

安装依赖

# composer.json
{
    "require": {
        "php-amqplib/php-amqplib": ">=3.0"
    }
}
> composer.phar install

模式结构

RPC 工作流程：

• 当客户端启动时，会创建一个匿名独占回调队列。

• 对于 RPC 请求，客户端发送具有两个属性的消息：

  • reply_to，设置为回调队列；
  • correlation_id，为每个请求设置唯一值。
• 请求被发送到 rpc_queue 队列。
• 服务器等待该队列上的请求。当请求出现时，执行工作并将带有结果的消息通过reply_to指定的队列发送回客户端。
• 客户端等待回调队列上的消息。当出现一条消息时，检查correlation_id属性。如果它与请求中的值匹配，则将响应返回给应用程序。

客户端

<?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
        );
        
        // 第四个参数设为false关闭自动消息确认，为true打开自动消息确认即投递消息后立刻标记为删除
        $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();

// 发送 RPC 请求并阻塞直到收到响应
$response = $fibonacci_rpc->call(30);
echo ' [.] Got ', $response, "\n";

服务端

<?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->body);
    echo ' [.] fib(', $n, ")\n";

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

    $req->delivery_info['channel']->basic_publish(
        $msg,
        '',
        $req->get('reply_to')
    );
    
    // 手动消息确认
    $req->ack();
};

// 设置 prefetch_count = 1，开启公平分发（默认为循环分发）
// 在处理并确认上一条消息之前，不要将新消息发送给消费者，而发送给其他消费者
$channel->basic_qos(null, 1, null);

// 第四个参数设为false关闭自动消息确认，为true打开自动消息确认即投递消息后立刻标记为删除
$channel->basic_consume('rpc_queue', '', false, false, false, false, $callback);

while ($channel->is_open()) {
    $channel->wait();
}

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

运行

打开一个终端，运行服务端：

php rpc_server.php
 # => [x] 等待 RPC 请求

打开另一个终端，运行服务端：

php rpc_server.php
 # => [x] 等待 RPC 请求

打开另一个终端，运行客户端：

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

拓展功能

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