Think-Swoole之WebSocket-Room加入、離開房間和房間訊息發送
- 藏色散人轉載
- 2020-10-21 17:17:352868瀏覽
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加入、離開房間和房間訊息發送的詳細內容。更多資訊請關注PHP中文網其他相關文章！
陳述：
本文轉載於：阿dai哥。如有侵權，請聯絡admin@php.cn刪除