RPC 组件配置及使用

配置

服务端配置

  1. <?php
  2. // 构造方法内用户可传入 节点管理器实现类(实现 `NodeManagerInterface` 接口的类) 默认为 `MemoryManager`
  3. $config = new \EasySwoole\Rpc\Config();
  5. /** 
  6.  * 服务端配置 
  7.  */
  8. // 设置服务名称
  9. $config->setServerName('User'); // 默认 EasySwoole
  11. // 设置节点id
  12. $config->setNodeId(\EasySwoole\Utility\Random::character(10)); // 可忽略 构造函数已经设置
  14. // 【必须设置】设置异常处理器，对 Service-Worker 和 AssistWorker 的异常进行处理，防止未捕获导致进程退出
  15. $config->setOnException(function (\Throwable $throwable) {
  17. });
  19. $serverConfig = $config->getServer();
  21. // 【必须设置】设置本机ip
  22. $serverConfig->setServerIp('127.0.0.1');
  24. // 设置工作进程数量
  25. $serverConfig->setWorkerNum(4);
  27. // 设置监听地址及端口
  28. $serverConfig->setListenAddress('0.0.0.0');
  29. $serverConfig->setListenPort('9600');
  31. // 设置服务端最大接受包大小
  32. $serverConfig->setMaxPackageSize(1024 * 1024 * 2);
  34. // 设置接收客户端数据时间
  35. $serverConfig->setNetworkReadTimeout(3);
  37. /**
  38.  * 广播设置
  39.  */
  40. $assistConfig = $config->getAssist();
  42. // 服务定时自刷新到节点管理器
  43. $assistConfig->setAliveInterval(5000);
  45. // 广播进程设置
  46. $serviceFinderConfig = $assistConfig->getUdpServiceFinder();
  48. // 监听地址和端口
  49. $serviceFinderConfig->setEnableListen(true);
  50. $serviceFinderConfig->setListenAddress('0.0.0.0');
  51. $serviceFinderConfig->setListenPort(9600);
  53. // 设置广播地址
  54. $serviceFinderConfig->setEnableBroadcast(true);
  55. $serviceFinderConfig->setBroadcastAddress(['127.0.0.1:9600', '127.0.0.1:9601']);
  56. $serviceFinderConfig->setBroadcastInterval(5000); // 5s 广播一次
  58. // 设置广播秘钥
  59. $serviceFinderConfig->setEncryptKey('EasySwoole');

广播配置需要在配置服务端时，进行配置。

客户端配置

  1. <?php
  2. // 构造方法内用户可传入 节点管理器实现类(实现 `NodeManagerInterface` 接口的类) 默认为 `MemoryManager`
  3. $config = new \EasySwoole\Rpc\Config();
  5. /** 
  6.  * 客户端设置
  7.  * 
  8.  * 如果只是暴露rpc服务 不进行调用别的rpc服务 可不用设置
  9.  */
  10. $clientConfig = $config->getClient();
  12. // 传输最大数据包大小
  13. $clientConfig->setMaxPackageSize(1024 * 1024 * 2);
  15. // 设置全局回调函数  成功及失败 $response->getStatus !== 0 全部为失败
  16. $clientConfig->setOnGlobalSuccess(function (\EasySwoole\Rpc\Protocol\Response $response){
  18. });
  19. $clientConfig->setOnGlobalFail(function (\EasySwoole\Rpc\Protocol\Response $response){
  21. });

注册服务

注册 rpc 服务

  1. <?php
  3. ###### 配置服务端 ######
  4. // 构造方法内用户可传入 节点管理器实现类(实现 `NodeManagerInterface` 接口的类) 默认为 `MemoryManager`
  5. $config = new \EasySwoole\Rpc\Config();
  6. // 设置服务名称
  7. $config->setServerName('User'); // 默认 EasySwoole
  8. // 设置节点id，可忽略，构造函数已经设置
  9. $config->setNodeId(\EasySwoole\Utility\Random::character(10)); // 
  11. // 【必须设置】设置异常处理器，对 Service-Worker 和 AssistWorker 的异常进行处理，防止未捕获导致进程退出
  12. $config->setOnException(function (\Throwable $throwable) {
  14. });
  16. $serverConfig = $config->getServer();
  18. // 【必须设置】设置本机ip
  19. $serverConfig->setServerIp('127.0.0.1');
  21. /** 
  22.  * 注册服务 
  23.  */
  24. $rpc = new \EasySwoole\Rpc\Rpc($config);
  26. // 创建 ServiceOne 服务 
  27. $serviceOne = new \App\RpcServices\ServiceOne();
  28. // 在 ServiceOne 服务中添加 ModuleOne 模块
  29. $serviceOne->addModule(new \App\RpcServices\ModuleOne());
  30. // 在 ServiceOne 服务中添加 ModuleTwo 模块
  31. $serviceOne->addModule(new \App\RpcServices\ModuleTwo());
  33. // 创建 ServiceTwo 服务 
  34. $serviceTwo = new \App\RpcServices\ServiceTwo();
  35. // 在 ServiceTwo 服务中添加 ModuleOne 模块
  36. $serviceTwo->addModule(new \App\RpcServices\ModuleOne());
  37. // 在 ServiceTwo 服务中添加 ModuleTwo 模块
  38. $serviceTwo->addModule(new \App\RpcServices\ModuleTwo());
  40. // 添加服务到服务管理器
  41. $rpc->serviceManager()->addService($serviceOne);
  42. $rpc->serviceManager()->addService($serviceTwo);
  44. // 注册服务
  45. # $http = new \Swoole\Http\Server('0.0.0.0', 9501);
  46. $http = \EasySwoole\EasySwoole\ServerManager::getInstance()->getSwooleServer();
  48. $rpc->attachServer($http);

