快捷導(dǎo)航

詳解如何利用PHP實(shí)現(xiàn)RPC

更新時(shí)間：2022年04月21日 10:44:44 作者：PHP開源社區(qū)

RPC全稱為Remote Procedure Call，翻譯過來為“遠(yuǎn)程過程調(diào)用”。主流的平臺(tái)中都支持各種遠(yuǎn)程調(diào)用技術(shù)，以滿足分布式系統(tǒng)架構(gòu)中不同的系統(tǒng)之間的遠(yuǎn)程通信和相互調(diào)用。本文將利用PHP實(shí)現(xiàn)RPC，需要的可以參考一下

1.什么是RPC

RPC全稱為Remote Procedure Call，翻譯過來為“遠(yuǎn)程過程調(diào)用”。主流的平臺(tái)中都支持各種遠(yuǎn)程調(diào)用技術(shù)，以滿足分布式系統(tǒng)架構(gòu)中不同的系統(tǒng)之間的遠(yuǎn)程通信和相互調(diào)用。遠(yuǎn)程調(diào)用的應(yīng)用場(chǎng)景極其廣泛，實(shí)現(xiàn)的方式也各式各樣。

2.從通信協(xié)議的層面

基于HTTP協(xié)議的（例如基于文本的SOAP（XML）、Rest（JSON），基于二進(jìn)制Hessian（Binary））

基于TCP協(xié)議的（通常會(huì)借助Mina、Netty等高性能網(wǎng)絡(luò)框架）

3.從不同的開發(fā)語言和平臺(tái)層面

單種語言或平臺(tái)特定支持的通信技術(shù)(例如Java平臺(tái)的RMI、.NET平臺(tái)Remoting)

支持跨平臺(tái)通信的技術(shù)（例如HTTP Rest、Thrift等）

4.從調(diào)用過程來看

同步通信調(diào)用（同步RPC）

異步通信調(diào)用（MQ、異步RPC）

5.常見的幾種通信方式

遠(yuǎn)程數(shù)據(jù)共享（例如：共享遠(yuǎn)程文件，共享數(shù)據(jù)庫等實(shí)現(xiàn)不同系統(tǒng)通信）

消息隊(duì)列

RPC（遠(yuǎn)程過程調(diào)用）

6.php實(shí)現(xiàn)簡(jiǎn)單的rpc

1.目錄結(jié)構(gòu)

2.rpc服務(wù)端

<?php
/**
 * User: yuzhao
 * CreateTime: 2018/11/15 下午11:46
 * Description: Rpc服務(wù)端
 */
class RpcServer {

    /**
     * User: yuzhao
     * CreateTime: 2018/11/15 下午11:51
     * @var array
     * Description: 此類的基本配置
     */
    private $params = [
        'host'  => '',  // ip地址，列出來的目的是為了友好看出來此變量中存儲(chǔ)的信息
        'port'  => '', // 端口
        'path'  => '' // 服務(wù)目錄
    ];
    /**
     * User: yuzhao
     * CreateTime: 2018/11/16 上午12:14
     * @var array
     * Description: 本類常用配置
     */
    private $config = [
        'real_path' => '',
        'max_size'  => 2048 // 最大接收數(shù)據(jù)大小
    ];

    /**
     * User: yuzhao
     * CreateTime: 2018/11/15 下午11:50
     * @var nul
     * Description:
     */
    private $server = null;

    /**
     * Rpc constructor.
     */
    public function __construct($params)
{
        $this->check();
        $this->init($params);
    }

    /**
     * User: yuzhao
     * CreateTime: 2018/11/16 上午12:0
     * Description: 必要驗(yàn)證
     */
    private function check() {
        $this->serverPath();
    }

    /**
     * User: yuzhao
     * CreateTime: 2018/11/15 下午11:48
     * Description: 初始化必要參數(shù)
     */
    private function init($params) {
        // 將傳遞過來的參數(shù)初始化
        $this->params = $params;
        // 創(chuàng)建tcpsocket服務(wù)
        $this->createServer();
    }

    /**
     * User: yuzhao
     * CreateTime: 2018/11/16 上午12:0
     * Description: 創(chuàng)建tcpsocket服務(wù)

     */
    private function createServer() {
        $this->server = stream_socket_server("tcp://{$this->params['host']}:{$this->params['port']}", $errno,$errstr);
        if (!$this->server) exit([
            $errno,$errstr
        ]);
    }

    /**
     * User: yuzhao
     * CreateTime: 2018/11/15 下午11:57
     * Description: rpc服務(wù)目錄
     */
    public function serverPath() {
        $path = $this->params['path'];
        $realPath = realpath(__DIR__ . $path);
        if ($realPath === false ||!file_exists($realPath)) {
            exit("{$path} error!");
        }
        $this->config['real_path'] = $realPath;
    }

