Hyperf框架基于JsonRpc与Consul的微服务搭建

依赖的组件

hyperf/json-rpc
hyperf/rpc-client
hyperf/rpc-server
hyperf/service-governance
hyperf/consul


以 HTTP协议 为例

json-rpc 即为基于json的rpc调用&＃xff0c;原理就是 A 和 B 拥有同一套 interface I 的定义&＃xff0c;A 就像调用自己的方法一样调用B的方法F&＃xff0c;当然F必须是 insterface I 中的方法。

保存镜像

docker commit -p hyperf raoxiaoya/hyperf:v1


一、服务端

1.1、启动服务提供者容器

docker run --name hyperf-db -p 9503:9503 --network host -v /data/www/hyperf-db:/hyperf-db -it --entrypoint /bin/sh raoxiaoya/hyperf:v1
cd /
composer create-project hyperf/hyperf-skeleton hyperf-db
安装的时候选择 JSON-RPC cd /hyperf-db
composer require hyperf/consul
服务治理组件&＃xff0c;不然 publishTo 不会生效
composer require hyperf/service-governance 发布consul组件的配置到app
php bin/hyperf.php vendor:publish hyperf/consul


1.2、定义服务提供者

config/autoload/server.php

&＃39;servers&＃39; &＃61;> [[&＃39;name&＃39; &＃61;> &＃39;jsonrpc-http&＃39;,&＃39;type&＃39; &＃61;> Server::SERVER_HTTP,&＃39;host&＃39; &＃61;> &＃39;0.0.0.0&＃39;,&＃39;port&＃39; &＃61;> 9503,&＃39;sock_type&＃39; &＃61;> SWOOLE_SOCK_TCP,&＃39;callbacks&＃39; &＃61;> [SwooleEvent::ON_REQUEST &＃61;> [\Hyperf\JsonRpc\HttpServer::class, &＃39;onRequest&＃39;],],],
],


1.3、定义接口

app/JsonRpc/CalculatorServiceInterface.php

namespace App\JsonRpc;interface CalculatorServiceInterface
{public function add(int $a, int $b): int;
}

1.4、定义实现类

app/JsonRpc/CalculatorService.php

namespace App\JsonRpc;use Hyperf\RpcServer\Annotation\RpcService;/*** &＃64;RpcService(name&＃61;"CalculatorService", protocol&＃61;"jsonrpc-http", server&＃61;"jsonrpc-http", publishTo&＃61;"consul")*/
class CalculatorService implements CalculatorServiceInterface
{public function add(int $a, int $b): int{return $a &＃43; $b;}}


1.5、发布到服务中心

此地址为服务中心的地址&＃xff0c;在启动服务时&＃xff0c;Hyperf 会自动地将 &＃64;RpcService 定义了 publishTo 属性为 consul 的服务注册到服务中心去。

config/autoload/consul.php

return [&＃39;uri&＃39; &＃61;> &＃39;http://127.0.0.1:8500&＃39;,
];


二、客户端

2.1、启动服务消费者容器

docker run --name hyperf-api -p 9502:9502 --network host -v /data/www/hyperf-api:/hyperf-api -it --entrypoint /bin/sh raoxiaoya/hyperf:v1cd /
composer create-project hyperf/hyperf-skeleton hyperf-api
安装的时候选择 JSON-RPC cd /hyperf-api
composer require hyperf/consul


2.2、定义服务消费者

config/autoload/server.php

&＃39;servers&＃39; &＃61;> [[&＃39;name&＃39; &＃61;> &＃39;http&＃39;,&＃39;type&＃39; &＃61;> Server::SERVER_HTTP,&＃39;host&＃39; &＃61;> &＃39;0.0.0.0&＃39;,&＃39;port&＃39; &＃61;> 9502,&＃39;sock_type&＃39; &＃61;> SWOOLE_SOCK_TCP,&＃39;callbacks&＃39; &＃61;> [SwooleEvent::ON_REQUEST &＃61;> [Hyperf\HttpServer\Server::class, &＃39;onRequest&＃39;],],],
],


2.3、设置服务提供方地址&＃xff0c;注册中心的地址

config/autoload/services.php

