聊天室（下篇）GatewayWorker 與 Laravel 的整合

来源:https://www.cnblogs.com/mingc/archive/2018/01/24/8338246.html
-Advertisement-
Play Games

思路 上一篇大概梳理了一下 GatewayWorker 的基礎知識。這篇就來準備整合 GatewayWorker 到 Laravel。 GatewayWorker 是基於 Socket 監聽的伺服器框架，而 Laravel 是基於 HTTP 請求/響應模型的 Web 框架。所以一定要明白，兩者的部署 ...


思路

上一篇大概梳理了一下 GatewayWorker 的基礎知識。這篇就來準備整合 GatewayWorker 到 Laravel。

 

GatewayWorker 是基於 Socket 監聽的伺服器框架，而 Laravel 是基於 HTTP 請求/響應模型的 Web 框架。所以一定要明白，兩者的部署是獨立分開、互不幹擾的。

因此在物理上它們的整合方式就見仁見智了。而官方, walkor 大神（GatewayWorker 框架作者）在手冊里也給出了與 MVC 框架的結合方式，如下圖所示：

客戶端瀏覽器建立與 GatewayWorker 的 WebSocket 連接，所有的業務邏輯由客戶端通過 HTTP 協議 GET/POST 到 Web 框架，由 Web 框架統一處理。僅當客戶端瀏覽器需要主動推送數據時， Web 框架將調用 GatewayWorker 提供的 API（GatewayClient），由 GatewayWorker 通過 WebSocket 主動推送給客戶端。

 

步驟

大致的思路有了，具體的實現步驟配合聊天室部分代碼，如下所示。

首先要定製 GatewayWorker 的所有進程，並把它整合到 laravel 項目根目錄下的 gatewayworker 目錄，該目錄的結構遵循了官方推薦：

gatewayworker/
├── app
│   └── chat
│       ├── Events.php                 # BusinessWorker 進程的實際業務處理類
│       ├── start_businessworker.php   # BusinessWorker 進程的啟動文件
│       ├── start_gateway.php          # Gateway 進程的啟動文件
│       └── start_register.php         # Register 服務進程的啟動文件
├── composer.json
├── composer.lock
├── start_for_win.bat                  # Windows 環境下 GatewayWorker 所有 Worker 進程的啟動文件
├── start.php                          # Linux 環境下 GatewayWorker 所有 Worker 進程的啟動文件
└── vendor

整個 gatewayworker/ 目錄的結構和源碼幾乎與官方的 workerman-chat 一模一樣。僅有 Events.php 略有不同。

start.php 負責啟動所有的 worker 進程：

// 載入所有applications/*/start.php，以便啟動所有服務
foreach(glob(__DIR__.'/app/*/start*.php') as $start_file) {
    require_once $start_file;
}

// 運行所有服務
Worker::runAll();

start_register.php 負責啟動 Register 進程，監聽本機 1238 埠，以便 Gateway 進程與 BuisnessWorker 進程建立通信。

$register = new Register('text://0.0.0.0:1238'); // 必須text協議

start_gateway.php 負責啟動 Gateway 進程，監聽客戶端在 7272 埠、基於 WebSocket 協議的連接和連接上的數據。同時設置進程名、進程數、lanIp、起始埠和心跳檢測，以及註冊通信地址。

$gateway = new Gateway("Websocket://0.0.0.0:7272");
$gateway->name = 'ChatGateway';
$gateway->count = 4;
$gateway->lanIp = '127.0.0.1'; // 分散式部署時要填寫真實IP（非127.0.0.1）
$gateway->startPort = 2300;
$gateway->pingInterval = 10;   // 設置心跳，防止長時間不通訊被路由節點強行斷開
$gateway->pingData = '{"type":"ping"}';
$gateway->registerAddress = '127.0.0.1:1238'; // 用於和BusinessWorker進程通信，與Gateway進程的註冊地址保持一致

start_businessworker.php 負責啟動 BusinessWorker 進程，設置進程名、進程數，以及註冊通信地址。

$worker = new BusinessWorker();
$worker->name = 'ChatBusinessWorker';
$worker->count = 4;
$worker->registerAddress = '127.0.0.1:1238'; // 用於和Gateway進程通信，與Gateway進程的註冊地址保持一致

Events.php 中只負責兩件事：

第一件、當客戶端建立連接時，在 onConnect 回調中把 client_id 發送給客戶端（讓客戶端通過 AJAX 請求 Web 框架去綁定 uid 與 client_id）。