用户可以自行实现 Redis 节点管理器实现类(实现 NodeManagerInterface 接口即可)，来完成 rpc 服务端的配置。下文将介绍使用默认节点管理器(即 MemoryManager)完成 rpc 服务端的配置、rpc 服务的注册及服务调用。

调用

客户端调用

  1. <?php
  2. $rpc = new \EasySwoole\Rpc\Rpc($config);
  4. $client = $rpc->client();
  6. // 添加请求(调用 ServiceOne 服务的 ModuleOne 模块的 action 方法) 
  7. $ctx1 = $client->addRequest('ServiceOne.ModuleOne.action');
  8. // 设置请求参数
  9. $ctx1->setArg(['a','b','c']);
  10. $ctx1->setOnSuccess(function (\EasySwoole\Rpc\Protocol\Response $response){
  11.     // 调用成功获得响应
  12. });
  13. $ctx1->setOnFail(function (\EasySwoole\Rpc\Protocol\Response $response){
  14.     // 调用失败获得响应
  15. });
  17. // 添加请求(调用 ServiceTwo 服务的 ModuleOne 模块的 action 方法) 
  18. $ctx2 = $client->addRequest('ServiceTwo.ModuleOne.action');
  19. // 设置请求参数
  20. $ctx2->setArg(['a','b','c']);
  21. $ctx2->setOnSuccess(function (\EasySwoole\Rpc\Protocol\Response $response){
  22.     // 调用成功获得响应
  23. });
  24. $ctx2->setOnFail(function (\EasySwoole\Rpc\Protocol\Response $response){
  25.     // 调用失败获得响应
  26. });

注意，当使用默认实现的节点管理器(即 MemoryManager)进行注册服务端时，在进行客户端调用时，请使用 \EasySwoole\Components\Di 组件保存 rpc 服务端注册服务完成后的实例或在 Swoole 中独立使用采用 use 引入 rpc 服务端注册服务完成后的实例，具体请看下文的使用示例。

节点管理器使用介绍

  1. <?php
  2. /** 节点管理器 */
  4. // 用户在调用rpc过程中 当发现节点不可用 可自行调用下线
  6. // 构造方法内用户可传入节点管理器实现`NodeManagerInterface` 默认`MemoryManager`
  7. $config = new \EasySwoole\Rpc\Config();
  8. $rpc = new \EasySwoole\Rpc\Rpc($config);
  10. $nodeManager = $rpc->getConfig()->getNodeManager();
  12. // 获取服务的所有节点
  13. $nodeManager->getNodes('serviceOne', 1);
  15. // 随机获取服务的一个节点
  16. $nodeManager->getNode('serviceOne', 1);
  18. // 下线一个服务节点
  19. $nodeManager->offline(new \EasySwoole\Rpc\Server\ServiceNode());
  21. // 刷新一个服务节点
  22. $nodeManager->alive(new \EasySwoole\Rpc\Server\ServiceNode());
  24. // 宕机一个服务节点
  25. $nodeManager->failDown(new \EasySwoole\Rpc\Server\ServiceNode());

基础使用

