前言

本文的目的是基於 GatewayWorker 官方手冊，梳理一次 GatewayWorker，並在實踐中與 MVC 框架整合的思路（附最終的專案原始碼）。如果你已經理解了整合這一塊兒的知識，那麼就可以關掉這個網頁了。時間蠻寶貴的～

這篇是上篇，梳理 GatewayWorker 基礎，下篇是 GatewayWorker 與 Laravel 整合聊天室。如果你具備了 GatewayWorker 基礎，請直接閱讀下篇。

很久以前就想做一個聊天室了。查了下 "php 通訊"，找到了可用的東西：Socket、WebSocket、 Workerman 以及 GatewayWorker。Socket（介面）提供了一組端到端互相通訊的介面，作為通訊的核心功能。Websocket（協議）定義了通訊中資料的封裝和顯示的格式，而且最大的特點是它支援服務端向客戶端

所以最終我選擇了 GatewayWorker 作為 Socket 監聽的服務端，Laravel 作為 HTTP 請求的業務處理框架，完成一個響應式的線上聊天室（專案地址在下一篇文章最後）。

GatewayWorker工作原理

先理解一下工作原理，可以對 GatewayWorker 有個整體的把握。這一塊兒其實手冊

1、Register、Gateway、BusinessWorker 3 種程序依次啟動（因為支援多程序，所以我說“種”，而不是“個”）

2、Gateway 程序和 BusinessWorker 程序啟動後向 Register 服務程序發起長連線註冊自身。

3、Register 服務程序收到 Gateway 的註冊後，把所有 Gateway 程序的通訊地址寫入記憶體。

4、Register 服務程序收到 BusinessWorker 的註冊後，把記憶體中的 Gateway 程序通訊地址發給所有 BusinessWorker 程序。

5、BusinessWorker 程序收到所有 Gateway 程序的通訊地址後，嘗試連線 Gateway。

6、至此，所有 Gateway 和 BusinessWorker 程序就通過 Register 服務程序建立了長連線。

如果期間有新的 Gateway 註冊到 Register（一般是分散式部署加機器），新 Gateway 的通訊地址會被廣播給所有 BusinessWorker，BusinessWorker 收到通知後建立新連線。

如果期間有 Gateway 下線，Register 會收到通知、刪除這個 Gateway 的內部通訊地址，並將新的內部通訊地址列表廣播給所有 BusinessWorker，BusinessWorker 不再連線下線的 Gateway。

7、客戶端的連線事件和連線上的資料會經由 Gateway 轉發給 BusinessWorker，BusinessWorker 預設呼叫 Events.php 中 Events 類的 onConnect、onMessage、onClose 事件回撥處理業務邏輯。

8、BusinessWorker 負責執行所有的業務邏輯，實際的處理邏輯預設在 Events.php 中實現。

GatewayWorker程序模型

GatewayWorker 是以程序的形式進駐記憶體的，瞭解了它的工作原理之後，有必要理解一下它的程序模型。

GatewayWorker 主要有 3 種程序：Register 程序、Gateway 程序和 BusinessWorker 程序。這 3 種程序分別對應了核心原始碼中的 Register 類、Gateway 類和 BusinessWorker 類，並且它們都是基於 Workerman 框架的 Worker 類開發的，所以這 3 種程序都有一些公共的屬性，比如 name、count、onWorkerStart、onWorkerStop 等等。可以說，GatewayWorker 裡所有的程序都是 Worker 程序。

1、Register程序

Register 程序主要負責 Gateway 程序 與 BusinessWorker 程序建立連線並內部通訊。

該程序由 Register 類例項化，並隨程序啟動進駐記憶體。

它可定製的只有例項化時指定自身所在的服務程序地址。包括 IP 和埠，並且目前只支援 text 協議。text 協議是 Workerman 框架定義的一種文字協議（協議格式為：資料包 + 換行符）。

2、Gateway程序

Gateway 程序主要負責客戶端的連線以及連線上的資料，並將所有的請求轉發給 BusinessWorker 程序進行處理。BusinessWorker 程序的所有處理結果都經由 Gateway 程序轉發給客戶端。

該程序由 Gateway 類例項化，並隨程序啟動進駐記憶體。

它可定製的有：

（1）例項化。指定協議、IP 和埠。

IP："0.0.0.0" 表示監聽本機所有網絡卡；"127.0.0.1"表示僅允許本機通過 127.0.0.1 訪問該程序；內網 IP 如 "192.168.11.2" 表示只允許該 IP 訪問；外網 IP 如 "110.110.110.110" 表示只允許該 IP 訪問。

埠：大於 1024 小於等於 65535。小於 1024 時需要 root 許可權執行該程序。