第二件、當客戶端連接關閉時，在 onClose 回調中通過該 client_id 獲取該用戶所在的 room_id（聊天室唯一 ID，由 Laravel 生成），並使用 Gateway::sendToGroup($group) 向該房間推送一個客戶離開信號（客戶端收到這個信號會發起 AJAX 請求向 Web 框架請求最新的用戶列表）。

而 onMessage 回調留空即可。前面已經說過，我們所有的業務邏輯，都儘量在 Web 框架里實現。GatewayWorker 只提供 Socket 服務。

下麵是 Events.php 中的部分代碼。

public static function onConnect($client_id)
{
    Gateway::sendToClient($client_id, json_encode(array(
        'type'      => 'init',
        'client_id' => $client_id
    )));
}

public static function onMessage($client_id, $message)
{

}

public static function onClose($client_id)
{
    // 房間廣播有連接關閉的信號
    $room_id = $_SESSION['room_id'];
    $uname   = $_SESSION['uname'];

    if (Gateway::getClientCountByGroup($room_id)) {
        Gateway::sendToGroup($room_id, json_encode(array(
            'type'      => 'close',
            'uname'     => $uname
        )));
    }   
}

 

然後把所有的 Worker 進程運行起來，開始建立內部通信並監聽客戶端連接。使用 php start.php start -d 將以守護進程的形式運行所有 Worker進程。

下麵在聊天室頁面建立與 GatewayWorker 的 WebSocket 連接

var ws = new WebSocket("ws://" + document.domain + ":7272");

註意，websocket 協議來自於 HTML5，某些瀏覽器可能不支持，可以用 gimite 大牛提供的 web-socket-js 插件，它是以 Flash 實現的 WebSocket。

然後在 ws.onmessage 回調中接收來自 GatewayWorker 發來的 client_id，並用 AJAX 發送 POST 請求到 Laravel 框架，進行綁定 uid 與 client_id 的綁定。

前端 Websocket 接收 client_id，併發送請求綁定 uid：

ws.onmessage = function(e) {
    var data = JSON.parse(e.data),
          type = data.type || '';

    switch (type) {
        ...
        case 'init':
            $.post(global_url_bind, {
                client_id: data.client_id,
                _token: global_csrf_token
            }, function(data) {}, 'json');
            break;
        ...
    }
}

後端 Laravel 需要調用 GatewayClient API 通知 GatewayWorker 綁定 client_id，首先在 Laravel 項目（聊天室）根目錄下運行 Composer 命令來安裝：

composer require workerman/gatewayclient

然後在需要調用 GatewayClient 介面的文件里，引用命名空間：

// GatewayClient 3.0.0版本以後加了命名空間
use GatewayClient\Gateway;

並設置  Gateway::$registerAddress 屬性，告知 GatewayClient 與哪個 GatewayWorker （集群）通訊。方便起見，我把它放在了 Laravel 控制器的 __construct() 方法里：

public function __construct()
{
    Gateway::$registerAddress = '127.0.0.1:1238';
}

這裡再啰嗦一句，這個屬性的設置值必須與前面啟動的 Gateway 進程和 BusinessWorker 進程的 registerAddress 屬性值一致，其中的 1238 埠是由 Register 服務進程監聽的，用於 Gateway 進程和 BusinessWorker 進程內部通訊。

然後，後端 Laravel 綁定 client_id 的代碼片段如下：

// 綁定uid和client_id、加入房間
Gateway::bindUid($client_id, $uid);  // uid 與 room_id 已經從 Laravel session里獲取
Gateway::joinGroup($client_id, $room_id);

// 記錄會話
session(['client_id' => $client_id]); // Laravel 負責
Gateway::setSession($client_id, [     // GatewayWorker 負責
    'uid'     => $uid,
    'uname'   => $uname,
    'avatar'  => $avatar,
    'bubble'  => $bubble,
    'room_id' => $room_id
]);

後續的所有房間消息都直接 get/post 到 Laravel 里統一處理。下麵是聊天部分的部分源碼：

前端 AJAX：

$.post(global_url_say, {
    type: 'all', // 公聊
    content: content,
    _token: global_csrf_token
}, function(data) {}, 'json');

$.post(global_url_say, {
    type: 'to', // 私聊
    to_uid: $('.to-whom').children('span').attr('id'),
    to_uname: $('.to-whom').children('span').text(),
    content: content,
    _token: global_csrf_token
}, function(data) {}, 'json');