新建 App\RpcServices\ 文件夹，然后定义如下 服务类 和 模块类：

  1. 定义 ServiceOne 服务
  1. <?php
  3. namespace App\RpcServices;
  5. use EasySwoole\Rpc\Service\AbstractService;
  7. class ServiceOne extends AbstractService
  8. {
  9.     function serviceName(): string
  10.     {
  11.         return 'ServiceOne';
  12.     }
  13. }
  1. 定义 ServiceTwo 服务
  1. <?php
  3. namespace App\RpcServices;
  5. use EasySwoole\Rpc\Service\AbstractService;
  7. class ServiceTwo extends AbstractService
  8. {
  9.     function serviceName(): string
  10.     {
  11.         return 'ServiceTwo';
  12.     }
  13. }
  1. 定义 ModuleOne 模块
  1. <?php
  3. namespace App\RpcServices;
  5. use EasySwoole\Rpc\Service\AbstractServiceModule;
  7. class ModuleOne extends AbstractServiceModule
  8. {
  9.     function moduleName(): string
  10.     {
  11.         return 'ModuleOne';
  12.     }
  14.     function args()
  15.     {
  16.         $this->response()->setResult($this->request()->getArg());
  17.     }
  19.     function action()
  20.     {
  21.         $this->response()->setMsg("ModuleOne hello action");
  22.     }
  24.     function exception()
  25.     {
  26.         throw new \Exception('the ModuleOne exception');
  28.     }
  30.     protected function onException(\Throwable $throwable)
  31.     {
  32.         $this->response()->setStatus(-1)->setMsg($throwable->getMessage());
  33.     }
  34. }
  1. 定义 ModuleTwo 模块
  1. <?php
  3. namespace App\RpcServices;
  5. use EasySwoole\Rpc\Service\AbstractServiceModule;
  7. class ModuleTwo extends AbstractServiceModule
  8. {
  9.     function moduleName(): string
  10.     {
  11.         return 'ModuleTwo';
  12.     }
  14.     function args()
  15.     {
  16.         $this->response()->setResult($this->request()->getArg());
  17.     }
  19.     function action()
  20.     {
  21.         $this->response()->setMsg("ModuleTwo hello action");
  22.     }
  24.     function exception()
  25.     {
  26.         throw new \Exception('the ModuleTwo exception');
  28.     }
  30.     protected function onException(\Throwable $throwable)
  31.     {
  32.         $this->response()->setStatus(-1)->setMsg($throwable->getMessage());
  33.     }
  34. }

在 Swoole 中独立使用

  1. <?php
  3. use EasySwoole\Rpc\Config;
  4. use EasySwoole\Rpc\Protocol\Response;
  5. use EasySwoole\Rpc\Rpc;
  6. use Swoole\Http\Server;
  7. use App\RpcServices\ServiceOne;
  8. use App\RpcServices\ModuleOne;
  10. require 'vendor/autoload.php';
  12. // 配置 rpc 服务端
  13. $config = new Config();
  15. // 【必须设置】设置本机ip
  16. $config->getServer()->setServerIp('127.0.0.1');
  18. $rpc = new Rpc($config);
  20. // 创建 ServiceOne 服务
  21. $service = new ServiceOne();
  22. // 添加 ModuleOne 模块到 ServiceOne 服务中
  23. $service->addModule(new ModuleOne());
  25. // 添加 ServiceOne 服务到服务管理器中
  26. $rpc->serviceManager()->addService($service);
  28. $http = new Server('0.0.0.0', 9501);
  30. // 注册 rpc 服务
  31. $rpc->attachServer($http);
  33. // 使用 use 引入 rpc 服务端注册服务完成后的实例
  34. $http->on('request', function ($request, $response) use ($rpc) {
  36.     // 客户端调用
  37.     $client = $rpc->client();
  39.     // 添加请求(调用 ServiceOne 服务的 ModuleOne 模块的 action 方法)
  40.     $ctx2 = $client->addRequest('ServiceOne.ModuleOne.action');
  42.     // 设置请求参数
  43.     $ctx2->setArg('xxx');
  45.     $rpcCallRet = '';
  47.     // 设置调用成功执行回调
  48.     $ctx2->setOnSuccess(function (Response $response) use (&$rpcCallRet) {
  49.         // 调用成功获得响应
  50.         var_dump($response->getMsg());
  51.         $rpcCallRet = $response->getMsg();
  52.     });
  54.     // 设置调用失败执行回调
  55.     $ctx2->setOnFail(function (Response $response) use (&$rpcCallRet) {
  56.         // 调用失败获得响应
  57.         var_dump($response->getMsg());
  58.         $rpcCallRet = $response->getMsg();
  59.     });
  61.     // 执行调用
  62.     $client->exec();
  64.     $response->end('the result of rpc is ' . $rpcCallRet);
  65. });
  67. $http->start();

访问 http://localhost:9501/(示例请求地址) 即可看到结果为 the result of rpc is ModuleOne hello action。

