JsonRPC 2.0 Client and Server

Lightweight, fast multi Json-RPC 2.0 client/server in php extension, base on multi_curl and epoll of the Client. Coroutine in async of writeback, just look like the sync of php response and it is. Jsonrpc_Server support php-fpm or swoole Compliance http://www.jsonrpc.org/ protocol specification. 中文

jsonrpc in php7

Features

• JSON-RPC 2.0 protocol
• Base on curl and epoll of the multi client
• Persistent epoll in php-fpm
• Persistent curl_multi queue in php-fpm
• Default use JSON parse/generate library YAJL
• Support message and notification
• Linux only(need to epoll)

Requirement

• PHP 5.3.*
• PHP 5.4.*
• PHP 5.5.*
• PHP 5.6.*

Install

$/path/to/phpize
$./configure --with-php-config=/path/to/php-config
$make && make install

Server

Interface

• Jsonrpc_Server::__construct(mixed $payload, array $callbacks, array $classes)
• Jsonrpc_Server::register(string $name, mixed $closure)
• Jsonrpc_Server::bind(string $procedure, mixed $classname, string $method)
• Jsonrpc_Server::jsonformat()
• Jsonrpc_Server::rpcformat(mixed $payload)
• Jsonrpc_Server::executeprocedure(string $procedure, array $params)
• Jsonrpc_Server::executecallback(object $closure, array $params)
• Jsonrpc_Server::executemethod(string $class, string $method, array $params)
• Jsonrpc_Server::execute(boolean $response_type)

Register Function

<?php

$server = new Jsonrpc_Server();

// style one function variable
$add1 = function($a, $b){
  return $a + $b;
};
$server->register('addition1', $add1);

// style two function string
function add2($a, $b){
  return $a + $b;
}
$server->register('addition2', 'add2');

// style three function closure
$server->register('addition3', function ($a, $b) {
    return $a + $b;
});

//style four class method string
class Api 
{
  static public function add($a, $b)
  {
    return $a + $b;
  }
}
$server->register('addition4', 'Api::add');

echo $server->execute();

//output >>>
//{"jsonrpc":"2.0","id":null,"error":{"code":-32700,"message":"Parse error"}}

?>

Bind Method

<?php

$server = new Jsonrpc_Server();

class Api
{
  static public function add($a, $b)
  {
    return $a + $b;
  }

  public function newadd($a,$b){
    return $a + $b;
  }
}

$server->bind('addition5', 'Api', 'add');

$server->bind('addition6', $a=new Api, 'newadd');

echo $server->execute();

//output >>>
//{"jsonrpc":"2.0","id":null,"error":{"code":-32700,"message":"Parse error"}}

?>

swoole jsonrpc server

<?php

$http = new swoole_http_server("127.0.0.1", 9501);

function add($a, $b){
  return $a + $b;
}

$http->on('Request', function($request, $response){
  if ($request->server['request_uri'] == "/jsonrpc_server"){
    $payload = $request->rawContent();
    
    $jsr_server = new Jsonrpc_Server($payload);
    $jsr_server->register('addition', 'add');
    $res = $jsr_server->execute();
    $response->end($res);

    unset($payload);
    unset($jsr_server);
    unset($res);
  }else {
          $response->end("error");
  }
});
$http->start();
?>

Client

Interface

• Jsonrpc_Client::__construct(boolean $persist)
• Jsonrpc_Client::call(string $url, string $procedure, array $params, mixed $id)
• Jsonrpc_Client::connect(string $url)
• Jsonrpc_Client::__call(string $procedure, array $params)
• Jsonrpc_Client::execute(boolean $response_type)
• Jsonrpc_Client::authentication(string $username, string $password)
• Jsonrpc_Client::__destruct()

Persistent

Jsonrpc_client(1) When two resource epoll and curl_multi queue persist, the parame is 1. The default use of non-persistent.

Connect Call

<?php

$client = new Jsonrpc_Client(1);
$client->connect('http://localhost/server.php');
$client->addition1(3,5);
$result = $client->execute();

?>

Multi Call

<?php

$client = new Jsonrpc_Client(1);
$client->call('http://localhost/server.php', 'addition1', array(3,5));
$client->call('http://localhost/server.php', 'addition2', array(10,20));

/* ... */
$result = $client->execute();

var_dump($result);

