Thinkphp 专题/RPC

RPC

RPC（Remote Procedure Call Protocol）远程过程调用协议，它是一种通过网络从远程计算机程序上请求服务，而不需要了解底层网络技术的协议。RPC协议假定某些传输协议的存在，如TCP或UDP，为通信程序之间携带信息数据。在OSI网络通信模型中，RPC跨越了传输层和应用层。RPC使得开发包括网络分布式多程序在内的应用程序更加容易。

RPC采用客户机/服务器模式。请求程序就是一个客户机，而服务提供程序就是一个服务器。首先，客户机调用进程发送一个有进程参数的调用信息到服务进程，然后等待应答信息。在服务器端，进程保持睡眠状态直到调用信息的到达为止。当一个调用信息到达，服务器获得进程参数，计算结果，发送答复信息，然后等待下一个调用信息，最后，客户端调用进程接收答复信息，获得进程结果，然后调用执行继续进行。

ThinkPHP支持广泛的RPC协议，包括PHPRPC、HPRose、JsonRPC以及Yar。

PHPRPC支持

PHPRPC 是一个轻型的、安全的、跨网际的、跨语言的、跨平台的、跨环境的、跨域的、支持复杂对象传输的、支持引用参数传递的、支持内容输出重定向的、支持分级错误处理的、支持会话的、面向服务的高性能远程过程调用协议。目前该协议的最新版本为 3.0。详细的资料可以参考phprpc官网（ http://www.phprpc.org/zh_CN/）

ThinkPHP提供了对PHPRpc的服务端和客户端调用的支持（客户端是跨平台跨语言的，可以支持任何语言的调用）。

服务器端的实现非常简单，你只需要把控制器继承Think\Controller\RpcController类即可。

例如：

namespace Home\Controller;
use Think\Controller\RpcController;
class ServerController extends RpcController{
    public function test1(){
        return 'test1';
    }
    public function test2(){
        return 'test2';
    }
    private function test3(){
        return 'test3';
    }
    protected function test4(){
        return 'test3';
    }
}

这样，ServerController控制器就变成了一个PHPRpc服务端，请求地址为：

http://serverName/index.php/Home/Server

 

rpc客户端可以调用test1和test2方法。方法的返回值可以支持数组等PHPRpc支持的格式。

注意：如果设置了不同的URL模式的话，服务器端请求地址需要相应调整。

可以使用allowMethodList属性设置允许访问的方法列表，例如：

namespace Home\Controller;
use Think\Controller\RpcController;
class ServerController extends RpcController{
    protected $allowMethodList =    array('test1','test2');
    public function test1(){
        return 'test1';
    }
    public function test2(){
        return 'test2';
    }
    public function test3(){
        return 'test3';
    }
}

上面的设置表示只允许test1和test2方法被rpc客户端调用。

 

你可以采用多个控制器进行不同的PHPRpc Server端用于不同的需要。

如果要在ThinkPHP里面进行客户端调用，可以使用下面的代码：

namespace Home\Controller;
use Think\Controller;
class IndexController extends Controller {
    public function index(){
        Vendor('phpRPC.phprpc_client');
        $client = new \PHPRPC_Client('http://serverName/index.php/Home/Server');
        // 或者采用
        //$client = new \PHPRPC_Client();
        //$client->useService('http://serverName/index.php/Home/Server');
        $result = $client->test1();
    }
}

其中test1就是服务器端定义的方法。其他使用和PHP的方法调用一致。

Hprose支持

Hprose (High Performance Remote Object Service Engine) 是一个MIT开源许可的新型轻量级跨语言跨平台的面向对象的高性能远程动态通讯中间件。它支持众多语言，例如nodeJs, C++, .NET, Java, Delphi, Objective-C, ActionScript, JavaScript, ASP, PHP, Python, Ruby, Perl 等语言，通过 Hprose 可以在这些语言之间实现方便且高效的互通。

