hyperf/docs/zh-cn/websocket-server.md
李铭昕 7fa189fffc Merge branch 'master' into 3.0-merge
# Conflicts:
#	.github/workflows/test.yml
#	src/di/src/Aop/PropertyHandlerVisitor.php
#	src/kafka/composer.json
#	src/kafka/src/Producer.php
2022-05-16 11:30:34 +08:00

8.0 KiB
Raw Blame History

WebSocket 服务

Hyperf 提供了对 WebSocket Server 的封装,可基于 hyperf/websocket-server 组件快速搭建一个 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');
});

配置中间件

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

<?php

return [
    'ws' => [
        yourMiddleware::class
    ]
];

创建对应控制器

<?php
declare(strict_types=1);

namespace App\Controller;

use Hyperf\Contract\OnCloseInterface;
use Hyperf\Contract\OnMessageInterface;
use Hyperf\Contract\OnOpenInterface;
use Hyperf\WebSocketServer\Constant\Opcode;
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
    {
        if($frame->opcode == Opcode::PING) {
            // 如果使用协程 Server在判断是 PING 帧后,需要手动处理,返回 PONG 帧。
            // 异步风格 Server可以直接通过 Swoole 配置处理,详情请见 https://wiki.swoole.com/#/websocket_server?id=open_websocket_ping_frame
            $server->push('', Opcode::PONG);
            return;
        }
        $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');
    }
}

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

!> 当我们同时监听了 HTTP Server 的 9501 端口和 WebSocket Server 的 9502 端口时, WebSocket Client 可以通过 9501 和 9502 两个端口连接 WebSocket Server即连接 ws://0.0.0.0:9501ws://0.0.0.0:9502 都可以成功。

因为 Swoole\WebSocket\Server 继承自 Swoole\Http\Server可以使用 HTTP 触发所有 WebSocket 的推送,了解详情可查看 Swoole 文档 onRequest 回调部分。

如需关闭,可以修改 config/autoload/server.php 文件给 http 服务中增加 open_websocket_protocol 配置项。

<?php
return [
    // 这里省略了该文件的其它配置
    'servers' => [
        [
            'name' => 'http',
            'type' => Server::SERVER_HTTP,
            'host' => '0.0.0.0',
            'port' => 9501,
            'sock_type' => SWOOLE_SOCK_TCP,
            'callbacks' => [
                Event::ON_REQUEST => [Hyperf\HttpServer\Server::class, 'onRequest'],
            ],
            'settings' => [
                'open_websocket_protocol' => false,
            ]
        ],
    ]
];

连接上下文

WebSocket 服务的 onOpen, onMessage, onClose 回调并不在同一个协程下触发因此不能直接使用协程上下文存储状态信息。WebSocket Server 组件提供了 连接级 的上下文API 与协程上下文完全一样。

<?php
declare(strict_types=1);

namespace App\Controller;

use Hyperf\Contract\OnMessageInterface;
use Hyperf\Contract\OnOpenInterface;
use Hyperf\WebSocketServer\Context;
use Swoole\Http\Request;
use Swoole\Websocket\Frame;
use Swoole\WebSocket\Server as WebSocketServer;

class WebSocketController implements OnMessageInterface, OnOpenInterface
{
    public function onMessage($server, Frame $frame): void
    {
        $server->push($frame->fd, 'Username: ' . Context::get('username'));
    }

    public function onOpen($server, Request $request): void
    {
        Context::set('username', $request->cookie['username']);
    }
}

多 server 配置

# /etc/nginx/conf.d/ng_socketio.conf
# 多个 ws server
upstream io_nodes {
    server ws1:9502;
    server ws2:9502;
}
server {
  listen 9502;
  # server_name your.socket.io;
  location / {
    proxy_set_header Upgrade "websocket";
    proxy_set_header Connection "upgrade";
    # proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
    # proxy_set_header Host $host;
    # proxy_http_version 1.1;
    # 转发到多个 ws server
    proxy_pass http://io_nodes;
  }
}

消息发送器

当我们想在 HTTP 服务中,关闭 WebSocket 连接时,可以直接使用 Hyperf\WebSocketServer\Sender

Sender 会判断 fd 是否被当前 Worker 所持有,如果是,则会直接发送数据,如果不是,则会通过 PipeMessage 发送给除自己外的所有 Worker,然后由其他 Worker 进行判断, 如果是自己持有的 fd,就会发送对应数据到客户端。

Sender 支持 pushdisconnect 两个 API,如下:

<?php

declare(strict_types=1);

namespace App\Controller;

use Hyperf\Di\Annotation\Inject;
use Hyperf\HttpServer\Annotation\AutoController;
use Hyperf\WebSocketServer\Sender;

#[AutoController]
class ServerController
{
    /**
     * @var Sender
     */
    #[Inject]
    protected $sender;

    public function close(int $fd)
    {
        go(function () use ($fd) {
            sleep(1);
            $this->sender->disconnect($fd);
        });

        return '';
    }

    public function send(int $fd)
    {
        $this->sender->push($fd, 'Hello World.');

        return '';
    }
}

在 WebSocket 服务中处理 HTTP 请求

我们除了可以将 HTTP 服务和 WebSocket 服务通过端口分开,也可以在 WebSocket 中监听 HTTP 请求。

因为 server.servers.*.callbacks 中的配置项,都是单例的,所以我们需要在 dependencies 中配置一个单独的实例。

<?php
return [
    'HttpServer' => Hyperf\HttpServer\Server::class,
];

然后修改我们的 WebSocket 服务中的 callbacks 配置,以下隐藏了不相干的配置

<?php

declare(strict_types=1);

use Hyperf\Server\Event;
use Hyperf\Server\Server;

return [
    'mode' => SWOOLE_BASE,
    'servers' => [
        [
            'name' => 'ws',
            'type' => Server::SERVER_WEBSOCKET,
            'host' => '0.0.0.0',
            'port' => 9502,
            'sock_type' => SWOOLE_SOCK_TCP,
            'callbacks' => [
                Event::ON_REQUEST => ['HttpServer', 'onRequest'],
                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'],
            ],
        ],
    ],
];

最后我们便可以在 ws 中,添加 HTTP 路由了。