    /**
     * User: yuzhao
     * CreateTime: 2018/11/15 下午11:51
     * Description: 返回當(dāng)前對(duì)象
     */
    public static function instance($params) {
        return new RpcServer($params);
    }

    /**
     * User: yuzhao
     * CreateTime: 2018/11/16 上午12:06
     * Description: 運(yùn)行
     */
    public function run() {
        while (true) {
            $client = stream_socket_accept($this->server);
            if ($client) {
                echo "有新連接\n";
                $buf = fread($client, $this->config['max_size']);
                print_r('接收到的原始數(shù)據(jù):'.$buf."\n");
                // 自定義協(xié)議目的是拿到類方法和參數(shù)(可改成自己定義的)
                $this->parseProtocol($buf,$class, $method,$params);
                // 執(zhí)行方法
                $this->execMethod($client, $class, $method, $params);
                //關(guān)閉客戶端
                fclose($client);
                echo "關(guān)閉了連接\n";
            }
        }
    }

    /**
     * User: yuzhao
     * CreateTime: 2018/11/16 上午12:19
     * @param $class
     * @param $method
     * @param $params
     * Description: 執(zhí)行方法
     */
    private function execMethod($client, $class, $method, $params) {
        if($class && $method) {
            // 首字母轉(zhuǎn)為大寫
            $class = ucfirst($class);
            $file = $this->params['path'] . '/' . $class . '.php';
            //判斷文件是否存在，如果有，則引入文件
            if(file_exists($file)) {
                require_once $file;
                //實(shí)例化類，并調(diào)用客戶端指定的方法
                $obj = new $class();
                //如果有參數(shù)，則傳入指定參數(shù)
                if(!$params) {
                    $data = $obj->$method();
                } else {
                    $data = $obj->$method($params);
                }
                // 打包數(shù)據(jù)
                $this->packProtocol($data);
                //把運(yùn)行后的結(jié)果返回給客戶端
                fwrite($client, $data);
            }
        } else {
            fwrite($client, 'class or method error');
        }
    }

    /**
     * User: yuzhao
     * CreateTime: 2018/11/16 上午12:10
     * Description: 解析協(xié)議
     */
    private function parseProtocol($buf, &$class, &$method, &$params) {
        $buf = json_decode($buf, true);
        $class = $buf['class'];
        $method = $buf['method'];
        $params = $buf['params'];
    }

    /**
     * User: yuzhao
     * CreateTime: 2018/11/16 上午12:30
     * @param $data
     * Description: 打包協(xié)議
     */
    private function packProtocol(&$data) {
        $data = json_encode($data, JSON_UNESCAPED_UNICODE);
    }

}

RpcServer::instance([
    'host'  => '127.0.0.1',
    'port'  => 8888,
    'path'  => './api'
])->run();

3.rpc 客戶端

<?php
/**
 * User: yuzhao
 * CreateTime: 2018/11/16 上午12:2
 * Description: Rpc客戶端
 */
class RpcClient {

    /**
     * User: yuzhao
     * CreateTime: 2018/11/16 上午12:21
     * @var array
     * Description: 調(diào)用的地址
     */
    private $urlInfo = array();

    /**
     * RpcClient constructor.
     */
    public function __construct($url)
{
        $this->urlInfo = parse_url($url);
    }

    /**
     * User: yuzhao
     * CreateTime: 2018/11/16 上午12:2
     * Description: 返回當(dāng)前對(duì)象
     */
    public static function instance($url) {
        return new RpcClient($url);
    }

    public function __call($name, $arguments)
{
        // TODO: Implement __call() method.
        //創(chuàng)建一個(gè)客戶端
        $client = stream_socket_client("tcp://{$this->urlInfo['host']}:{$this->urlInfo['port']}", $errno, $errstr);
        if (!$client) {
            exit("{$errno} : {$errstr} \n");
        }
        $data = [
            'class'  => basename($this->urlInfo['path']),
            'method' => $name,
            'params' => $arguments
        ];
        //向服務(wù)端發(fā)送我們自定義的協(xié)議數(shù)據(jù)
        fwrite($client, json_encode($data));
        //讀取服務(wù)端傳來的數(shù)據(jù)
        $data = fread($client, 2048);
        //關(guān)閉客戶端
        fclose($client);
        return $data;
    }
}
$cli = new RpcClient('http://127.0.0.1:8888/test');
echo $cli->tuzisir1()."\n";
echo $cli->tuzisir2(array('name' => 'tuzisir', 'age' => 23));

4.提供服務(wù)的文件

<?php
/**
 * User: yuzhao
 * CreateTime: 2018/11/16 上午12:28
 * Description:
 */

class Test {

    public function tuzisir1() {
        return '我是無參方法';
    }
    public function tuzisir2($params) {
        return $params;
    }
}