hyperf websocket

composer require hyperf/websocket-server

配置 Server

修改 config/autoload/server.php，增加以下配置。

<?php
 
return [
    'servers' => [
        [
            'name' => 'ws',
            'type' => Server::SERVER_WEBSOCKET,
            'host' => '0.0.0.0',
            'port' => 9502,
            'sock_type' => SWOOLE_SOCK_TCP,
            'callbacks' => [
                Event::ON_HAND_SHAKE => [Hyperf\WebSocketServer\Server::class, 'onHandShake'],
                Event::ON_MESSAGE => [Hyperf\WebSocketServer\Server::class, 'onMessage'],
                Event::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;
use Swoole\WebSocket\Server as WebSocketServer;
 
class WebSocketController implements OnMessageInterface, OnOpenInterface, OnCloseInterface
{
    public function onMessage($server, Frame $frame): void
    {
        $server->push($frame->fd, 'Recv: ' . $frame->data);
    }
 
    public function onClose($server, int $fd, int $reactorId): void
    {
        var_dump('closed');
    }
 
    public function onOpen($server, Request $request): void
    {
        $server->push($request->fd, 'Opened');
    }
}Copy to clipboardErrorCopied

接下来启动 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

 

配置中间件

在 config/autoload/middlewares.php 文件内增加对应 ws 的 Server 的全局中间件配置，这里的 ws 值取决于您在 config/autoload/server.php 内配置的 WebSocket Server 的 name 值。

<?php
 
return [
    'ws' => [
        yourMiddleware::class
    ]
];

 在中间件获取参数