Think-Swoole之WebSocket-Room加入、離開房間和房間訊息傳送
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' => [
app\listener\WsConnect::class
],
//監聽關閉
'swoole.websocket.Close' => [
\app\listener\WsClose::class
],
//監聽 Test 場景
'swoole.websocket.Test' => [
\app\listener\WsTest::class
],
//加入房間事件
'swoole.websocket.Join' => [
\app\listener\WsJoin::class
],
//離開房間事件
'swoole.websocket.Leave' => [
\app\listener\WsLeave::class
],
//處理聊天室訊息
'swoole.websocket.RoomTest' => [
\app\listener\RoomTest::class
],
],
'subscribe' => [
],
];上述的 Join、Leave和RoomTest等名稱都是自定義的，要和前端傳送訊息的場景值對應。
當然，事件定義一樣可以在 config/swoole.php 組態檔的 websocket listen 進行設定，具體參考前面文章。
H5 WebSocker 使用者端方式連線
wsroot.html
<!DOCTYPE HTML>
<html>
<head>
<meta charset="UTF-8">
<title>Document</title>
</head>
<body>
<button onclick="join()">加入房間</button>
<button onclick="leave()">離開房間</button>
<input type="text" id="message">
<button onclick="send()">傳送</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>
</body>
</html>SocketIO 使用者端方式連線
ioroomtest.html
<!DOCTYPE HTML>
<html>
<head>
<meta charset="UTF-8">
<title>Document</title>
</head>
<body>
<button onclick="join()">加入房間</button>
<button onclick="leave()">離開房間</button>
<input type="text" id="message">
<button onclick="send()">傳送</button>
<script src="./socketio.js"></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>
</body>
</html>頁面中，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 app\listener;
class WsJoin
{
/**
* 事件監聽處理
*
* @return mixed
*/
public function handle($event)
{
$ws = app('think\swoole\Websocket');
$roomobj = app('think\swoole\websocket\Room');
//當前使用者端加入指定 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 app\listener;
class WsLeave
{
/**
* 事件監聽處理
*
* @return mixed
*/
public function handle($event)
{
$ws = app('think\swoole\Websocket');
$roomobj = app('think\swoole\websocket\Room');
// 當前使用者端離開指定 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 app\listener;
class RoomTest
{
/**
* 事件監聽處理
*
* @return mixed
*/
public function handle($event)
{
var_dump($event);
$ws = app('think\swoole\Websocket');
//給指定的 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 對於訊息的處理，上篇文章已經演示過了，前者對於伺服器端返回的訊息需要手動解析才能使用，後者會根據訊息的場景值接收訊息，並做過處理可以直接使用。
以上就是Think-Swoole之WebSocket-Room加入、離開房間和房間訊息傳送的詳細內容，更多請關注TW511.COM其它相關文章！