基于多路复用的 RPC 组件

本组件基于 TCP 协议，多路复用的设计借鉴于 AMQP 组件。

安装

  1. composer require hyperf/rpc-multiplex

Server 配置

修改 config/autoload/server.php 配置文件，以下配置删除了不相干的配置。

settings 设置中，分包规则不允许修改，只可以修改 package_max_length，此配置需要 Server 和 Client 保持一致。

  1. <?php
  3. declare(strict_types=1);
  5. use Hyperf\Server\Event;
  6. use Hyperf\Server\Server;
  8. return [
  9.     'servers' => [
  10.         [
  11.             'name' => 'rpc',
  12.             'type' => Server::SERVER_BASE,
  13.             'host' => '0.0.0.0',
  14.             'port' => 9502,
  15.             'sock_type' => SWOOLE_SOCK_TCP,
  16.             'callbacks' => [
  17.                 Event::ON_RECEIVE => [Hyperf\RpcMultiplex\TcpServer::class, 'onReceive'],
  18.             ],
  19.             'settings' => [
  20.                 'open_length_check' => true,
  21.                 'package_length_type' => 'N',
  22.                 'package_length_offset' => 0,
  23.                 'package_body_offset' => 4,
  24.                 'package_max_length' => 1024 * 1024 * 2,
  25.             ],
  26.         ],
  27.     ],
  28. ];

创建 RpcService

  1. <?php
  3. namespace App\RPC;
  5. use App\JsonRpc\CalculatorServiceInterface;
  6. use Hyperf\RpcMultiplex\Constant;
  7. use Hyperf\RpcServer\Annotation\RpcService;
  9. /**
  10.  * @RpcService(name="CalculatorService", server="rpc", protocol=Constant::PROTOCOL_DEFAULT)
  11.  */
  12. class CalculatorService implements CalculatorServiceInterface
  13. {
  14. }

客户端配置

修改 config/autoload/services.php 配置文件

  1. <?php
  3. declare(strict_types=1);
  5. return [
  6.     'consumers' => [
  7.         [
  8.             'name' => 'CalculatorService',
  9.             'service' => App\JsonRpc\CalculatorServiceInterface::class,
  10.             'id' => App\JsonRpc\CalculatorServiceInterface::class,
  11.             'protocol' => Hyperf\RpcMultiplex\Constant::PROTOCOL_DEFAULT,
  12.             'load_balancer' => 'random',
  13.             // 这个消费者要从哪个服务中心获取节点信息，如不配置则不会从服务中心获取节点信息
  14.             'registry' => [
  15.                 'protocol' => 'consul',
  16.                 'address' => 'http://127.0.0.1:8500',
  17.             ],
  18.             'nodes' => [
  19.                 ['host' => '127.0.0.1', 'port' => 9502],
  20.             ],
  21.             'options' => [
  22.                 'connect_timeout' => 5.0,
  23.                 'recv_timeout' => 5.0,
  24.                 'settings' => [
  25.                     // 包体最大值，若小于 Server 返回的数据大小，则会抛出异常，故尽量控制包体大小
  26.                     'package_max_length' => 1024 * 1024 * 2,
  27.                 ],
  28.                 // 重试次数，默认值为 2
  29.                 'retry_count' => 2,
  30.                 // 重试间隔，毫秒
  31.                 'retry_interval' => 100,
  32.                 // 多路复用客户端数量
  33.                 'client_count' => 4,
  34.                 // 心跳间隔 非 numeric 表示不开启心跳
  35.                 'heartbeat' => 30,
  36.             ],
  37.         ],
  38.     ],
  39. ];

注册中心

如果需要使用注册中心，则需要手动添加以下监听器

  1. <?php
  2. return [
  3.     Hyperf\RpcMultiplex\Listener\RegisterServiceListener::class,
  4. ];