後端 Laravel： 

$type      = $request->input('type') ?: '';
$content   = htmlspecialchars($request->input('content'));
$uid       = session('uid');
$uname     = session('uname');
$avatar    = session('avatar');
$bubble    = session('bubble');
$room_id   = session('room_id');

switch ($type) {
    case 'all': // 公聊
        Gateway::sendToGroup($room_id, json_encode([
            'type'      => 'all',
            'uid'       => $uid,
            'uname'     => $uname,
            'avatar'    => $avatar,
            'bubble'    => $bubble,
            'content'   => preg_replace('/^\s*@me/i', '', $content)
        ]));
        break;
    case 'to':  // 私聊
        $to_uid = $request->input('to_uid');
        Gateway::sendToUid($to_uid, json_encode([
            'type'      => 'to',
            'uid'       => $uid,
            'uname'     => $uname,
            'avatar'    => $avatar,
            'bubble'    => $bubble,
            'content'   => '<a href="javascript:;" style="color: inherit;">@me</a> '.$content
        ]));
        $to_uname = $request->input('to_uname');
        Gateway::sendToUid($uid, json_encode([
            'type'      => 'to',
            'uid'       => $uid,
            'uname'     => $uname,
            'avatar'    => $avatar,
            'bubble'    => $bubble,
            'content'   => '<a href="javascript:;" style="color: inherit;">@'.$to_uname.'</a> '.$content
        ]));
        break;
    ...
}

當有用戶退出房間時，前端 Websocket 會收到來自 Events.php 中 onClose 事件的連接關閉信號 "close"。這時需要通知房間內其他用戶，並請求 Laravel 拿最新的用戶列表。

 ws.onmessage = function(e) {
    var data = JSON.parse(e.data),
        type = data.type || '';

    switch (type) {
        ...
        case 'close':
            // 通知有人退出
            system_notify('@' + data.uname + ' leaved out.');

            // 請求新的用戶列表
            $.post(global_url_flush, {
                room_id: global_room_id,
                _token: global_csrf_token
            }, function(data) { });
            break;
        ...
    }
}

後端：

$room_id = $request->input('room_id');
$sessions = Gateway::getClientSessionsByGroup($room_id);
$users_list = [];
foreach ($sessions as $client_id => $item) {
    $users_list[$item['uid']] = $item['uname'];
}
$new_message = ['type' => 'flush'];
$new_message['users_list'] = $users_list;
Gateway::sendToGroup($room_id, json_encode($new_message));

然後前端收到 flush 消息，刷新用戶列表：

ws.onmessage = function(e) {
    var data = JSON.parse(e.data),
        type = data.type || '';
    
    switch (type) {
        ...
        case 'flush':
            flush_users_list(data.users_list);
            break;
        ...
    }
}

基本的結合邏輯就是這樣了。如果對這個聊天室的源碼有興趣，可以在下麵找到它的地址。謝謝閱讀。

 

2018-01-26 13:12:19 更新：

聊天室項目已經支持 Windows。

 

相關鏈接

chat-here 聊天室源碼：https://github.com/mingcw/chat-here（這兩天時間有點緊，等 25 號晚上我會添加它的 windows 版本，目前只支持 Linux。）

