> JSON RPC 是一种基于 JSON 格式的轻量级的 RPC 协议标准，易于使用和阅读。在 Hyperf 里由 hyperf/json-rpc 组件来实现，可自定义基于 HTTP 协议来传输，或直接基于 TCP 协议来传输。
> 服务有两种角色，一种是 服务提供者(ServiceProvider)，即为其它服务提供服务的服务，另一种是 服务消费者(ServiceConsumer)，即依赖其它服务的服务，一个服务既可能是 服务提供者(ServiceProvider)，同时又是 服务消费者(ServiceConsumer)。而两者直接可以通过 服务契约 来定义和约束接口的调用，在 Hyperf 里，可直接理解为就是一个 接口类(Interface)，通常来说这个接口类会同时出现在提供者和消费者下。
[TOC]
## 安装
~~~
composer require hyperf/json-rpc
~~~
> 该组件只是 JSON RPC 的协议处理的组件，通常来说，您仍需配合 hyperf/rpc-server 或 hyperf/rpc-client 来满足 服务端 和 客户端的场景，如同时使用则都需要安装：
> 要使用 JSON RPC 服务端：
~~~
composer require hyperf/rpc-server
~~~
> 要使用 JSON RPC 客户端：
~~~
composer require hyperf/rpc-client
~~~
## 提供者
### 定义服务提供者
> 此代码的 CalculatorServiceInterface不做展示，自行抽取定义
~~~
namespace App\JsonRpc;
use Hyperf\RpcServer\Annotation\RpcService;
/**
* 注意，如希望通过服务中心(consul)来管理服务，需在注解内增加 publishTo 属性
* @RpcService(name="CalculatorService", protocol="jsonrpc-http", server="jsonrpc-http")
* @RpcService2222(name="CalculatorService", protocol="jsonrpc-http", server="jsonrpc-http", publishTo="consul")
*/
class CalculatorService implements CalculatorServiceInterface
{
// 实现一个加法方法，这里简单的认为参数都是 int 类型
public function add(int $a, int $b): int
{
// 这里是服务方法的具体实现
return $a + $b;
}
}
~~~
### 配置JSON RPC服务端
> 配置文件：/config/server.php
> 本人仅展示jsonrpc-http方式，还支持jsonrpc、jsonrpc-tcp-length-check协议
~~~
use Hyperf\Server\Server;
use Hyperf\Server\SwooleEvent;
return [
// 这里省略了该文件的其它配置
'servers' => [
[
'name' => 'jsonrpc-http',
'type' => Server::SERVER_HTTP,
'host' => '0.0.0.0',
'port' => 9502,
'sock_type' => SWOOLE_SOCK_TCP,
'callbacks' => [
SwooleEvent::ON_REQUEST => [\Hyperf\JsonRpc\HttpServer::class, 'onRequest'],
],
],
],
];
~~~
## 消费者
> 一个 服务消费者(ServiceConsumer) 可以理解为就是一个客户端类，但在 Hyperf 里您无需处理连接和请求相关的事情，只需要进行一些鉴定配置即可。
### 创建消费者类
> 此代码的 CalculatorServiceInterface不做展示，自行从服务端代码处拷贝过来
~~~
namespace App\JsonRpc;
use Hyperf\RpcClient\AbstractServiceClient;
class CalculatorServiceConsumer extends AbstractServiceClient implements CalculatorServiceInterface
{
/**
* 定义对应服务提供者的服务名称
* @var string
*/
protected $serviceName = 'CalculatorService';
/**
* 定义对应服务提供者的服务协议
* @var string
*/
protected $protocol = 'jsonrpc-http';
public function add(int $a, int $b): int
{
return $this->__request(__FUNCTION__, compact('a', 'b'));
}
}
~~~
### 服务节点配置
> 需要在配置文件定义一个配置标记要从何服务中心获取节点信息，位于 /config/autoload/services.php
~~~
return [
'consumers' => [
[
// 对应消费者类的 $serviceName
'name' => 'CalculatorService',
// 这个消费者要从哪个服务中心获取节点信息，如不配置则不会从服务中心获取节点信息
//'registry' => [
// 'protocol' => 'consul',
// 'address' => 'http://127.0.0.1:8500',
//],
// 如果没有指定上面的 registry 配置，即为直接对指定的节点进行消费，通过下面的 nodes 参数来配置服务提供者的节点信息
'nodes' => [
['host' => '127.0.0.1', 'port' => 9504],
],
]
],
];
~~~
### 配置接口契约对应关系
> 通过注入 CalculatorServiceInterface 接口来使用服务端提供的方法，需在 /config/autoload/dependencies.php 内定义 CalculatorServiceInterface 和 CalculatorServiceConsumer 的关系
~~~
return [
App\JsonRpc\CalculatorServiceInterface::class => App\JsonRpc\CalculatorServiceConsumer::class,
];
~~~
### Controller中进行调用
~~~
declare(strict_types=1);
namespace App\Controller;
use App\JsonRpc\CalculatorServiceInterface;
use Hyperf\Di\Annotation\Inject;
class IndexController extends AbstractController
{
/**
* @Inject()
* @var CalculatorServiceInterface
*/
public $calculatorService;
public function index()
{
$number = $this->calculatorService->add(3, 6);
return [
'number' => $number,
];
}
}
~~~
## 发布到服务中心
### 安装Consul服务端
> 参考consul篇
### 服务端（提供者）：composer安装相关组件
~~~
composer require hyperf/consul
composer require hyperf/service-governance
~~~
### 服务端（提供者）：配置consul支持
> 配置文件： /config/autoload/consul.php
> 配置完成后，在启动服务时，Hyperf 会自动地将 @RpcService 定义了 publishTo 属性为 consul 的服务注册到服务中心去
~~~
return [
'uri' => 'http://127.0.0.1:8500',
];
~~~
### 客户端（消费者）：composer安装相关组件
~~~
composer require hyperf/consul
~~~
### 客户端（消费者）：配置使用consul查找
> 需要在配置文件定义一个配置标记要从何服务中心获取节点信息，位于 /config/autoload/services.php
~~~
return [
'consumers' => [
[
// 对应消费者类的 $serviceName
'name' => 'CalculatorService',
// 这个消费者要从哪个服务中心获取节点信息
'registry' => [
'protocol' => 'consul',
'address' => 'http://127.0.0.1:8500',
]
]
],
];
~~~
