官网地址 | 中文版协议规范 | GitHub

轻量级,高性能 JsonRPC 2.0 客户端和服务端的php扩展，基于 multi_curl + epoll的并行客户端。Jsonrpc_Client使用libcurl库的并行接口调取服务，使用IO多路复用的epoll去监听curl的IO事件，使用协程可以同步返回rpc的数据，但底层其实是异步的。Jsonrpc_Server支持php-fpm或swoole。遵守http://www.jsonrpc.org/协议规范。 English

特性

  • JSON-RPC 2.0协议规范
  • 并发curl与epoll结合的并行客户端
  • php-fpm中持久化epoll
  • php-fpm中持久化curl_multi队列
  • 默认使用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,arraypayload,arraycallbacks, array $classes)
  • Jsonrpc_Server::register(string name,mixedname,mixedclosure)
  • Jsonrpc_Server::bind(string procedure,mixedprocedure,mixedclassname, string $method)
  • Jsonrpc_Server::jsonformat()
  • Jsonrpc_Server::rpcformat(mixed $payload)
  • Jsonrpc_Server::executeprocedure(string procedure,arrayprocedure,arrayparams)
  • Jsonrpc_Server::executecallback(object closure,arrayclosure,arrayparams)
  • Jsonrpc_Server::executemethod(string class,stringclass,stringmethod, array $params)
  • Jsonrpc_Server::execute(boolean $response_type)

注册函数

  1. <?php
  3. $server = new Jsonrpc_Server();
  5. // style one function variable
  6. $add1 = function($a, $b){
  7.     return $a + $b;
  8. };
  9. $server->register('addition1', $add1);
  11. // style two function string
  12. function add2($a, $b){
  13.   return $a + $b;
  14. }
  15. $server->register('addition2', 'add2');
  17. // style three function closure
  18. $server->register('addition3', function ($a, $b) {
  19.     return $a + $b;
  20. });
  22. //style four class method string
  23. class Api 
  24. {
  25.   static public function add($a, $b)
  26.   {
  27.     return $a + $b;
  28.   }
  29. }
  30. $server->register('addition4', 'Api::add');
  32. echo $server->execute();
  34. //output >>>
  35. //{"jsonrpc":"2.0","id":null,"error":{"code":-32700,"message":"Parse error"}}
  37. ?>

绑定方法

  1. <?php
  3. $server = new Jsonrpc_Server();
  5. class Api
  6. {
  7.   static public function add($a, $b)
  8.   {
  9.     return $a + $b;
  10.   }
  12.   public function newadd($a,$b){
  13.     return $a + $b;
  14.   }
  15. }
  17. $server->bind('addition5', 'Api', 'add');
  19. $server->bind('addition6', $a=new Api, 'newadd');
  21. echo $server->execute();
  23. //output >>>
  24. //{"jsonrpc":"2.0","id":null,"error":{"code":-32700,"message":"Parse error"}}
  26. ?>

swoole jsonrpc server

  1. <?php
  3. $http = new swoole_http_server("127.0.0.1", 9501);
  5. function add($a, $b){
  6.   return $a + $b;
  7. }
  9. $http->on('Request', function($request, $response){
  10.   if ($request->server['request_uri'] == "/jsonrpc_server"){
  11.     $payload = $request->rawContent();
  13.     $jsr_server = new Jsonrpc_Server($payload);
  14.     $jsr_server->register('addition', 'add');
  15.     $res = $jsr_server->execute();
  16.     $response->end($res);
  18.     unset($payload);
  19.     unset($jsr_server);
  20.     unset($res);
  21.   }else {
  22.           $response->end("error");
  23.   }
  24. });
  25. $http->start();
  26. ?>

客户端

接口

  • Jsonrpc_Client::__construct(boolean $persist)
  • Jsonrpc_Client::call(string url,stringurl,stringprocedure, array params,mixedparams,mixedid)
  • Jsonrpc_Client::connect(string $url)
  • Jsonrpc_Client::__call(string procedure,arrayprocedure,arrayparams)
  • Jsonrpc_Client::execute(boolean $response_type)
  • Jsonrpc_Client::authentication(string username,stringusername,stringpassword)
  • Jsonrpc_Client::__destruct()

持久化

Jsonrpc_client(1) 参数为1的时候，将epoll和curl_multi队列两个资源进行持久化，默认使用非持久化。

直接调用

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

并行调用

  1. <?php
  3. $client = new Jsonrpc_Client(1);
  4. $client->call('http://localhost/server.php', 'addition1', array(3,5));
  5. $client->call('http://localhost/server.php', 'addition2', array(10,20));
  7. /* ... */
  8. $result = $client->execute();
  10. var_dump($result);
  12. //output >>>
  13. /*
  14. array(2) {
  15.   [0]=>
  16.   array(3) {
  17.     ["jsonrpc"]=>
  18.     string(3) "2.0"
  19.     ["id"]=>
  20.     int(110507766)
  21.     ["result"]=>
  22.     int(8)
  23.   }
  24.   [1]=>
  25.   array(3) {
  26.     ["jsonrpc"]=>
  27.     string(3) "2.0"
  28.     ["id"]=>
  29.     int(1559316299)
  30.     ["result"]=>
  31.     int(30)
  32.   }
  33.   ...
  34. }
  35. */
  36. ?>

