Prinzip und Anwendung von JSON RPC basierend auf PHP

json rpc ist ein Remote-Aufrufdienst mit JSON als Nachrichtenformat. Dabei handelt es sich um eine Reihe von Spezifikationen und Verfahren, die es Programmen ermöglichen, die auf verschiedenen Betriebssystemen und in verschiedenen Umgebungen ausgeführt werden Prozessaufrufe. Eine Reihe von Implementierungen. Dieser Remoteprozeduraufruf kann http als Übertragungsprotokoll oder andere Übertragungsprotokolle verwenden, und der übertragene Inhalt ist der JSON-Nachrichtentext.

Nachfolgend programmieren wir eine Reihe von RPC-Frameworks auf Basis von PHP. Dieses Framework umfasst einen RPC-Server und einen Anwendungsclient >(1)

PHP-Server RPCserver jsonRPCServer.php

(2) Rpc-Client, jsonRPCClient.php

class jsonRPCServer {
    /**
     *处理一个request类，这个类中绑定了一些请求参数
     * @param object $object
     * @return boolean
     */
    public static function handle($object) {
       // 判断是否是一个rpc json请求
        if ($_SERVER['REQUEST_METHOD'] != 'POST' || empty($_SERVER['CONTENT_TYPE'])
            ||$_SERVER['CONTENT_TYPE'] != 'application/json') {
            return false;
        }
        // reads the input data
        $request = json_decode(file_get_contents('php://input'),true);
        // 执行请求类中的接口
        try {
            if ($result = @call_user_func_array(array($object,$request['method']),$request['params'])) {
                $response = array ( 'id'=> $request['id'],'result'=> $result,'error'=> NULL );
            } else {
                $response = array ( 'id'=> $request['id'], 'result'=> NULL,
                                        'error' => 'unknown method or incorrect parameters' );}
        } catch (Exception $e) {
            $response = array ('id' => $request['id'],'result' => NULL, 'error' =>$e->getMessage());
        }
       // json 格式输出
        if (!empty($request['id'])) { // notifications don't want response
            header('content-type: text/javascript');
            echo json_encode($response);
        }
        return true;
    }
}

(3) Anwendungsbeispiele (1) Server server.php

<?php /*
 */
class jsonRPCClient {

    private $debug;
    private $url;
    // 请求id
    private $id;
    private $notification = false;
    /**
     * @param $url
     * @param bool $debug
     */
    public function __construct($url,$debug = false) {
        // server URL
        $this->url = $url;
        // proxy
        empty($proxy) ? $this->proxy = '' : $this->proxy = $proxy;
        // debug state
        empty($debug) ? $this->debug = false : $this->debug = true;
        // message id
        $this->id = 1;
    }

    /**
     *
     * @param boolean $notification
     */
    public function setRPCNotification($notification) {
        empty($notification) ? $this->notification = false  : $this->notification = true;
    }

    /**
     * @param $method
     * @param $params
     * @return bool
     * @throws Exception
     */
    public function __call($method,$params) {
        // 检验request信息
        if (!is_scalar($method)) {
            throw new Exception('Method name has no scalar value');
        }
        if (is_array($params)) {
            $params = array_values($params);
        } else {
            throw new Exception('Params must be given as array');
        }

        if ($this->notification) {
            $currentId = NULL;
        } else {
            $currentId = $this->id;
        }

       // 拼装成一个request请求
        $request = array(  'method' => $method,  'params' => $params,'id' => $currentId);
        $request = json_encode($request);
        $this->debug && $this->debug.='***** Request *****'."\n".$request."\n".'***** End Of request *****'."\n\n";
        $opts = array ('http' => array (
                                    'method'  => 'POST',
                                    'header'  => 'Content-type: application/json',
                                    'content' => $request
        ));
        //  关键几部
        $context  = stream_context_create($opts);
		if ( $result = file_get_contents($this->url, false, $context)) {
            $response = json_decode($result,true);
		} else {
			throw new Exception('Unable to connect to '.$this->url);
		}
        // 输出调试信息
        if ($this->debug) {
            echo nl2br(($this->debug));
        }
        // 检验response信息
        if (!$this->notification) {
            // check
            if ($response['id'] != $currentId) {
                throw new Exception('Incorrect response id (request id: '.$currentId.', response id: '.$response['id'].')');
            }
            if (!is_null($response['error'])) {
                throw new Exception('Request error: '.$response['error']);
            }
            return $response['result'];

        } else {
            return true;
        }
    }
}
?>

(2) Testklassendatei, member.php

<?php <span style="white-space:pre">	require_once 'jsonRPCServer.php';

// member 为测试类
<span style="white-space:pre">	</span>require 'member.php';
<span style="white-space:pre">	</span>// 服务端调用
<span style="white-space:pre">	</span>$myExample = new member();
<span style="white-space:pre">	</span>// 注入实例
<span style="white-space:pre">	</span>jsonRPCServer::handle($myExample)
	or print 'no request';
?>

(3 ) client client.php

class member{
    public function getName(){
        return 'hello word ' ;  // 返回字符串
    }
}

Das Obige hat die Prinzipien und Anwendungen von JSON RPC basierend auf PHP vorgestellt, einschließlich seiner Aspekte. Ich hoffe, dass es für Freunde hilfreich sein wird, die sich für PHP-Tutorials interessieren.

require_once 'jsonRPCClient.php';

$url = 'http://localhost/rpc/server.php';
$myExample = new jsonRPCClient($url);

// 客户端调用
try {
	$name = $myExample->getName();
    echo $name ;
} catch (Exception $e) {
	echo nl2br($e->getMessage()).'<br>'."\n";
}