think-swoole 3.0 中 websocket 新增了 room 聊天室功能,它主要用于群發消息,但不同room之間的消息又是相互隔離的。當我們進入一個聊天室,那么我們的進入、離開以及發送的消息只有這個聊天室的 fd 能接收到。
config.swoole.php
'websocket'??=>?[ ????????'enable'????????=>?true, ????????'handler'???????=>?Handler::class, ????????'parser'????????=>?Parser::class, ????????'ping_interval'?=>?25000, ????????'ping_timeout'??=>?60000, ????????'room'??????????=>?[ ????????????'type'??=>?'table', ????????????'table'?=>?[ ????????????????'room_rows'???=>?4096, ????????????????'room_size'???=>?2048, ????????????????'client_rows'?=>?8192, ????????????????'client_size'?=>?2048, ????????????], ????????????'redis'?=>?[ ????????????????'host'??????????=>?'127.0.0.1', ????????????????'port'??????????=>?6379, ????????????????'max_active'????=>?3, ????????????????'max_wait_time'?=>?5, ????????????], ????????], ????????'listen'????????=>?[], ????????'subscribe'?????=>?[], ????],
其中有 room 配置項,里面的 type 表示使用哪種數據處理方式,下面有兩種,“table” 和“redis”,table 是可以直接拿來使用的,而 redis 則需要我們的系統和項目中安裝了 redis 擴展。table 是一種高性能、跨進程的內存處理服務,不同進程間可以共享數據。
創建事件
在項目根目錄輸入如下命令,分別創建加入房間事件、離開房間事件和房間的聊天事件:
php?think?make:listener?WsJoin php?think?make:listener?WsLeave php?think?make:listener?RoomTest
然后在 app/Event.php 中定義事件:
[ ????], ????'listen'????=>?[ ????????'AppInit'??=>?[], ????????'HttpRun'??=>?[], ????????'HttpEnd'??=>?[], ????????'LogLevel'?=>?[], ????????'LogWrite'?=>?[], ????????//監聽連接,swoole?事件必須以?swoole?開頭 ????????'swoole.websocket.Connect'?=>?[ ????????????applistenerWsConnect::class ????????], ????????//監聽關閉 ????????'swoole.websocket.Close'?=>?[ ????????????applistenerWsClose::class ????????], ????????//監聽?Test?場景 ????????'swoole.websocket.Test'?=>?[ ????????????applistenerWsTest::class ????????], ????????//加入房間事件 ????????'swoole.websocket.Join'?=>?[ ????????????applistenerWsJoin::class ????????], ????????//離開房間事件 ????????'swoole.websocket.Leave'?=>?[ ????????????applistenerWsLeave::class ????????], ????????//處理聊天室消息 ????????'swoole.websocket.RoomTest'?=>?[ ????????????applistenerRoomTest::class ????????], ????], ????'subscribe'?=>?[ ????], ];
上述的 Join、Leave和RoomTest等名稱都是自定義的,要和前端發送消息的場景值對應。
當然,事件定義一樣可以在 config/swoole.php 配置文件的 websocket listen 進行配置,具體參考前面文章。
H5 WebSocker 客戶端方式連接
wsroot.html
nbsp;HTML> ????<meta> ????<title>Document</title><button>加入房間</button> <button>離開房間</button> <input><button>發送</button> <script> var ws = new WebSocket("ws://127.0.0.1:9501/?uid=1"); ws.onopen = function(){ console.log('連接成功'); } //數據返回的解析 function mycallback(data){ var start = data.indexOf('[') // 第一次出現的位置 var start1 = data.indexOf('{') if(start < 0){ start = start1; } if(start >= 0 && start1 >= 0){ start = Math.min(start,start1); } if(start >= 0){ console.log(data); var json = data.substr(start); //截取 var json = JSON.parse(json); console.log(json); // if(json instanceof Array){ // window[json[0]](json[1]); // } } } function sendfd($message){ console.log($message) } function testcallback($message){ console.log($message) } function joincallback($message){ // console.log($message) console.log(11); } function leavecallback($message){ console.log($message) } ws.onmessage = function(data){ // console.log(data.data); mycallback(data.data); } ws.onclose = function(){ console.log('連接斷開'); } function join() { var room = prompt('請輸入房間號'); ws.send(JSON.stringify(['join',{ room:room }])); //發送的數據必須是 ['test',數據] 這種格式 } function leave() { var room = prompt('請輸入要離開的房間號'); ws.send(JSON.stringify(['leave',{ room:room }])); //發送的數據必須是 ['test',數據] 這種格式 } function send() { var message = document.getElementById('message').value; var room = prompt('請輸入接收消息的房間號') ws.send(JSON.stringify(['RoomTest',{ message:message, room:room }])); //發送的數據必須是 ['test',數據] 這種格式 } </script>
SocketIO 客戶端方式連接
ioroomtest.html
nbsp;HTML> ????<meta> ????<title>Document</title><button>加入房間</button> <button>離開房間</button> <input><button>發送</button> <script></script><script> //http 協議 var socket = io("http://127.0.0.1:9501?uid=1", {transports: ['websocket']}); socket.on('connect', function(){ console.log('connect success'); }); socket.on('close',function(){ console.log('connect close') }); //send_fd 為自定義的場景值,和后端對應 socket.on("sendfd", function (data) { console.log(data) }); //testcallback 為自定義的場景值,和后端對應 socket.on("testcallback", function (data) { console.log(data) }); socket.on("joincallback", function (data) { console.log(data) }); socket.on("roomtestcallback", function (data) { console.log(data) }); function join() { var room = prompt('請輸入房間號'); socket.emit('join',{ room : room }); } function leave() { var room = prompt('請輸入要離開的房間號'); socket.emit('leave',{ room : room }); } function send() { var message = document.getElementById('message').value; var room = prompt('請輸入接收消息的房間號') socket.emit('RoomTest',{ message : message, room : room }); } </script>
頁面中,join()、leave()、和send() 函數中定義的場景值分別是 join、leave和RoomTest,我們在 app/leave.php 中定義了這些場景值對應的事件,因此分別觸發 WsJoin.php、WsLeave.php 和 RoomTest.php 事件。
后端事件編寫
app/listener/WsJoin.php
<?php declare (strict_types = 1); namespace applistener; class WsJoin { /** * 事件監聽處理 * * @return mixed */ public function handle($event) { $ws = app('thinkswooleWebsocket'); $roomobj = app('thinkswoolewebsocketRoom'); //當前客戶端加入指定 Room $ws ->?join($event['room']); ????????//同時加入多個房間 //????????$ws?->?join(['room1','room2']); ????????//指定客戶端加入指定?room //????????$ws?->?setSender(2)?->?join($event['room']); ????????//獲取當前房間所有的?fd ????????$getAllFdInRoom?=?$roomobj?->?getClients($event['room']); ????????//獲取指定?fd?加入哪些房間 ????????$getAllRoom?=?$roomobj?->?getRooms($ws?->?getSender()); ????????var_dump('當前房間所有?fd:',$getAllFdInRoom); ????????var_dump('當前?fd?加入的所有房間:',$getAllRoom); ????????var_dump('當前請求數據:',$event); ????????$ws?->?emit('joincallback','房間加入成功'); ????} }
app/listener/WsLeave.php
<?php declare (strict_types = 1); namespace applistener; class WsLeave { /** * 事件監聽處理 * * @return mixed */ public function handle($event) { $ws = app('thinkswooleWebsocket'); $roomobj = app('thinkswoolewebsocketRoom'); // 當前客戶端離開指定 room $ws ->?leave($event['room']); ????????//?同時離開多個?room //????????$ws?->?leave(['one','two']); ????????//?指定客戶端離開指定?room //????????$ws?->?setSender(2)?->?leave($event['room']); ????????//?獲取指定?room?中的所有客戶端?fd ????????$getAllFdInRoom?=?$roomobj?->?getClients($event['room']); ????????var_dump('當前房間還剩?fd:',$getAllFdInRoom); ????????$ws?->?emit('leavecallback','房間離開成功'); ????} }
app/listener/RoomTest.php
<?php declare (strict_types = 1); namespace applistener; class RoomTest { /** * 事件監聽處理 * * @return mixed */ public function handle($event) { var_dump($event); $ws = app('thinkswooleWebsocket'); //給指定的 room 內所有 fd 發送消息,包括當前客戶端,當前客戶端沒有加入該 room 也可發送 $ws ->?to($event['room'])?->?emit('roomtestcallback',$event['message']); ????????//指定多個?room?發送消息 ????????//$ws?->?to(['one','two'])?->?emit('客戶端場景值',$event['message']); ????} }
以上分別是前端 HTML 頁面和后端的加入房間、離開房間和房間聊天事件代碼,下面開始測試。
首先在項目根目錄開啟 Think-Swoole 服務。
瀏覽器訪問 wsroot.html 或者 ioroomtest.html 頁面,可以打開多個標簽,模擬多個客戶端,我們先打開三個,連接成功后,fd 分別為1、2、3,我們讓 fd 1 和 2 的客戶端都加入“one”,房間,fd 為 3 的客戶端加入 “two” 房間,由于我們在 WsJoin.php 加入房間事件中打印了用戶加入房間所有 fd,和該用戶所加入的所有房間名稱,這些信息會打印在命令行中,最后會發送給當前客戶端聊天場景值和“加入房間成功”信息給客戶端,在瀏覽器控制臺可查看。
加入房間后,用 fd 為 1 的客戶端在頁面的輸入框輸入要發送的消息,點擊發送后,輸入要發送的房間名稱為“one”,然后,消息就發送到“one”房間,只有“one”房間的所有客戶端(fd 為1、2)能收到消息。
現在讓 fd 為 2 的客戶端離開 “one” 房間,由于在 WsLeave.php 離開房間事件中,我們打印了離開后剩余 fd,信息會出現在命令行中,可見“one”房間只剩下 fd 1 了,fd 1 發送信息,fd 2 就收不到了。
關于 WebSocket-Room 的其他功能,都已經在上述代碼中注釋了,需要可打開進行測試。
H5 WebSocket 和 SocketIO 對于消息的處理,上篇文章已經演示過了,前者對于服務端返回的消息需要手動解析才能使用,后者會根據消息的場景值接收消息,并做過處理可以直接使用。