hyperf中使用JSON RPC实现微服务的流程步骤
hyperf给我们提供了RPC的底层服务，我们并不需要去关心底层通讯细节和调用的过程。
hyperf通过定义接口，实现接口，启动RPC Server 提供接口服务。
我们只需要简单的写好几个类就可以实现一个简单RPC模块。
JSON RPC 服务
JSON RPC 是一种基于 JSON 格式的轻量级的 RPC 协议标准，易于使用和阅读。
在 Hyperf 里由 hyperf/json-rpc 组件来实现，可自定义基于 HTTP 协议来传输，或直接基于 TCP 协议来传输。
开始
hyperf2.1环境我已经安装好了，有兴趣的自行在本站搜索
安装hyperf/json-rpc 组件
composer require hyperf/json-rpcJSON RPC 服务端
composer require hyperf/rpc-serverJSON RPC 客户端：
composer require hyperf/rpc-client在app下新建JsonRpc目录
app/JsonRpc
定义接口文件
（在app/JsonRpc目录并新增CalculatorServiceInterface.php文件）
<?php
declare(strict_types=1);
namespace App\JsonRpc;
interface CalculatorServiceInterface
{
public function sum(int $v1, int $v2): array;
}
定义服务提供者
(在app/JsonRpc目录并新增CalculatorService.php)
目前仅支持通过注解的形式来定义 服务提供者(ServiceProvider)，后续迭代会增加配置的形式。
我们可以直接通过 @RpcService 注解对一个类进行定义即可发布这个服务了：
<?php
declare(strict_types=1);
namespace App\JsonRpc;
use Hyperf\RpcServer\Annotation\RpcService;
/**
* Class CalculatorService
* 注意，如希望通过服务中心来管理服务，需在注解内增加 publishTo 属性
* @package App\JsonRpc
* @RpcService(name="CalculatorService", protocol="jsonrpc", server="jsonrpc")
*/
class CalculatorService implements CalculatorServiceInterface
{
// 实现一个加法方法，这里简单的认为参数都是 int 类型
public function add(int $a, int $b): int
{
// 这里是服务方法的具体实现
return $a + $b;
}
}@RpcService 共有 4 个参数：
name 属性为定义该服务的名称，这里定义一个全局唯一的名字即可，Hyperf 会根据该属性生成对应的 ID 注册到服务中心去；
protocol 属性为定义该服务暴露的协议，目前仅支持 jsonrpc-http, jsonrpc, jsonrpc-tcp-length-check ，分别对应于 HTTP 协议和 TCP 协议下的两种协议，默认值为 jsonrpc-http，这里的值对应在 Hyperf\Rpc\ProtocolManager 里面注册的协议的 key，它们本质上都是 JSON RPC 协议，区别在于数据格式化、数据打包、数据传输器等不同。
server 属性为绑定该服务类发布所要承载的 Server，默认值为 jsonrpc-http，该属性对应 config/autoload/server.php 文件内 servers 下所对应的 name，这里也就意味着我们需要定义一个对应的 Server；
publishTo 属性为定义该服务所要发布的服务中心，目前仅支持 consul、nacos 或为空，为空时代表不发布该服务到服务中心去，但也就意味着您需要手动处理服务发现的问题，要使用此功能需安装 hyperf/service-governance 组件及对应的驱动依赖，具体可参考 服务注册 章节；
定义JSON RPC Server
<?php
declare(strict_types=1);
use Hyperf\Server\Server;
use Hyperf\Server\SwooleEvent;
return [
'mode' => SWOOLE_PROCESS,
'servers' => [
[
'name' => 'http',//这里的http服务是项目默认启动时供访问的服务
'type' => Server::SERVER_HTTP,
'host' => '0.0.0.0',
'port' => 9501,
'sock_type' => SWOOLE_SOCK_TCP,
'callbacks' => [
SwooleEvent::ON_REQUEST => [Hyperf\HttpServer\Server::class, 'onRequest'],
],
],
[
'name' => 'jsonrpc',//这里的服务是jsonrpc服务提供者的服务配置
'type' => Server::SERVER_BASE,
'host' => '0.0.0.0',
'port' => 9504,//这里的端口需要和消费者对应
'sock_type' => SWOOLE_SOCK_TCP,
'callbacks' => [
SwooleEvent::ON_RECEIVE => [\Hyperf\JsonRpc\TcpServer::class, 'onReceive'],
],
],
[
'name' => 'jsonrpc-http',//这个是jsonrpc-http服务提供者服务的配置
'type' => Server::SERVER_HTTP,
'host' => '0.0.0.0',
'port' => 9503,
'sock_type' => SWOOLE_SOCK_TCP,
'callbacks' => [
SwooleEvent::ON_REQUEST => [\Hyperf\JsonRpc\HttpServer::class, 'onRequest'],
],
],
],
'settings' => [
'enable_coroutine' => true,
'worker_num' => swoole_cpu_num(),
'pid_file' => BASE_PATH . '/runtime/hyperf.pid',
'open_tcp_nodelay' => true,
'max_coroutine' => 100000,
'open_http2_protocol' => true,
'max_request' => 100000,
'socket_buffer_size' => 2 * 1024 * 1024,
'buffer_output_size' => 2 * 1024 * 1024,
],
'callbacks' => [
SwooleEvent::ON_WORKER_START => [Hyperf\Framework\Bootstrap\WorkerStartCallback::class, 'onWorkerStart'],
SwooleEvent::ON_PIPE_MESSAGE => [Hyperf\Framework\Bootstrap\PipeMessageCallback::class, 'onPipeMessage'],
SwooleEvent::ON_WORKER_EXIT => [Hyperf\Framework\Bootstrap\WorkerExitCallback::class, 'onWorkerExit'],
],
];
定义服务消费者
一个 服务消费者(ServiceConsumer) 可以理解为就是一个客户端类，但在 Hyperf 里您无需处理连接和请求相关的事情，只需要进行一些鉴定配置即可。
由于我当前是单服务的。所以我的项目既是服务端，也是消费端
服务消费者官方给出两种方式：
1.自动创建代理消费者类
2.手动创建消费者类
由于我是测试。所以直接用1了
您可通过在 config/autoload/services.php 配置文件内进行一些简单的配置，即可通过动态代理自动创建消费者类
下面配置中，protocol，我使用的是jsonrpc，这里的配置需要和在定义服务提供者的时的注解的protocol参数一致,
如果是jsonrpc-http就得使用jsonrpc-http，否则会找不到协议而报错，或者也可以选择定义多个服务。
nodes配置项，就是你请求消费的服务端的服务ip和端口。
因为这里是单服务，所以ip使用本地ip即可。
端口要和server那边一样。
<?php
return [
'consumers' => [
[
// name 需与服务提供者的 name 属性相同
'name' => 'CalculatorService',
// 服务接口名，可选，默认值等于 name 配置的值，如果 name 直接定义为接口类则可忽略此行配置，如 name 为字符串则需要配置 service 对应到接口类
'service' => \App\JsonRpc\CalculatorServiceInterface::class,
// 对应容器对象 ID，可选，默认值等于 service 配置的值，用来定义依赖注入的 key
'id' => \App\JsonRpc\CalculatorServiceInterface::class,
// 服务提供者的服务协议，可选，默认值为 jsonrpc-http
// 可选 jsonrpc-http jsonrpc jsonrpc-tcp-length-check
'protocol' => 'jsonrpc',/**我这里使用的`jsonrpc`*/
// 负载均衡算法，可选，默认值为 random
'load_balancer' => 'random',
// 这个消费者要从哪个服务中心获取节点信息，如不配置则不会从服务中心获取节点信息
// 'registry' => [
// 'protocol' => 'consul',
// 'address' => 'http://127.0.0.1:8500',
// ],
// 如果没有指定上面的 registry 配置，即为直接对指定的节点进行消费，通过下面的 nodes 参数来配置服务提供者的节点信息
'nodes' => [
['host' => '127.0.0.1', 'port' => 9504],
],
// 配置项，会影响到 Packer 和 Transporter
'options' => [
'connect_timeout' => 5.0,
'recv_timeout' => 5.0,
'settings' => [
// 根据协议不同，区分配置
'open_eof_split' => true,
'package_eof' => "\r\n",
// 'open_length_check' => true,
// 'package_length_type' => 'N',
// 'package_length_offset' => 0,
// 'package_body_offset' => 4,
],
// 当使用 JsonRpcPoolTransporter 时会用到以下配置
'pool' => [
'min_connections' => 1,
'max_connections' => 32,
'connect_timeout' => 10.0,
'wait_timeout' => 3.0,
'heartbeat' => -1,
'max_idle_time' => 60.0,
],
],
]
],
];在应用启动时会自动创建客户端类的代理对象，并在容器中使用配置项 id 的值（如果未设置，会使用配置项 service 值代替）来添加绑定关系，
这样就和手工编写的客户端类一样，通过注入 CalculatorServiceInterface 接口来直接使用客户端。
当服务提供者使用接口类名发布服务名，在服务消费端只需要设置配置项 name 值为接口类名，不需要重复设置配置项 id 和 service。
配置到这里，就算配完了，我们来调用消费者接口，来测试一下消费服务端
在控制器中调用
/**
* @GetMapping(path="testrpc")
*/
public function testrpc()
{
$client = ApplicationContext::getContainer()->get(CalculatorServiceInterface::class);
$res = $client->add(10,20);
return $res;
}
效果图：
完
相关文章