WebSocket 协程客户端

Hyperf 提供了对 WebSocket Client 的封装，可基于 hyperf/websocket-client 组件对 WebSocket Server 进行访问；

安装

  1. composer require hyperf/websocket-client

使用

组件提供了一个 Hyperf\WebSocketClient\ClientFactory 来创建客户端对象 Hyperf\WebSocketClient\Client，我们直接通过代码来演示一下：

  1. <?php
  2. declare(strict_types=1);
  4. namespace App\Controller;
  6. use Hyperf\Di\Annotation\Inject;
  7. use Hyperf\WebSocketClient\ClientFactory;
  8. use Hyperf\WebSocketClient\Frame;
  10. class IndexController
  11. {
  12.     #[Inject]
  13.     protected ClientFactory $clientFactory;
  15.     public function index()
  16.     {
  17.         // 对端服务的地址，如没有提供 ws:// 或 wss:// 前缀，则默认补充 ws://
  18.         $host = '127.0.0.1:9502';
  19.         // 通过 ClientFactory 创建 Client 对象，创建出来的对象为短生命周期对象
  20.         $client = $this->clientFactory->create($host);
  21.         // 向 WebSocket 服务端发送消息
  22.         $client->push('HttpServer 中使用 WebSocket Client 发送数据。');
  23.         // 获取服务端响应的消息，服务端需要通过 push 向本客户端的 fd 投递消息，才能获取；以下设置超时时间 2s，接收到的数据类型为 Frame 对象。
  24.         /** @var Frame $msg */
  25.         $msg = $client->recv(2);
  26.         // 获取文本数据：$res_msg->data
  27.         return $msg->data;
  28.     }
  29. }

关闭自动关闭

默认情况下，创建出来的 Client 对象会通过 defer 自动 close 连接，如果您希望不自动 close，可在创建 Client 对象时传递第二个参数 $autoClose 为 false：

  1. $autoClose = false;
  2. $client = $clientFactory->create($host, $autoClose);