自定义 id

  1. <?php
  3. $client = new Jsonrpc_client(1);
  4. $client->call('http://localhost/server.php', 'addition', array(3,5),"custom_id_001");
  5. $result = $client->execute();
  6. var_dump($result);
  8. //output >>>
  9. /*
  10. array(1) {
  11.   [0]=>
  12.   array(3) {
  13.     ["jsonrpc"]=>
  14.     string(3) "2.0"
  15.     ["id"]=>
  16.     string(13) "custom_id_001"
  17.     ["result"]=>
  18.     int(8)
  19.   }
  20. }
  21. */
  22. ?>

YAJL 生成/解析

Interface

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

生成

  1. <?php
  3. $arr = array(
  4.     1,
  5.     "string",
  6.     array("key"=>"value")
  7. );
  9. var_dump(Jsonrpc_Yajl::generate($arr));
  11. /* ==>output
  12. string(28) "[1,"string",{"key":"value"}]";
  13. */
  15. ?>

解析

  1. <?php
  3. $str = '[1,"string",{"key":"value"}]';
  5. var_dump(Jsonrpc_Yajl::parse($str));
  7. /* ==>output
  8. array(3) {
  9.   [0]=>
  10.   int(1)
  11.   [1]=>
  12.   string(6) "string"
  13.   [2]=>
  14.   array(1) {
  15.     ["key"]=>
  16.     string(5) "value"
  17.   }
  18. }
  19. */
  21. ?>

常见错误信息

jsonrpc 2.0 错误信息

  1. // 语法解析错误
  2. {"jsonrpc":"2.0","id":null,"error":{"code":-32700,"message":"Parse error"}}
  4. // 无效请求
  5. {"jsonrpc":"2.0","id":null,"error":{"code":-32600,"message":"Invalid Request"}}
  7. // 找不到方法
  8. {"jsonrpc":"2.0","id":null,"error":{"code":-32601,"message":"Method not found"}}
  10. // 无效的参数
  11. {"jsonrpc":"2.0","id":null,"error":{"code":-32602,"message":"Invalid params"}}
  13. //

HTTP协议错误信息

  1. // 400
  2. {"jsonrpc":"2.0","id":null,"error":{"code":-32400,"message":"Bad Request"}}
  3. // 401
  4. {"jsonrpc":"2.0","id":null,"error":{"code":-32401,"message":"Unauthorized"}}
  5. // 403
  6. {"jsonrpc":"2.0","id":null,"error":{"code":-32403,"message":"Forbidden"}}
  7. // 404
  8. {"jsonrpc":"2.0","id":null,"error":{"code":-32404,"message":"Not Found"}}
  10. // 500
  11. {"jsonrpc":"2.0","id":null,"error":{"code":-32500,"message":"Internal Server Error"}}
  12. // 502
  13. {"jsonrpc":"2.0","id":null,"error":{"code":-32502,"message":"Bad Gateway"}}
  14. ...
  16. // unknow
  17. {"jsonrpc":"2.0","id":null,"error":{"code":-32599,"message":"HTTP Unknow"}}

curl错误信息

  1. // 1 CURLE_UNSUPPORTED_PROTOCOL
  2. {"jsonrpc":"2.0","id":null,"error":{"code":-32001,"message":"Curl Unsupported Protocol"}}
  4. // 2 CURLE_FAILED_INIT
  5. {"jsonrpc":"2.0","id":null,"error":{"code":-32002,"message":"Curl Failed Init"}}
  7. // 3 CURLE_URL_MALFORMAT
  8. {"jsonrpc":"2.0","id":null,"error":{"code":-32003,"message":"Curl Url Malformat"}}
  10. // 4
  11. {"jsonrpc":"2.0","id":null,"error":{"code":-32004,"message":"Curl Not Built In"}}
  13. // 5 CURLE_COULDNT_RESOLVE_PROXY
  14. {"jsonrpc":"2.0","id":null,"error":{"code":-32005,"message":"Curl Couldnt Resolve Proxy"}}
  16. // 6 CURLE_COULDNT_RESOLVE_HOST
  17. {"jsonrpc":"2.0","id":null,"error":{"code":-32006,"message":"Curl Couldnt Resolve Host"}}
  19. // 7 CURLE_COULDNT_CONNECT
  20. {"jsonrpc":"2.0","id":null,"error":{"code":-32007,"message":"Curl Couldnt Connect"}}
  21. ...
  23. // CURL ERROR UNKNOW
  24. {"jsonrpc":"2.0","id":null,"error":{"code":-32099,"message":"Curl Error Unknow"}}