//output >>>
/*
array(2) {
  [0]=>
  array(3) {
    ["jsonrpc"]=>
    string(3) "2.0"
    ["id"]=>
    int(110507766)
    ["result"]=>
    int(8)
  }
  [1]=>
  array(3) {
    ["jsonrpc"]=>
    string(3) "2.0"
    ["id"]=>
    int(1559316299)
    ["result"]=>
    int(30)
  }
  ...
}
*/
?>

Custom ID

<?php

$client = new Jsonrpc_client(1);
$client->call('http://localhost/server.php', 'addition', array(3,5),"custom_id_001");
$result = $client->execute();
var_dump($result);

//output >>>
/*
array(1) {
  [0]=>
  array(3) {
    ["jsonrpc"]=>
    string(3) "2.0"
    ["id"]=>
    string(13) "custom_id_001"
    ["result"]=>
    int(8)
  }
}
*/
?>

Authentication

<?php

$client = new Jsonrpc_Client(1);

$client->authentication("Username: username", "Password: password");

$client->call('http://localhost/server.php', 'addition1', array(3,5));
$result = $client->execute();

?>

YAJL generate/parse

Interface

• Jsonrpc_Yajl::generate(array $array)
• Jsonrpc_Yajl::parse(string $json)

generate

<?php

$arr = array(
    1,
    "string",
    array("key"=>"value")
);

var_dump(Jsonrpc_Yajl::generate($arr));

/* ==>output
string(28) "[1,"string",{"key":"value"}]";
*/

?>

parse

<?php

$str = '[1,"string",{"key":"value"}]';

var_dump(Jsonrpc_Yajl::parse($str));

/* ==>output
array(3) {
  [0]=>
  int(1)
  [1]=>
  string(6) "string"
  [2]=>
  array(1) {
    ["key"]=>
    string(5) "value"
  }
}
*/

?>

Error Info

jsonrpc 2.0 Error

// Parse error
{"jsonrpc":"2.0","id":null,"error":{"code":-32700,"message":"Parse error"}}

// Invalid Request
{"jsonrpc":"2.0","id":null,"error":{"code":-32600,"message":"Invalid Request"}}

// Method not found
{"jsonrpc":"2.0","id":null,"error":{"code":-32601,"message":"Method not found"}}

// Invalid params
{"jsonrpc":"2.0","id":null,"error":{"code":-32602,"message":"Invalid params"}}

//

HTTP Error

// 400
{"jsonrpc":"2.0","id":null,"error":{"code":-32400,"message":"Bad Request"}}
// 401
{"jsonrpc":"2.0","id":null,"error":{"code":-32401,"message":"Unauthorized"}}
// 403
{"jsonrpc":"2.0","id":null,"error":{"code":-32403,"message":"Forbidden"}}
// 404
{"jsonrpc":"2.0","id":null,"error":{"code":-32404,"message":"Not Found"}}

// 500
{"jsonrpc":"2.0","id":null,"error":{"code":-32500,"message":"Internal Server Error"}}
// 502
{"jsonrpc":"2.0","id":null,"error":{"code":-32502,"message":"Bad Gateway"}}
...

// unknow
{"jsonrpc":"2.0","id":null,"error":{"code":-32599,"message":"HTTP Unknow"}}

Curl Error

// 1 CURLE_UNSUPPORTED_PROTOCOL
{"jsonrpc":"2.0","id":null,"error":{"code":-32001,"message":"Curl Unsupported Protocol"}}

// 2 CURLE_FAILED_INIT
{"jsonrpc":"2.0","id":null,"error":{"code":-32002,"message":"Curl Failed Init"}}

// 3 CURLE_URL_MALFORMAT
{"jsonrpc":"2.0","id":null,"error":{"code":-32003,"message":"Curl Url Malformat"}}

// 4
{"jsonrpc":"2.0","id":null,"error":{"code":-32004,"message":"Curl Not Built In"}}

// 5 CURLE_COULDNT_RESOLVE_PROXY
{"jsonrpc":"2.0","id":null,"error":{"code":-32005,"message":"Curl Couldnt Resolve Proxy"}}

// 6 CURLE_COULDNT_RESOLVE_HOST
{"jsonrpc":"2.0","id":null,"error":{"code":-32006,"message":"Curl Couldnt Resolve Host"}}

// 7 CURLE_COULDNT_CONNECT
{"jsonrpc":"2.0","id":null,"error":{"code":-32007,"message":"Curl Couldnt Connect"}}
...

// CURL ERROR UNKNOW
{"jsonrpc":"2.0","id":null,"error":{"code":-32099,"message":"Curl Error Unknow"}}