在 EasySwoole 中使用

  1. 在 mainServerCreate 事件中注册 rpc 服务
  1. <?php
  3. namespace EasySwoole\EasySwoole;
  5. use EasySwoole\Component\Di;
  6. use EasySwoole\EasySwoole\AbstractInterface\Event;
  7. use EasySwoole\EasySwoole\Swoole\EventRegister;
  9. class EasySwooleEvent implements Event
  10. {
  11.     public static function initialize()
  12.     {
  13.         date_default_timezone_set('Asia/Shanghai');
  14.     }
  16.     public static function mainServerCreate(EventRegister $register)
  17.     {
  18.         ###### 注册 rpc 服务 ######
  19.         /** rpc 服务端配置 */
  20.         // 构造方法内用户可传入节点管理器实现`NodeManagerInterface` 默认`MemoryManager`
  21.         $config = new \EasySwoole\Rpc\Config();
  22.         // 设置服务名称
  23.         $config->setServerName('EasySwoole'); // 默认 EasySwoole
  25.         // 【可选操作】设置节点id，可忽略，构造函数已经设置
  26.         # $config->setNodeId(\EasySwoole\Utility\Random::character(10));
  28.         // 设置异常处理器 对Service-Worker 和 AssistWorker的异常进行处理 必须设置 防止未捕获导致进程退出
  29.         $config->setOnException(function (\Throwable $throwable) {
  31.         });
  32.         $serverConfig = $config->getServer();
  33.         // 设置本机ip 必须设置
  34.         $serverConfig->setServerIp('127.0.0.1');
  36.         // 【可选操作】设置工作进程数量，默认为 4
  37.         # $serverConfig->setWorkerNum(4);
  38.         // 【可选操作】设置监听地址及端口，监听地址默认为 '0.0.0.0'，端口默认为 9600
  39.         # $serverConfig->setListenAddress('0.0.0.0');
  40.         # $serverConfig->setListenPort('9600');
  41.         // 【可选操作】设置服务端最大接受包大小，默认为 1024 * 1024 * 2 (即2M)
  42.         # $serverConfig->setMaxPackageSize(1024 * 1024 * 2);
  43.         // 【可选操作】设置接收客户端数据时间，默认为 3s
  44.         # $serverConfig->setNetworkReadTimeout(3);
  46.         /** 配置 rpc */
  47.         $rpc = new \EasySwoole\Rpc\Rpc($config);
  49.         // 创建 ServiceOne 服务
  50.         $service = new \App\RpcServices\ServiceOne();
  51.         // 添加 ModuleOne 模块到 ServiceOne 服务中
  52.         $service->addModule(new \App\RpcServices\ModuleOne());
  53.         // 添加 ServiceOne 服务到服务管理器中
  54.         $rpc->serviceManager()->addService($service);
  56.         // 注册 rpc 服务
  57.         $rpc->attachServer(ServerManager::getInstance()->getSwooleServer());
  59.         // 使用 \EasySwoole\Components\Di 组件保存 rpc 服务端注册服务完成后的实例，方便在框架的其他任何地方进行调用。
  60.         Di::getInstance()->set('rpc', $rpc);
  61.     }
  62. }
  1. 在控制器中进行服务调用
  1. <?php
  3. namespace App\HttpController;
  5. use EasySwoole\Component\Di;
  6. use EasySwoole\Http\AbstractInterface\Controller;
  7. use EasySwoole\Rpc\Protocol\Response;
  8. use EasySwoole\Rpc\Rpc;
  10. class Index extends Controller
  11. {
  12.     /** @var Rpc */
  13.     protected $rpcService;
  15.     protected function onRequest(?string $action): ?bool
  16.     {
  17.         $this->rpcService = Di::getInstance()->get('rpc');
  18.         return parent::onRequest($action);
  19.     }
  21.     public function index()
  22.     {
  23.         // 客户端调用
  24.         $client = $this->rpcService->client();
  26.         // 添加请求(调用 ServiceOne 服务的 ModuleOne 模块的 action 方法)
  27.         $ctx2 = $client->addRequest('ServiceOne.ModuleOne.action');
  29.         // 设置请求参数
  30.         $ctx2->setArg('xxx');
  32.         $rpcCallRet = '';
  34.         // 设置调用成功执行回调
  35.         $ctx2->setOnSuccess(function (Response $response) use (&$rpcCallRet) {
  36.             // 调用成功获得响应
  37.             var_dump($response->getMsg());
  38.             $rpcCallRet = $response->getMsg();
  39.         });
  41.         // 设置调用失败执行回调
  42.         $ctx2->setOnFail(function (Response $response) use (&$rpcCallRet) {
  43.             // 调用失败获得响应
  44.             var_dump($response->getMsg());
  45.             $rpcCallRet = $response->getMsg();
  46.         });
  48.         // 执行调用
  49.         $client->exec();
  51.         $this->response()->write('the result of rpc is ' . $rpcCallRet);
  52.     }
  53. }

访问 http://localhost:9501/(示例请求地址) 即可看到结果为 the result of rpc is ModuleOne hello action。