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 支援我們

Hyperf 官網

php-websocket hyperf/websocket-server/client 用戶端和伺服器實時雙向資料傳輸WebSocket 服務WebSocket 協程用戶端官網及交流