A simple json rpc framework example implemented in php, jsonrpc framework example

A simple json rpc framework example implemented in php, jsonrpc framework example_PHP tutorial

WBOY

Release： 2016-07-13 09:59:01

Original

1361 people have browsed it

A simple json rpc framework example implemented by php, jsonrpc framework example

json rpc is a remote calling service with json as the message format. It is a set of tools that allow running on Program implementation in different operating systems and environments is based on the specifications and a series of implementations of Internet process calls. This remote procedure call can use http as the transmission protocol or other transmission protocols. The transmitted content is the json message body.

Below we code a set of RPC framework based on PHP. This framework includes RPC server and application client;

(1) PHP server RPCserver jsonRPCServer.php

Copy code The code is as follows:
class jsonRPCServer {
/**
* Process a request class, which has some request parameters bound to it
* @param object $object
* @return boolean
*/
Public static function handle($object) {
// Determine whether it is an rpc json request
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);
//Execute the interface in the request class
         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' => }
// json format output
If (!empty($request['id'])) { // notifications don't want response
               header('content-type: text/javascript');
                    echo json_encode($response);
}
        return true;
}
}

(2) Rpc client, jsonRPCClient.php
Copy code The code is as follows: /*
*/
class jsonRPCClient {

private $debug;

private $url;
// Request 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 *****'."nn";
        $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;
        }
    }
}
?>

(三) 应用实例
（1）服务端 server.php
复制代码代码如下:
require_once 'jsonRPCServer.php';

复制代码代码如下:
// member 为测试类
require 'member.php';
// 服务端调用
$myExample = new member();
// 注入实例
jsonRPCServer::handle($myExample)
or print 'no request';
?>

（2）测试类文件，member.php
复制代码代码如下:
class member{
    public function getName(){
        return 'hello word ' ; // 返回字符串
    }
}

（3）客户端 client.php
复制代码代码如下:
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()).'
'."n";
}