> For the complete documentation index, see [llms.txt](https://rabbitmq.shujuwajue.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://rabbitmq.shujuwajue.com/ying-yong-jiao-cheng/php-ban/6-rpc.md).

# 远程过程调用

> 原文：[Remote procedure call (RPC)](http://www.rabbitmq.com/tutorials/tutorial-six-php.html)\
> 状态：翻译完成\
> 翻译：小虾米（QQ:509129）\
> 参考：Ping Yang（Python版）

## 远程过程调用（RPC）

**（使用**[**php-amqplib**](https://github.com/php-amqplib/php-amqplib)**）**

在[第二篇教程](https://rabbitmq.shujuwajue.com/tutorials_with_php/\[2]Work_Queues.md.html)中我们介绍了如何使用工作队列（work queue）在多个工作者（woker）中间分发耗时的任务。

可是如果我们需要将一个函数运行在远程计算机上并且等待从那儿获取结果时，该怎么办呢？这就是另外的故事了。这种模式通常被称为远程过程调用（Remote Procedure Call）或者RPC。

这篇教程中，我们会使用RabbitMQ来构建一个RPC系统：包含一个客户端和一个RPC服务器。现在的情况是，我们没有一个值得被分发的足够耗时的任务，所以接下来，我们会创建一个模拟RPC服务来返回斐波那契数列。

### 客户端接口

为了展示RPC服务如何使用，我们创建了一个简单的客户端类。它会暴露出一个名为“call”的方法用来发送一个RPC请求，并且在收到回应前保持阻塞。

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

> #### 关于RPC的注意事项：
>
> 尽管RPC在计算领域是一个常用模式，但它也经常被诟病。当一个问题被抛出的时候，程序员往往意识不到这到底是由本地调用还是由较慢的RPC调用引起的。同样的困惑还来自于系统的不可预测性和给调试工作带来的不必要的复杂性。跟软件精简不同的是，滥用RPC会导致不可维护的\[面条代码]\[5].
>
> 考虑到这一点，牢记以下建议：
>
> 确保能够明确的搞清楚哪个函数是本地调用的，哪个函数是远程调用的。给你的系统编写文档。保持各个组件间的依赖明确。处理错误案例。明了客户端改如何处理RPC服务器的宕机和长时间无响应情况。
>
> 当对避免使用RPC有疑问的时候。如果可以的话，你应该尽量使用异步管道来代替RPC类的阻塞。结果被异步地推送到下一个计算场景。

### 回调队列

一般来说通过RabbitMQ来实现RPC是很容易的。一个客户端发送请求信息，服务器端将其应用到一个回复信息中。为了接收到回复信息，客户端需要在发送请求的时候同时发送一个回调队列（callback queue）的地址。我们可以使用默认的队列。我们试试看：

```php
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协议给消息预定义了一系列的14个属性。大多数属性很少会用到，除了以下几个：
>
> * delivery\_mode（投递模式）：将消息标记为持久的（值为2）或暂存的（除了2之外的其他任何值）。第二篇教程里接触过这个属性，记得吧？
> * content\_type（内容类型）:用来描述编码的mime-type。例如在实际使用中常常使用application/json来描述JOSN编码类型。
> * reply\_to（回复目标）：通常用来命名回调队列。
> * correlation\_id（关联标识）：用来将RPC的响应和请求关联起来。

### 关联标识

上边介绍的方法中，我们建议给每一个RPC请求新建一个回调队列。这不是一个高效的做法，幸好这儿有一个更好的办法 —— 我们可以为每个客户端只建立一个独立的回调队列。

这就带来一个新问题，当此队列接收到一个响应的时候它无法辨别出这个响应是属于哪个请求的。**correlation\_id** 就是为了解决这个问题而来的。我们给每个请求设置一个独一无二的值。稍后，当我们从回调队列中接收到一个消息的时候，我们就可以查看这条属性从而将响应和请求匹配起来。如果我们接手到的消息的correlation\_id是未知的，那就直接销毁掉它，因为它不属于我们的任何一条请求。

你也许会问，为什么我们接收到未知消息的时候不抛出一个错误，而是要将它忽略掉？这是为了解决服务器端有可能发生的竞争情况。尽管可能性不大，但RPC服务器还是有可能在已将应答发送给我们但还未将确认消息发送给请求的情况下死掉。如果这种情况发生，RPC在重启后会重新处理请求。这就是为什么我们必须在客户端优雅的处理重复响应，同时RPC也需要尽可能保持幂等性。

### 总结

![](http://www.rabbitmq.com/img/tutorials/python-six.png)

我们的RPC如此工作:

* 当客户端启动的时候，它创建一个匿名独享的回调队列。
* 在RPC请求中，客户端发送带有两个属性的消息：一个是设置回调队列的 *reply\_to* 属性，另一个是设置唯一值的 *correlation\_id* 属性。
* 将请求发送到一个 *rpc\_queue* 队列中。
* RPC工作者（又名：服务器）等待请求发送到这个队列中来。当请求出现的时候，它执行他的工作并且将带有执行结果的消息发送给reply\_to字段指定的队列。
* 客户端等待回调队列里的数据。当有消息出现的时候，它会检查correlation\_id属性。如果此属性的值与请求匹配，将它返回给应用。

## 整合到一起

斐波纳契数列的任务：

```php
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
<?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->delivery_info['channel']->basic_ack(
        $req->delivery_info['delivery_tag']);
};

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

while(count($channel->callbacks)) {
    $channel->wait();
}

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

?>
```

服务器端代码相当简单：

* 像往常一样，我们建立连接，声明队列
* 我们为 basic\_consume 声明了一个回调函数，这是RPC服务器端的核心。它执行实际的操作并且作出响应。
* 或许我们希望能在服务器上多开几个线程。为了能将负载平均地分摊到多个服务器，我们需要在$channel.basic\_qos中设置prefetch\_count。

RPC客户端rpc\_client.php代码：

```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, false, false, false,
            array($this, 'on_response'));
    }
    public function on_response($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](https://github.com/rabbitmq/rabbitmq-tutorials/blob/master/php/rpc_client.php)和[rpc\_server.php](https://github.com/rabbitmq/rabbitmq-tutorials/blob/master/php/rpc_server.php)。

我们的RPC服务已经准备就绪了，现在启动服务器端：

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

运行客户端，请求一个fibonacci队列。

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

此处呈现的设计并不是实现RPC服务的唯一方式，但是他有一些重要的优势：

* 如果RPC服务器运行的过慢的时候，你可以通过运行另外一个服务器端轻松扩展它。试试在控制台中运行第二个 rpc\_server.php 。
* 在客户端，RPC请求只发送或接收一条消息。不需要像 queue\_declare 这样的异步调用。所以RPC客户端的单个请求只需要一个网络往返。

我们的代码依旧非常简单，而且没有试图去解决一些复杂（但是重要）的问题，如：

* 当没有服务器运行时，客户端如何作出反映。
* 客户端是否需要实现类似RPC超时的东西。
* 如果服务器发生故障，并且抛出异常，应该被转发到客户端吗？
* 在处理前，防止混入无效的信息（例如检查边界）

> 如果你想做一些实验，你会发现[management UI](http://www.rabbitmq.com/management.html)在观测队列方面是很有用处的。

\[5]:<http://zh.wikipedia.org/wiki/面条式代码>