README-cn.md · OSCHINA-MIRROR/rryqszq4-JsonRPC

JsonRPC 2.0 Client and Server

Описание:

Лёгкий, высокопроизводительный PHP-расширение для JsonRPC 2.0 клиента и сервера, основанный на параллельном клиенте multi_curl + epoll.

Клиент Jsonrpc_Client использует параллельный интерфейс libcurl для получения услуг, использует многопоточный ввод-вывод epoll для мониторинга событий ввода-вывода curl, использует сопрограммы для синхронного возврата данных RPC, но на самом деле асинхронный.

Сервер Jsonrpc_Server поддерживает php-fpm или swoole. Он соответствует спецификации протокола http://www.jsonrpc.org/.

English

jsonrpc in php7

Особенности:

JSON-RPC 2.0 протокол;
Параллельный клиент с использованием curl и epoll;
Персистентность epoll в php-fpm;
Персистентность очереди curl_multi в php-fpm;
По умолчанию используется YAJL для разбора JSON;
Сервер поддерживает запросы и уведомления;
Работает на Linux системах (требуется поддержка epoll).

PHP окружение:

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

Установка:

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

Сервер: Интерфейс:

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).

Регистрация функций:

<?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();

?>

Привязка методов:

<?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();

?>

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_client->execute();
    $response->end($res);

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

Клиент: Интерфейс:

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().

Персистентность:

Jsonrpc_client(1) параметр равен 1, тогда ресурсы epoll и curl_multi будут сохраняться, по умолчанию не сохраняется.

Прямой вызов:

<?php

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

?>

Параллельный вызов:

<?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);

?>
``` **jsonrpc** =>
  строка(3) "2.0"
  **id** =>
  int(110507766)
  **result** =>
  int(8)
}
[1]=>
array(3) {
  **jsonrpc** =>
  строка(3) "2.0"
  **id** =>
  int(1559316299)
  **result** =>
  int(30)
}
...
}

**Пользовательский 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** =>
    строка(3) "2.0"
    **id** =>
    строка(13) "custom_id_001"
    **result** =>
    int(8)
  }
}

YAJL генерация / анализ

Интерфейс

Jsonrpc_Yajl::generate(массив $array)
Jsonrpc_Yajl::parse(строка $json)

Генерация

$arr = массив(
    1,
    "string",
    массив("key" => "value")
);

var_dump(Jsonrpc_Yajl::generate($arr));
/* ==>output
string(28) "[1,"string",{"key":"value"}]";
*/
?>

Анализ

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

var_dump(Jsonrpc_Yajl::parse($str));
/* ==>output
массив(3) {
  [0]=>
  int(1)
  [1]=>
  строка(6) "string"
  [2]=>
  массив(1) {
    **"key"** =>
    строка(5) "value"
  }
}
*/

Частые ошибки

Ошибки jsonrpc 2.0

// синтаксическая ошибка
{"jsonrpc":"2.0","id":null,"error":{"code":-32700,"message":"Parse error"}}

// неверный запрос
{"jsonrpc":"2.0","id":null,"error":{"code":-32600,"message":"Invalid Request"}}

// метод не найден
{"jsonrpc":"2.0","id":null,"error":{"code":-32601,"message":"Method not found"}}

// неверные параметры
{"jsonrpc":"2.0","id":null,"error":{"code":-32602,"message":"Invalid params"}}

HTTP-ошибки

// 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"}}
...

// неизвестно
{"jsonrpc":"2.0","id":null,"error":{"code":-32599,"message":"HTTP Unknow"}}

Curl-ошибки

// 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"}}

OSCHINA-MIRROR/rryqszq4-JsonRPC

YAJL генерация / анализ

Частые ошибки

Опубликовать ( 0 )

Введение

Обновления

Участники

Недавние действия

OSCHINA-MIRROR/rryqszq4-JsonRPC .gitee-modal { min-width: 500px !important; } .gitee-modal .close { right: 0.6rem !important; }

YAJL генерация / анализ

Частые ошибки

Опубликовать ( 0 )

Введение

Обновления

Участники

Недавние действия

OSCHINA-MIRROR/rryqszq4-JsonRPC