WebSocket 服务
WebSocket是一种通信协议，可在单个TCP连接上进行全双工通信。WebSocket使得客户端和服务器之间的数据交换变得更加简单，允许服务端主动向客户端推送数据。在WebSocket API中，浏览器和服务器只需要完成一次握手，两者之间就可以建立持久性的连接，并进行双向数据传输。
Hyperf 提供了对 WebSocket Server 的封装，可基于 hyperf/websocket-server 组件快速搭建一个 WebSocket 应用。
安装
composer require hyperf/websocket-server
配置 Server
修改 config/autoload/server.php，增加以下配置。
<?php 'servers' => [ [ 'name' => 'ws', 'type' => Server::SERVER_WEBSOCKET, 'host' => '0.0.0.0', 'port' => 9502, 'sock_type' => SWOOLE_SOCK_TCP, 'callbacks' => [ SwooleEvent::ON_HAND_SHAKE => [Hyperf\WebSocketServer\Server::class, 'onHandShake'], SwooleEvent::ON_MESSAGE => [Hyperf\WebSocketServer\Server::class, 'onMessage'], SwooleEvent::ON_CLOSE => [Hyperf\WebSocketServer\Server::class, 'onClose'], ], ], ],
配置路由
目前暂时只支持配置文件的模式配置路由，后续会提供注解模式。
在 config/routes.php 文件内增加对应 ws 的 Server 的路由配置，这里的 ws 值取决于您在 config/autoload/server.php 内配置的 WebSocket Server 的 name 值。
<?php Router::addServer('ws', function () { Router::get('/', 'App\Controller\WebSocketController'); });
创建对应控制器
<?php declare(strict_types=1); namespace App\Controller; use Hyperf\Contract\OnCloseInterface; use Hyperf\Contract\OnMessageInterface; use Hyperf\Contract\OnOpenInterface; use Swoole\Http\Request; use Swoole\Server; use Swoole\Websocket\Frame; class WebSocketController implements OnMessageInterface, OnOpenInterface, OnCloseInterface { public function onMessage(Server $server, Frame $frame): void { $server->push($frame->fd, 'Recv: ' . $frame->data); } public function onClose(Server $server, int $fd, int $reactorId): void { var_dump('closed'); } public function onOpen(Server $server, Request $request): void { $server->push($request->fd, 'Opened'); } }
接下来启动 Server，便能看到对应启动了一个 WebSocket Server 并监听于 9502 端口，此时您便可以通过各种 WebSocket Client 来进行连接和进行数据传输了。
$ php bin/hyperf.php start [INFO] Worker#0 started. [INFO] WebSocket Server listening at 0.0.0.0:9502 [INFO] HTTP Server listening at 0.0.0.0:9501
WebSocket 协程客户端
Hyperf 提供了对 WebSocket Client 的封装，可基于 hyperf/websocket-client 组件对 WebSocket Server 进行访问；
安装
composer require hyperf/websocket-client
使用
组件提供了一个 Hyperf\WebSocketClient\ClientFactory 来创建客户端对象 Hyperf\WebSocketClient\Client，我们直接通过代码来演示一下：
<?php declare(strict_types=1); namespace App\Controller; use Hyperf\Di\Annotation\Inject; class IndexController extends Controller { /** * @Inject() * @var \Hyperf\WebSocketClient\ClientFactory */ protected $clientFactory; public function index() { // 对端服务的地址，如没有提供 ws:// 或 wss:// 前缀，则默认补充 ws:// $host = '127.0.0.1:9502'; // 通过 ClientFactory 创建 Client 对象，创建出来的对象为短生命周期对象 $client = $this->clientFactory->create($host); } }
自动关闭连接开关
默认情况下，创建出来的 Client 对象会通过 defer 自动 close 连接，如果您希望不自动 close，可在创建 Client 对象时传递第二个参数 $autoClose 为 false：
<?php $autoClose = false; $clientFactory->create($host, $autoClose);
官网及交流
Github <- 点 Star 支持我们
![[Git] 深入理解 Git 的客户端与服务器角色](https://ucc.alicdn.com/mf7bdqcba64nc/developer-article1650288/20250122/5c93959780854f9180ee54fd63b232a2.png?x-oss-process=image/format,webp/resize,h_160,m_lfit)