（2）name：Gateway 程序名。以便在 Bash 等終端裡檢視區分。

（3）count：Gateway 程序數。充分利用多 CPU 資源。預設為 1。如何設定程序數，請參考這裡。

（4）lanIp：Gateway 程序所在伺服器的內網 IP，預設填寫 "127.0.0.1" 即可。多伺服器分散式部署 時要填寫真實 IP。無論如何都不能填寫 "0.0.0.0"。

（5）startPort：Gateway 程序啟動後監聽的起始埠（本機埠），用來給 BusinessWorker 程序提供連線服務，然後兩者通過這個埠建立通訊。假設程序數 count 為 4，起始埠 startPort 為 2003，則 會啟動 4 個 Gateway程序，各程序分別監聽 2003、2004、2005、2006 埠。

（6）registerAddress：向 Register 程序的註冊地址，格式為"IP + 埠"，如 "127.0.0.1:1236"。和 BusinessWorker 程序指定的註冊地址要保持一致。

（7）心跳設定：為了防止長時間不通訊被路由節點強行斷開或斷電斷網等極端事件，必須加心跳。相關屬性有 pingInterval、pingNotResponseLimit、pingInterval。詳細心跳設定請參考服務端到客戶端的心跳檢測。

pingInterval：心跳間隔，單位秒，0 表示不傳送心跳檢測。

pingNotResponseLimit：客戶端連續 $pingNotResponseLimit * $pingInterval 秒內不迴應心跳則斷開連線。

pingData：心跳資料，可任意，客戶端能識別就行。

（8）onWorkerStart：Gateway 程序啟動後的回撥函式。

（9）onWorkerStop：Gateway 程序關閉的回撥函式。

（10）onConnect：當有客戶端連線上來時觸發。與 Events::onConnect 的區別是 Events::onConnect 方法執行在 BusinessWorker 程序上。而 Gateway::onConnect 方法是執行在Gateway 程序上，無法使用 \GatewayWorker\Lib\Gateway 類提供的介面。

（11）onClose：當有客戶端連線關閉時觸發。同樣與Events::onClose的區別是 Gateway::onClose 方法是執行在 Gateway 程序上，無法使用 \GatewayWorker\Lib\Gateway 類提供的介面。

3、BusinessWorker程序

BusinessWorker 程序負責執行業務邏輯。BusinessWorker 程序收到 Gateway 程序轉發來的事件和請求時，會預設呼叫 Events.php 中的 onConnect、onMessage、onClose 方法處理事件和資料。

該程序由 BusinessWorker 類例項化，並隨程序啟動進駐記憶體。

它可定製的有：

（1）name：BusinessWorker 程序名。以便在 Bash 等終端裡檢視區分。

（2）count：BusinessWorker 程序數。充分利用多 CPU 資源。預設為 1。如何設定程序數，請參考這裡。

（3）registerAddress：向 Register 程序的註冊地址，格式為"IP + 埠"，如 "127.0.0.1:1236"。和 Gateway 程序指定的註冊地址要保持一致。

（4）onWorkerStart：BusinessWorker 程序啟動後的回撥函式

（5）onWorkerStop：BusinessWorker 程序關閉的回撥函式。

（6）eventHandler：指定 BusinessWorker 程序裡實際處理業務邏輯的類，預設是 Events。也就是預設使用 Events.php 中的 Events 類來處理業務。業務類至少要實現onMessage 靜態方法，onConnect 和 onClose 靜態方法可以不用實現。（如果使用了名稱空間，建議填寫完全限定名稱的名稱空間。）

 。

Events.php 

上面提到了 Events.php，它是實際處理業務邏輯的類 Events 所在的檔案。我們在實際的開發中，只需要關注這一個檔案。

Events 裡有 5 個事件回撥的處理方法，按照發生順序，依次是

• onWorkerStart (Worker $businessWorker)：當 BusinessWorker 程序啟動時觸發。每個程序生命週期內只觸發一次。

• onConnect (string $client_id)：當客戶端連線上 Gateway 程序時觸發（TCP 三層握手）。

• onMesssge (string $client_id, mixed $recv_data)：當客戶端發來資料，也就是 Gateway 程序收到資料後觸發。

• onClose (string client_id)：當客戶端連線斷開時觸發。無論是客戶端還是服務端主動斷開，都會觸發。

• onWorkerStop (Worker $businessWorker)：當 BusinessWorker 程序退出時觸發。每個程序生命週期內只觸發一次。

這裡面我們常用到的是 onMessage 和 onClose 回撥，其他比較少用。