GatewayClient API：https://github.com/walkor/GatewayClient

 


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • 利用nodejs讀取資料庫數據生成樹結構的json數據
    在做後臺管理界面的時候，幾乎少不了的一個結構就是樹形結構，用來做菜單導航； 那麼，最希望的就是樹結構的所有數據都是讀取的資料庫，而不是直接代碼當中寫死，那我們就一步一步來看： 一，建表 欄位通常包括：id，text，url，pid 二，使用nodeJS連接資料庫 三，讀取數據 四，把讀過來的數據轉成 ...
  • 詳解HTTP緩存
    HTTP緩存是個大公司面試幾乎必考的問題，寫篇隨筆說一下HTTP緩存。 1. HTTP報文首部中有關緩存的欄位 在HTTP報文中，與緩存相關的信息都存在首部里，簡單說一下首部。 首部 HTTP首部欄位向請求報文和相應報文中添加了一些附加信息。本質上來說，它們只是一些鍵值對的列表。比如，下麵的首部行會 ...
  • vue從入門到進階：vue-router路由功能（九）
    基本使用 html: JavaScript: 通過註入路由，我們可以用 this.$router 來訪問它，就像在任何組件里用 this.$router 訪問當前路有一樣。 路由的命名 要鏈接到一個命名路由，可以給 router-link 的 to 屬性傳一個對象： 這跟代碼調用 router.pu ...
  • 前端分頁
    對於前端分頁，不懂的人也許會覺得是個笑話，分頁不都是後端的事情嗎？的確不得不承認，處理邏輯性的話，還是後端更加友好，但前端分頁，也有他友好的一面，舉個慄子：伺服器壓力請求減少，換頁時用戶體驗好。直戳主題——前端實現分頁的原理及其步驟 ...
  • (六)：大型項目容器化改造
    虛擬化和容器化是項目雲化不可避免的兩個問題。虛擬化由於是純平臺操作，一個運行於linux操作系統的項目幾乎不需要做任何改造就可以支持虛擬化。而項目如果要支持容器化則需要做許多細緻的改造工作。容器化相對於虛擬化的優勢也相當明顯，運行於裸機性能高，秒級啟停容器，更不用說開發、測試、佈署一致的環境(Dev... ...
  • 客戶端一致性與多Leader機制------《Designing Data-Intensive Applications》讀書筆記7
    接著上一篇的內容，我們繼續來梳理分散式系統之中的副本機制與副本一致。上文我們聊到了在可用性與一致性之間的一個折中的一致性等級： 最終一致性 。我們順著上篇的內容，由用戶來分析一致性等級。 1. 客戶端的困擾 上篇文章我們提到了數據系統常用的模型，當提交新數據時，必須將它發送給Leader節點，但是當 ...
  • Python 獲得命令行參數的方法
    本篇將介紹python中sys, getopt模塊處理命令行參數 本篇將介紹python中sys, getopt模塊處理命令行參數 如果想對python腳本傳參數，python中對應的argc, argv(c語言的命令行參數)是什麼呢？需要模塊：sys參數個數：len(sys.argv)腳本名： s ...
  • [數據分析工具] Pandas 不可不知的功能（一）
    如果你在使用 Pandas（Python Data Analysis Library） 的話，下麵介紹的對你一定會有幫助的。 如果你在使用 Pandas（Python Data Analysis Library） 的話，下麵介紹的對你一定會有幫助的。 如果你在使用 Pandas（Python Dat ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發（一）：使用.NET MAUI開發第一個安卓APP
    移動開發（一）：使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說，近來想嘗試開發一款安卓APP，考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP，畢竟是使用Visual Studio開發工具，使用起來也比較的順手，結合微軟官方的教程進行了安卓 ...
  • wpf ToggleButton選中效果和一個登錄界面
    前言 QuestPDF 是一個開源 .NET 庫，用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫，它徹底改變了我們生成 PDF 文檔的方 ...
  • 彈幕樹洞項目功能新增篇
    項目地址 項目後端地址： https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址： ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址： http://tree ...
  • 第27篇 sqlserver2022詳細安裝步驟
    話不多說，直接開乾 一.下載 1.官方鏈接下載： https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe，運行開始下載SQL server； 二. ...
  • .NET 開源高性能 MQTT 類庫
    前言 隨著物聯網（IoT）技術的迅猛發展，MQTT（消息隊列遙測傳輸）協議憑藉其輕量級和高效性，已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫，為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog文檔翻譯系列（六） - 可用的接收器、增強器、格式化輸出
    Serilog支持多種接收器用於日誌存儲，增強器用於添加屬性，LogContext管理動態屬性，支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項，適用於不同需求。 ...
  • 警惕 Visual Studio 屬性求值副作用導致邏輯不符合預期
    目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據，爬取信息時需要模擬瀏覽器行為，否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下： 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • [使用目前最新版]HybridCLR6.9.0+YooAsset2.2.4實現純C# Unity熱更新方案 (一)
    1.前言 什麼是熱更新 游戲或者軟體更新時，無需重新下載客戶端進行安裝，而是在應用程式啟動的情況下，在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR，Xlua，ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles，Addressable， ...
  • 在 ASP.NET Core Web API 中使用操作篩選器統一處理通用操作
    本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺，其實像阿裡雲，騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後，它會送 ...
  • 第28篇 如何.net中實現高效可靠數據同步api
    通過以下方式可以高效，並保證數據同步的可靠性 1.API設計 使用RESTful設計，確保API端點明確，並使用適當的HTTP方法（如POST用於創建，PUT用於更新）。 設計清晰的請求和響應模型，以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證，確保接收到的數據符合預期格 ...
所有分類