隨著現(xiàn)代web應用程序的不斷發(fā)展，實時通信成為了必須的功能之一。而websocket 技術就是其中一種最流行的實時通信方式，能夠在服務器和客戶端之間建立持久的雙向連接，實現(xiàn)實時通信。
Thinkphp 是一個非常流行的 PHP 框架，thinkphp 6 自帶了 swoole 擴展包，使得在使用 WebSocket 技術時變得非常簡單。本文將介紹如何使用 ThinkPHP 6 框架來實現(xiàn)一個 WebSocket 廣播功能。
環(huán)境要求
在開始之前，需要準備以下環(huán)境：
- PHP 7.2+
- Swoole 擴展
- composer
- 基本的 Web 開發(fā)知識
創(chuàng)建項目
首先，我們需要創(chuàng)建一個新的項目：
composer create-project topthink/think my-project
然后，為了方便使用 WebSocket，我們需要在項目的 composer.json 文件中添加 Swoole 擴展：
立即學習“PHP免費學習筆記（深入）”；
"require": { "topthink/think-swoole": "^2.0", "swoole/swoole": "^4.7" }
完成后，運行以下命令進行安裝：
composer install
創(chuàng)建控制器
接下來，我們需要創(chuàng)建一個控制器來處理 WebSocket 的請求。在 app/controller 目錄下創(chuàng)建一個名為 Websocket.php 的文件，寫入以下代碼：
<?php declare(strict_types=1); namespace appcontroller; use thinkswooleWebsocket as SwooleWebsocket; use SwooleWebSocketFrame; class Websocket extends SwooleWebsocket { /** * 監(jiān)聽連接事件 * @param SwooleWebSocketServer $server * @param SwooleHttpRequest $request */ public function onOpen($server, $request) { } /** * 監(jiān)聽接收消息事件 * @param SwooleWebSocketServer $server * @param Frame $frame */ public function onMessage($server, Frame $frame) { } /** * 監(jiān)聽關閉事件 * @param SwooleWebSocketServer $server * @param int $fd */ public function onClose($server, $fd) { } }
在上面的代碼中，我們繼承了 thinkswooleWebsocket 類，并重寫了其中的三個方法：
- onOpen 方法用于監(jiān)聽連接事件；
- onMessage 方法用于監(jiān)聽接收消息事件；
- onClose 方法用于監(jiān)聽關閉事件。
當前，這些方法并沒有做任何事情，接下來我們將會在這些方法中添加 WebSocket 通信的邏輯。
注冊路由
在控制器創(chuàng)建好之后，我們需要在路由中進行注冊。在 app/route.php 文件中添加以下內(nèi)容：
use thinkacadeRoute; Route::post('/ws', 'Websocket@onMessage')->middleware( hinkmiddlewareAllowCrossDomain::class);
這里使用了 Route::post 方法來注冊路由。這個路由的請求方式是 POST，路徑為 /ws，并將請求映射到了 Websocket 控制器的 onMessage 方法上。
編寫 WebSocket 通信邏輯
現(xiàn)在，我們已經(jīng)完成了 WebSocket 路由和控制器的創(chuàng)建與注冊。接下來，我們需要在控制器中添加 WebSocket 通信的邏輯。我們將使用 Swoole 的 WebSocket 服務端來實現(xiàn) WebSocket 通信。
在 onOpen 方法中，我們可以獲取客戶端的連接對象，并將其存儲起來，以便后續(xù)使用。在 onMessage 方法中，我們可以獲取客戶端發(fā)送的消息，并將這條消息廣播給其它客戶端。在 onClose 方法中，我們需要將客戶端從連接池中移除。
在 app/controller 目錄下創(chuàng)建一個名為 WebSocketServer.php 的文件，寫入以下代碼：
<?php declare(strict_types=1); namespace appcontroller; use SwooleHttpResponse; use SwooleWebSocketFrame; use SwooleWebSocketServer; use thinkswoolewebsocketHandlerInterface; class WebSocketServer implements HandlerInterface { /** * @var array $connections */ private $connections = []; /** * 監(jiān)聽連接事件 * @param Server $server * @param SwooleHttpRequest $request */ public function onOpen(Server $server, SwooleHttpRequest $request): void { $this->connections[$request->fd] = $request->fd; echo "client-{$request->fd} is connected "; } /** * 監(jiān)聽消息事件 * @param Server $server * @param Frame $frame */ public function onMessage(Server $server, Frame $frame): void { foreach ($this->connections as $fd) { $info = $server->getClientInfo((int)$fd); if ($info && isset($info['websocket_status']) && $info['websocket_status'] == WEBSOCKET_STATUS_FRAME) { $server->push($fd, $frame->data); } else { unset($this->connections[$fd]); } } echo "received message from client-{$frame->fd}: {$frame->data} "; } /** * 監(jiān)聽關閉事件 * @param Server $server * @param int $fd * @param int $reactorId */ public function onClose(Server $server, int $fd, int $reactorId): void { unset($this->connections[$fd]); echo "client-{$fd} is closed "; } /** * @param Response $response */ public function onHandShake(Request $request, Response $response): bool { // Do nothing return true; } }
配置 WebSocket 服務
在寫入 WebSocket 的服務代碼之前，我們需要在 config 目錄下創(chuàng)建一個名為 swoole.php 的配置文件，寫入以下內(nèi)容：
return [ 'socket_type' => 'websocket', 'host' => '0.0.0.0', 'port' => 9501, 'mode' => SWOOLE_PROCESS, 'sock_type' => SWOOLE_SOCK_TCP, 'settings' => [ 'worker_num' => swoole_cpu_num(), ], 'handler' => ppcontrollerWebSocketServer::class, ];
在上面的代碼中，我們通過配置文件告訴應用程序如何啟動 Swoole WebSocket 服務。我們啟動 websocket socket 類型，綁定在 0.0.0.0:9501 上，并開啟了多進程模式，使用 TCP 協(xié)議。worker_num 配置項設置了服務器的進程數(shù)，這里使用了 swoole_cpu_num() 用于返回系統(tǒng) CPU 數(shù)量；handler 配置項指定了我們在上文中創(chuàng)建的 WebSocketServer 類。
運行 WebSocket 服務
在完成了創(chuàng)建、配置 WebSocket 服務的代碼之后，我們需要運行一下代碼，來開啟 WebSocket 服務。在命令行中執(zhí)行以下命令即可：
php think swoole start --mode=websocket
Websocket 服務已經(jīng)啟動，你可以通過訪問你的應用程序來測試它。你可以使用這個地址：ws://your-domain:9501/ws。在瀏覽器中打開多個選項卡，分別測試 WebSocket 的連接、消息發(fā)送和接收等功能。
小結
本文介紹了如何使用 ThinkPHP 6 框架來實現(xiàn)一個 WebSocket 廣播功能。我們通過創(chuàng)建控制器、注冊路由和編寫 WebSocket 通信邏輯，以及配置 WebSocket 服務，來完成這一功能。這個示例可以作為一個簡單 WebSocket 最佳實踐，為我們開發(fā)更高級的 WebSocket 功能提供了參考。