declare(strict_types&＃61;1);
/*** This file is part of Hyperf.** &＃64;link https://www.hyperf.io* &＃64;document https://doc.hyperf.io* &＃64;contact group&＃64;hyperf.io* &＃64;license https://github.com/hyperf/hyperf/blob/master/LICENSE*/
return [&＃39;consumers&＃39; &＃61;> [[// name 需与服务提供者的 name 属性相同&＃39;name&＃39; &＃61;> &＃39;CalculatorService&＃39;,// 服务接口名&＃xff0c;可选&＃xff0c;默认值等于 name 配置的值&＃xff0c;如果 name 直接定义为接口类则可忽略此行配置&＃xff0c;如 name 为字符串则需要配置 service 对应到接口类&＃39;service&＃39; &＃61;> \App\JsonRpc\CalculatorServiceInterface::class,// 对应容器对象 ID&＃xff0c;可选&＃xff0c;默认值等于 service 配置的值&＃xff0c;用来定义依赖注入的 key&＃39;id&＃39; &＃61;> \App\JsonRpc\CalculatorServiceInterface::class,// 服务提供者的服务协议&＃xff0c;可选&＃xff0c;默认值为 jsonrpc-http// 可选 jsonrpc-http jsonrpc jsonrpc-tcp-length-check&＃39;protocol&＃39; &＃61;> &＃39;jsonrpc-http&＃39;,// 负载均衡算法&＃xff0c;可选&＃xff0c;默认值为 random&＃39;load_balancer&＃39; &＃61;> &＃39;random&＃39;,// 这个消费者要从哪个服务中心获取节点信息&＃xff0c;如不配置则不会从服务中心获取节点信息&＃39;registry&＃39; &＃61;> [&＃39;protocol&＃39; &＃61;> &＃39;consul&＃39;,&＃39;address&＃39; &＃61;> &＃39;http://127.0.0.1:8500&＃39;,],// 如果没有指定上面的 registry 配置&＃xff0c;即为直接对指定的节点进行消费&＃xff0c;通过下面的 nodes 参数来配置服务提供者的节点信息&＃39;nodes&＃39; &＃61;> [[&＃39;host&＃39; &＃61;> &＃39;127.0.0.1&＃39;, &＃39;port&＃39; &＃61;> 9503],],// 配置项&＃xff0c;会影响到 Packer 和 Transporter&＃39;options&＃39; &＃61;> [&＃39;connect_timeout&＃39; &＃61;> 5.0,&＃39;recv_timeout&＃39; &＃61;> 5.0,&＃39;settings&＃39; &＃61;> [// 根据协议不同&＃xff0c;区分配置&＃39;open_eof_split&＃39; &＃61;> true,&＃39;package_eof&＃39; &＃61;> "\r\n",// &＃39;open_length_check&＃39; &＃61;> true,// &＃39;package_length_type&＃39; &＃61;> &＃39;N&＃39;,// &＃39;package_length_offset&＃39; &＃61;> 0,// &＃39;package_body_offset&＃39; &＃61;> 4,],// 当使用 JsonRpcPoolTransporter 时会用到以下配置&＃39;pool&＃39; &＃61;> [&＃39;min_connections&＃39; &＃61;> 1,&＃39;max_connections&＃39; &＃61;> 32,&＃39;connect_timeout&＃39; &＃61;> 10.0,&＃39;wait_timeout&＃39; &＃61;> 3.0,&＃39;heartbeat&＃39; &＃61;> -1,&＃39;max_idle_time&＃39; &＃61;> 60.0,],],],],
];

2.4、定义接口&＃xff0c;同服务端保持一致

app/JsonRpc/CalculatorServiceInterface.php

namespace App\JsonRpc;interface CalculatorServiceInterface
{public function add(int $a, int $b): int;
}指的注意的是&＃xff0c;app/JsonRpc/CalculatorServiceInterface 接口应该发布到composer包&＃xff0c;被多个服务所依赖。

2.5、定义路由

Router::addRoute([&＃39;GET&＃39;], &＃39;/testRpc&＃39;, &＃39;App\Controller\IndexController&＃64;testRpc&＃39;);


2.7、控制器中调用

public function testRpc()
{$client &＃61; ApplicationContext::getContainer()->get(CalculatorServiceInterface::class);$res &＃61; $client->add(1, 2);return [&＃39;result&＃39; &＃61;> $res,];
}


三、安装consul服务

然而文档中并没有说明如何安装 Consul 服务&＃xff0c;以下对 Consul 做一个简单的安装。

docker pull consuldocker run --name&＃61;consul -p 8500:8500 -e CONSUL_BIND_INTERFACE&＃61;eth0 -d consul


访问页面
http://192.168.2.200:8500/

四、启动服务器

进入hyperf-db容器启动服务提供者

cd /hyperf-db
php bin/hyperf.php start


发现consul页面已经出来了一个services

进入hyperf-api容器启动服务消费者

cd /hyperf-api
php bin/hyperf.php start


访问接口
http://192.168.2.200:9502/testRpc

返回信息

{"result": 3
}


说明我们的服务已经搭建成功了。

优化的点

1、关于接口的管理

上面的示例中接口文件 app/JsonRpc/CalculatorServiceInterface.php 我是手动创建的&＃xff0c;在实际应用中&＃xff0c;或有很多个接口文件&＃xff0c;且被不同的人管理&＃xff0c;那么在这rpc架构中&＃xff0c;这些接口又被多个服务所依赖&＃xff0c;一旦接口被改动&＃xff0c;都需要同步到其他依赖的服务&＃xff0c;这是一件很抓狂的事情&＃xff0c;所以我们应该将所有的接口整合到一个composer包&＃xff0c;然后其他服务直接引入这个包&＃xff0c;如果接口有改动&＃xff0c;其他服务重新拉取即可。

创建composer包&＃xff1a;https://blog.csdn.net/raoxiaoya/article/details/107759887

在 client 和 server 中都执行 composer require phprao/composer-test&＃61;v1.0.1 下载接口。然后删掉原先的接口文件
app/JsonRpc/CalculatorServiceInterface.php 然后把引用的 namespace 改一下就可以使用了。