上面的回撥事件裡有一個比較重要的引數：$client_id。client_id 是 20 個字元的定長字串，用來全域性標識一個 Socket 連線。每個客戶端連線都會被分配一個全域性唯一的 client_id。客戶端關閉連線時，對應的 client_id 會失效。當客戶端再次開啟一個 Socket 連線時，會被分配一個新的 client_id。

Lib\Gateway類提供的介面

既然（預設）在 Events.php 中處理實際的業務邏輯，回撥的事件我們已經知道了。那麼怎麼向客戶端傳送訊息呢？

名稱空間 \GatewayWorker\Lib\Gateway 指向的這個 Gateway 類，提供了一組單發、群發和廣播的介面，在 Events.php 中向客戶端發信的時候就可以使用這個類。它提供的介面非常豐富：

Gateway::sendToAll($data);      // 向所有客戶端傳送資料
Gateway::sendToClient($client_id, $data);  // 向某個客戶端傳送資料
Gateway::closeClient($client_id);      // 關閉某個客戶端
Gateway::isOnline($client_id);  // 判斷某客戶端連線是否線上 
Gateway::bindUid($client_id, $uid);    // 繫結 uid 與 client_id 
Gateway::unbindUid($client_id, $uid);  // 取消 uid 與 某個 client_id 的繫結
Gateway::isUidOnline($uid);      // 某個 uid 是否線上
Gateway::GetClientIdByUid();     // 獲取與 uid 繫結的 client_id 列表(一對多)
Gateway::sendToUid($uid, $data); // 向所有 uid 傳送
Gateway::joinGroup($client_id, $group);  // 把該 client_id 加入群組
Gateway::leaveGroup($client_id, $group); // 將 client_id 離開群組
Gateway::sendToGroup($group, $data);     // 向某群組 group 傳送
Gateway::getClientCountByGroup($group);  // 獲取某個組的線上連線數
Gateway::getClientSessionsByGroup($group); // 獲取某個組的連線資訊
Gateway::getClientInfoByGroup($group);   // getClientSessionsByGroup 的別名
Gateway::getAllClientCount();     // 獲取所有的線上連線數
Gateway::getAllClientSessions();  // 獲取所有線上使用者的 session
Gateway::getAllClientInfo();      // getAllClientSessions 的別名
Gateway::setSession($client_id, $session);      // 設定 session，原 session 值會被覆蓋
Gateway::updateSession($client_id, $session);   // 更新 session，實際上是與舊的session合併
Gateway::getSession($client_id);  // 獲取某個 client_id的 session

 這裡面比較重要的是 GatewayWorker 的超全域性陣列 $_SESSION。每個客戶端連線對應一個 Session 會話，並由 Gateway 程序儲存在記憶體裡。示例如下，在收到客戶端訊息時，列印所有線上連線的 Session：

use \GatewayWorker\Lib\Gateway;

class Events
{
    ...
    public onMessage($client_id, $message)
    {
        $_SESSION['name'] = $message['name']; // 操作當前使用者的 Session 時，直接使用 $_SESSION 即可
        var_export(Gateway::getAllClientSessions());
    }
    ...
}
打印出的資料類似如下：

array(
    '7f00000108fc00000008' => array('name' => 'Tom'),
    '7f00000108fc00000009' => array('name' => 'Joan')
)

注意上面的註釋，操作當前連線上的 Session 時，直接使用 $_SESSION['xx'] = 'xxx'; 的方式賦值即可，操作其他使用者的 Session 時用  Gateway::setSession 介面。

此外，如果你在 GatewayWorker 的程序模型裡需要獲取客戶端、服務端的 IP，請使用 $_SERVER 陣列。它由 Workerman 框架定義，內建了 5 個數組成員，陣列 key 分別如下，詳細請參考文件。

REMOTE_ADDR   // 客戶端IP（如果客戶端處於區域網，則是客戶端所在區域網的出口IP）
REMOTE_PORT   // 客戶端埠（如果客戶端處於區域網，則是客戶端所在區域網的出口埠）
GATEWAY_ADDR  // Gateway 程序所在伺服器的 IP
GATEWAY_PORT  // Geteway 監聽的埠，這對於多埠應用中在 Events.php 裡區分客戶端連的是哪個埠非常有用。
GATEWAY_CLIENT_ID  // 全域性唯一的客戶端 IP

好的。有關 GatewayWorker 框架的基礎暫時就梳理這麼多。更多 GatewayWorker 開發和部署的細節或問題，比如心跳檢測、設定定時器、合理選擇多程序、分散式部署、定製通訊協議、啟用 wss 協議等等，都在文件裡有詳細的介紹。車在下面。

我感覺這一篇有點長了，所以將在下一篇開始梳理 GatewayWorker 與 Laravel 框架的整合。

相關連結