你可以认为它是 PHPRPC 的商业版本，但是它跟 PHPRPC 完全不同，hprose 协议是全新设计的，比 PHPRPC 更加高效，实现也完全是全部从头开始的，比 PHPRPC 更加易用。更多信息可以参考（http://www.hprose.com/）

ThinkPHP同样也提供了对Hprose的服务端和客户端调用的支持。

服务器端的使用和PHPRPC的区别只是把控制器继承Think\Controller\HproseController类即可，其他用法基本一致，例如：

namespace Home\Controller;
use Think\Controller\HproseController;
class ServerController extends HproseController{
    public function test1(){
        return 'test1';
    }
    public function test2(){
        return 'test2';
    }
}

我们可以进行一些hprose服务器端的参数设置，包括debug、crossDomain、P3P和get，设置方法如下：

 

namespace Home\Controller;
use Think\Controller\HproseController;
class ServerController extends HproseController{
    protected $crossDomain =    true;
    protected $P3P         =    true;
    protected $get         =    true;
    protected $debug       =    true;

    public function test1(){
        return 'test1';
    }
    public function test2(){
        return 'test2';
    }
}

采用ThinkPHP的Hprose的客户端调用示例如下：

 

采用ThinkPHP的Hprose的客户端调用示例如下：

namespace Home\Controller;
use Think\Controller;
class IndexController extends Controller {
    public function index(){
        vendor('Hprose.HproseHttpClient');
        $client = new \HproseHttpClient('http://serverName/index.php/Home/Server');
        // 或者采用
        //$client = new \HproseHttpClient();
        //$client->useService('http://serverName/index.php/Home/Server');
        $result = $client->test1();
    }
}

 

JsonRPC支持

json-rpc是基于json的跨语言远程调用协议，比xml-rpc、webservice等基于文本的协议传输数据格小；相对hessian、java-rpc等二进制协议便于调试、实现、扩展，是非常优秀的一种远程调用协议。

ThinkPHP3.2提供了对JsonRPC的服务器端和客户端调用支持，服务器端实现示例：

namespace Home\Controller;
use Think\Controller\JsonRpcController;
class ServerController extends JsonRpcController {
    public function index(){
        return 'Hello, JsonRPC!';
    }
    // 支持参数传入
    public function test($name=''){
        return "Hello, {$name}!";
    }
}

所有的public方法都可以用于远程调用，客户端调用方式如下：

 

namespace Home\Controller;
use Think\Controller;
class IndexController extends Controller {
    public function index(){
        vendor('jsonRPC.jsonRPCClient');
        $client = new \jsonRPCClient('http://serverName/index.php/Home/Server');
        $result = $client->index();
        var_dump($result); // 结果：Hello, JsonRPC!
        $result = $client->test('ThinkPHP');
        var_dump($result); // 结果：Hello, ThinkPHP!
    }
}

 

Yar支持

Yar (yet another RPC framework) 是一个PHP扩展的RPC框架, 和现有的RPC框架(xml-rpc, soap)不同, 这是一个轻量级的框架, 支持多种打包协议(msgpack, json, php), 并且最重要的一个特点是, 它是可并行化的。

要使用Yar支持首先需要安装Yar扩展，扩展下载地址： http://pecl.php.net/package/yar

Yar说明文档： http://hk2.php.net/manual/zh/book.yar.php

安装好扩展后，使用ThinkPHP就可以开发服务器端，示例如下：

namespace Home\Controller;
use Think\Controller\YarController;
class ServerController extends YarController {
    public function index(){
        return 'Hello, Yar RPC!';
    }
    public function hello($name=''){
        return 'Hello, {$name}!';
    }
}

 

Yar除了并行，还有一个亮点，通过GET方式可以查看到接口列表及注释。

客户端调用示例如下：

namespace Home\Controller;
use Think\Controller;
class IndexController extends Controller {
    public function index(){
        $client = new \Yar_client('http://serverName/index.php/Home/Server');
        $result = $client->index();
        var_dump($result); // 结果：Hello, Yar!
    }
}