隨著現代web應用程式的不斷發展,即時通訊成為了必須的功能之一。而WebSocket 技術就是其中一種最受歡迎的即時通訊方式,能夠在伺服器和用戶端之間建立持久的雙向連接,實現即時通訊。
ThinkPHP 是一個非常流行的 PHP 框架,ThinkPHP 6 自帶了 Swoole 擴充包,使得在使用 WebSocket 技術時變得非常簡單。本文將介紹如何使用 ThinkPHP 6 框架來實作一個 WebSocket 廣播功能。
在開始之前,需要準備以下環境:
composer create-project topthink/think my-project
composer.json 檔案中新增Swoole 擴充功能:
"require": { "topthink/think-swoole": "^2.0", "swoole/swoole": "^4.7" }
composer install
app/controller 目錄下建立一個名為
Websocket.php 的文件,寫入以下程式碼:
<?php declare(strict_types=1); namespace appcontroller; use thinkswooleWebsocket as SwooleWebsocket; use SwooleWebSocketFrame; class Websocket extends SwooleWebsocket { /** * 监听连接事件 * @param SwooleWebSocketServer $server * @param SwooleHttpRequest $request */ public function onOpen($server, $request) { } /** * 监听接收消息事件 * @param SwooleWebSocketServer $server * @param Frame $frame */ public function onMessage($server, Frame $frame) { } /** * 监听关闭事件 * @param SwooleWebSocketServer $server * @param int $fd */ public function onClose($server, $fd) { } }
thinkswooleWebsocket 類,並重寫了其中的三個方法:
方法用於監聽連接事件;
方法用於監聽接收訊息事件;
方法用於監聽關閉事件。
app/route.php 檔案中加入以下內容:
use thinkacadeRoute; Route::post('/ws', 'Websocket@onMessage')->middleware( hinkmiddlewareAllowCrossDomain::class);
Route::post 方法來註冊路由。這個路由的請求方式是
POST,路徑為
/ws,並將請求對應到了
Websocket 控制器的
onMessage 方法上。
onOpen 方法中,我們可以取得客戶端的連接對象,並將其儲存起來,以便後續使用。在
onMessage 方法中,我們可以取得客戶端所傳送的訊息,並將這則訊息廣播給其它客戶端。在
onClose 方法中,我們需要將客戶端從連線池中移除。
app/controller 目錄下建立一個名為
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 = []; /** * 监听连接事件 * @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 "; } /** * 监听消息事件 * @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} "; } /** * 监听关闭事件 * @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; } }
config 目錄下建立一個名為
swoole.php 的設定文件,寫入以下內容:
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, ];
websocket socket 類型,綁定在
0.0.0.0:9501 上,並開啟了多進程模式,使用 TCP 協定。
worker_num 配置項目設定了伺服器的進程數,這裡使用了
swoole_cpu_num() 用於返回系統CPU 數量;
handler 配置項目指定了我們在上文中建立的
WebSocketServer 類別。
php think swoole start --mode=websocket
ws://your-domain:9501/ws。在瀏覽器中開啟多個選項卡,分別測試 WebSocket 的連線、訊息傳送和接收等功能。
以上是利用ThinkPHP6實現Websocket廣播的詳細內容。更多資訊請關注PHP中文網其他相關文章!