PHP创建简单RPC服务案例详解

RPC（Remote Procedure Call）远程过程调用，常见的用途是通过网络将一些数据发送到远程服务端，服务端对数据进行处理并返回处理结果。

PHP可以用各种方式实现RPC服务，比如使用PHP内置的SOAP、JSON-RPC、XmlRpc等等。其中，我们以JSON-RPC为例，介绍如何搭建一个简单的PHP RPC服务。

步骤一：安装必要的组件

要使用PHP生成JSON-RPC服务器，需要安装以下软件包：

• PHP JSON模块
• Composer

步骤二：创建一个PHP类作为RPC服务

创建一个PHP类，并在类中添加RPC方法，该方法将检索在请求中传递的参数，并返回处理结果。例如，以下是一个示例类：

<?php
class Calculator {
    /**
     * @param int $a
     * @param int $b
     * @return int
     */
    public function add($a, $b)
    {
        return $a + $b;
    }
}

以上是一个简单的计算器类，其中添加了一个名为“add”的方法。可以看出，该方法将接受两个整数参数，并返回它们的和。

步骤三：安装JSON-RPC服务类

我们需要使用Composer，来安装一个PHP JSON-RPC类库，比如“paulgibbs/json-rpc”。

在终端执行以下命令来安装该类库：

composer require paulgibbs/json-rpc

步骤四：创建PHP JSON-RPC服务器

现在，我们需要实例化该类、创建一个服务器对象，并添加我们刚才创建的类：

<?php
require_once 'vendor/autoload.php';
require_once 'Calculator.php';

$server = new \JsonRpc\Server();
$calculator = new Calculator();
$server->addService('Calculator', $calculator);

以上代码通过autoload自动加载了该类库，并创建了一个JsonRpc Server对象，并添加了Calculator类。JsonRpc服务器将接受JSON-RPC请求，并自动处理该请求。

步骤五：使用POST请求发送JSON-RPC请求

现在，通过为JSON-RPC请求创建一个POST请求，我们可以将请求发送到服务器。请求必须以JSON格式发送。例如，如果我们想为先前添加的“add”方法发送一个JSON-RPC请求，可以使用以下示例代码：

<?php
$data = [
    'jsonrpc' => '2.0',
    'method' => 'Calculator.add',
    'params' => [2,2],
    'id' => 0
];

$ch = curl_init();
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_URL, 'http://localhost:9000');
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($data));
$result = curl_exec($ch);
curl_close($ch);
echo $result;

以上代码 创建一个 $data 数组，用于存储JSON-RPC请求的一些基本信息，比如要运行的方法名称、参数和请求ID等等。然后，使用cURL库将POST请求发送到服务器。最后输出请求的结果。

运行上述代码，将会产生如下输出：

{"jsonrpc":"2.0","id":0,"result":4}

我们可以看到请求的结果是4，这是上面请求发送的两个参数的和。

示例说明

下面我们通过两个实际的例子说明一下如何使用PHP创建JSON-RPC服务：

示例1：调用放映机

假设我们想创建一个简单的JSON-RPC服务，该服务将运行以下实际任务之一：

• 播放电影
• 暂停电影
• 停止电影

为了实现这个任务，我们创建了一个名为“Player”的PHP类，并添加三个方法：play、pause和stop。以下是该类的代码：

<?php
class Player {
    /**
     * 播放电影方法
     * @param string $movie
     * @return bool
     */
    public function play($movie)
    {
        echo "正在播放{$movie}...\n";
        return true;
    }

    /**
     * 暂停方法
     * @return bool
     */
    public function pause()
    {
        echo "暂停...\n";
        return true;
    }

    /**
     * 停止方法
     * @return bool
     */
    public function stop()
    {
        echo "停止...\n";
        return true;
    }
}

接着，我们实例化该类、创建一个服务器对象，并添加我们刚才创建的类。以下是服务器代码的示例：

<?php
use JsonRpc\Server;

require_once __DIR__ . "/vendor/autoload.php";
require_once __DIR__ . "/Player.php";

$server = new Server();
$player = new Player();
$server->addService('Player', $player);
$server->reply();

我们使用“JsonRpc\Server”的命名空间创建了服务器对象，执行了“Player”类的实例化，并将该对象添加到服务器中。最后，我们使用“reply”方法处理接收到的JSON-RPC请求。

可以使用以下代码使用cURL发送JSON-RPC请求：

<?php

$data = [
    'jsonrpc' => '2.0',
    'method' => 'Player.play',
    'params' => ['变形金刚'],
    'id' => 1
];

$ch = curl_init();
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POST,true);
curl_setopt($ch, CURLOPT_URL, 'http://localhost:9000');
curl_setopt($ch, CURLOPT_POSTFIELDS,json_encode($data));
$result = curl_exec($ch);
curl_close($ch);
echo $result;

执行以上代码将会输出：

正在播放变形金刚...
{"jsonrpc":"2.0","id":1,"result":true}

我们可以看到，请求被处理，并返回了“true”。

示例2：自动化测试

假设我们有一个简单的自动化测试套件中的测试用例需要执行，我们可以将测试用例包装在JSON-RPC请求中，并将其发送到测试服务器。测试服务器应返回关于测试结果的JSON-RPC响应。

为了实现这个任务，我们创建了一个名为“TestRunner”的PHP类，并添加一个名为“run”的方法。以下是该类的代码：

<?php
class TestRunner {
    /**
     * 运行测试用例
     * @param string $suite
     * @param string $testcase
     * @return string
     */
    public function run($suite, $testcase)
    {
        require_once __DIR__ . "/{$suite}/{$testcase}.php";
        return "运行测试用例{$testcase}完毕。";
    }
}

接着，我们实例化该类、创建一个服务器对象，并添加我们刚才创建的类。以下是服务器代码的示例：

<?php
use JsonRpc\Server;

require_once __DIR__ . "/vendor/autoload.php";
require_once __DIR__ . "/TestRunner.php";

$server = new Server();
$runner = new TestRunner();
$server->addService('TestRunner', $runner);
$server->reply();

我们使用“JsonRpc\Server”的命名空间创建了服务器对象，执行了“TestRunner”类的实例化，并将该对象添加到服务器中。最后，我们使用“reply”方法处理接收到的JSON-RPC请求。

可以使用以下代码使用cURL发送JSON-RPC请求：

<?php
$data = [
    'jsonrpc' => '2.0',
    'method' => 'TestRunner.run',
    'params' => ['test','testcase'],
    'id' => 1
];

$ch = curl_init();
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POST,true);
curl_setopt($ch, CURLOPT_URL, 'http://localhost:9000');
curl_setopt($ch, CURLOPT_POSTFIELDS,json_encode($data));
$result = curl_exec($ch);
curl_close($ch);
echo $result;

执行以上代码将会输出：

运行测试用例testcase完毕。
{"jsonrpc":"2.0","id":1,"result":"\u8fd0\u884c\u6d4b\u8bd5\u7528\u4f8btestcase\u5b8c\u6bd5\u3002"}

我们可以看到，请求被处理，并返回了测试结果。