laravel 集成 workerman/gateway-worker

1. 所需要的包 

    "workerman/gateway-worker": "^3.0",
    "workerman/gatewayclient": "^3.0",

 

2.  創建啟動文件 這里使用 artisan 

php artisan make:command  GatewayWorker

 

3. 編寫啟動文件 

<?php

namespace App\Console\Commands;

use App\Workerman\Events;
use GatewayWorker\BusinessWorker;
use Illuminate\Console\Command;
use Workerman\Worker;
use GatewayWorker\Gateway;
use GatewayWorker\Register;

class GatewayWorker extends Command
{
    /**
     * The name and signature of the console command.
     *
     * @var string
     */
    protected $signature = 'GatewayWorker {action} {--daemon}';

    /**
     * The console command description.
     *
     * @var string
     */
    protected $description = 'Start a GatewayWorker Server.';

    /**
     * constructor
     */
    public function __construct()
    {
        parent::__construct();
    }

    /**
     * Execute the console command.
     *
     *
     */
    public function handle()
    {
        global $argv;

        if (!in_array($action = $this->argument('action'), ['start', 'stop', 'restart','reload','status'])) {
            $this->error('Error Arguments');
            exit;
        }

        $argv[0] = 'gateway-worker:server';
        $argv[1] = $action;
        $argv[2] = $this->option('daemon') ? '-d' : '';

        $this->start();
    }

    private function start()
    {
        $this->startGateWay();
        $this->startBusinessWorker();
        $this->startRegister();
        Worker::runAll();
    }

    private function startBusinessWorker()
    {
        $worker = new BusinessWorker();
        $worker->name = 'BusinessWorker';                        #設置BusinessWorker進程的名稱
        $worker->count = 4;                                       #設置BusinessWorker進程的數量
        $worker->registerAddress = '127.0.0.1:1236';                        #注冊服務地址
        $worker->eventHandler = Events::class;            #設置使用哪個類來處理業務,業務類至少要實現onMessage靜態方法，onConnect和onClose靜態方法可以不用實現
    }

    private function startGateWay()
    {
        $gateway = new Gateway("websocket://0.0.0.0:1119");
        $gateway->name = 'Gateway';                         #設置Gateway進程的名稱，方便status命令中查看統計
        $gateway->count = 4;                                 #進程的數量
        $gateway->lanIp = '127.0.0.1';                       #內網ip,多服務器分布式部署的時候需要填寫真實的內網ip
        $gateway->startPort = 2000;                              #監聽本機端口的起始端口
        $gateway->pingInterval = 30;
        $gateway->pingNotResponseLimit = 0;                                 #服務端主動發送心跳
        $gateway->pingData = '{"mode":"heart"}';
        $gateway->registerAddress = '127.0.0.1:1236';                  #注冊服務地址
    }

    private function startRegister()
    {
        new Register('text://0.0.0.0:1236');
    }

}

PS： Register 的端口 以及 Gateway 、BusinessWorker 的 registerAddress 3個端口必須一致，如果是單機部署 IP可以不指定默認為 127.0.0.1  具體的啟動參數 和進程、服務設置 參考官方文檔

 

4. 編寫業務處理類 Events

　Events 類為業務處理的入口文件，當有客戶端事件發生時會觸發相應的回調  ，可實現5個靜態方法 

onWorkerStart:  當businessWorker進程啟動時觸發。每個進程生命周期內都只會觸發一次。
onConnect:  當客戶端連接上gateway進程時(TCP三次握手完畢時)觸發的回調函數。
onWebSocketConnect:  當客戶端連接上gateway完成websocket握手時觸發的回調函數.
onMessage:  當客戶端發來數據(Gateway進程收到數據)后觸發的回調函數
onClose:  客戶端與Gateway進程的連接斷開時觸發。不管是客戶端主動斷開還是服務端主動斷開，都會觸發這個回調。一般在這里做一些數據清理工作。
onWorkerStop:  當businessWorker進程退出時觸發。每個進程生命周期內都只會觸發一次。

這里我再 app/  目錄下 建立 Workerman/Events.php

<?php

namespace App\Workerman;

use GatewayWorker\Lib\Gateway;
use Illuminate\Foundation\Auth\Access\AuthorizesRequests;

class Events
{
    use AuthorizesRequests;

    /**
     *進程啟動時觸發,每個進程生命周期只會觸發一次
     *這里全局初始化工作，例如設置定時器，初始化redis等連接等
     *不要在onWorkerStart內執行長時間阻塞或者耗時的操作，這樣會導致BusinessWorker無法及時與Gateway建立連接，造成應用異常
     *無返回值,任何返回值都會被無視
     * @param $businessWorker
     */
    public static function onWorkerStart($businessWorker)
    {
        echo "Hello , This Is His App\n";
    }



    /**
     * 當客戶端連接上gateway進程時(TCP三次握手完畢時)觸發的回調函數。
     * 無返回值，任何返回值都會被視為無效的
     * $client_id是服務端自動生成的並且無法自定義。
     * 可以用過Gateway::bindUid($client_id, $uid)把自己系統的id與client_id綁定
     * @param $client_id
     */
    public static function onConnect($client_id)
    {
        Gateway::sendToCurrentClient("Your client_id is $client_id");

    }

    /**
     * 當客戶端連接上gateway完成websocket握手時觸發的回調函數。
     * 此回調只有gateway為websocket協議並且gateway沒有設置onWebSocketConnect時才有效。
     * 無返回值，任何返回值都會被視為無效的
     * $client_id    client_id固定為20個字符的字符串，用來全局標記一個socket連接，每個客戶端連接都會被分配一個全局唯一的client_id。
     * $data   websocket握手時的http頭數據，包含get、server等變量
     * @param $client_id
     * @param $data
     */
    public static function onWebSocketConnect($client_id, $data)
    {

        Gateway::sendToAll('歡迎' . $client_id);
//        var_export($data);
//        if(!isset($data['Authorization']) && !empty($data['Authorization']))
//        {
//            Gateway::sendToClient($client_id,'not Authorization');
////            Gateway::closeClient($client_id);
//        }

    }

    /**
     * 當客戶端發來數據(Gateway進程收到數據)后觸發的回調函數
     * 無返回值，任何返回值都會被視為無效的
     * @param $client_id
     * @param $message
     * @throws \Exception
     */
    public static function onMessage($client_id, $message)
    {
        Gateway::sendToAll($message);
        // 群聊，轉發請求給其它所有的客戶端
    }

    /**
     * 客戶端與Gateway進程的連接斷開時觸發。不管是客戶端主動斷開還是服務端主動斷開，都會觸發這個回調。一般在這里做一些數據清理工作。
     * @param $client_id
     * @throws \Exception
     */
    public static function onClose($client_id)
    {
        // 廣播 xxx logout
        GateWay::sendToAll("client[$client_id] logout\n");
    }
}

　5. 在你的業務代碼里使用 GatewayClient 

　　

<?php


namespace App\Http\Controllers\Api;

use App\Http\Controllers\Controller;
use GatewayClient\Gateway;

class IndexController extends Controller
{
    public function __construct()
    {
        //這里填寫Register服務的ip和Register端口，注意端口不是gateway端口 也可以用外網IP
        Gateway::$registerAddress = '127.0.0.1:1236';
    }

    public function sendMessage()
    {
        Gateway::sendToAll('當前在線人數： ' . Gateway::getAllClientCount());
        Gateway::sendToClient('xxx', 'message');
        //TODO  更多方法
    }
}

 

  到這里代碼上的就處理的差不多了，接下來看部署

 

常見問題說明

• pcntl 配置問題
  日志信息

 

Fatal error: Uncaught Error: Call to undefined function pcntl_signal() 

因為默認這個沒有啟用，解決方法：

docker-php-ext-install pcntl

• 其他依賴問題
  安裝event 需要sockets，安裝sockets 需要openssl

 

  我本地使用的是laradock  服務器使用的 dnmp

  本地  ---   

需要在 docker-composer.yml  php容器 （隨意）部分 添加端口映射 將你需要用到的都添加進去 例如

      ports:
        - "${WORKSPACE_SSH_PORT}:22"
        - "1119:1119"
        - "2000:2000"
        - "12360:12360"
        - "1236:1236"
        - "2001:2001"
        - "2002:2002"
        - "2003:2003"

然后重啟對應的容器  docker-composer restart laradock_php_1 

 

 

 

服務器  ---  dnmp 目錄下的  .env 

修改 .env ⽂件，在 PHP 擴展中新增 redis , pcntl

修改 docker-compose.yml ⽂件，在 php 模塊新增端⼝ 1119 提供 Websocket 服務

docker-composer restart php

 nginx  設置  對應的conf 配置文件中 server塊外添加

upstream ws { server php:1119; keepalive 64; }

將ws 鏈接轉發到 php:1119 

 

docker exec nginx nginx -t 

docker exec nginx nginx -s reload 

 

 

到這里就差不多啦 

 

docker exec -it php bash  cd /youApp/  php artisan GatewayWorker start   以debug 運行（或者 --daemon 守護進程方式運行）

 

雲服務器需要打開防火牆以及對應的安全組，或者策略 開放所需端口 

 

測試：

<!DOCTYPE HTML>
<html>
   <head>
   <meta charset="utf-8">
   <title>ws 測試</title>
    
      <script type="text/javascript">
         // 假設服務端ip為127.0.0.1
         ws = new WebSocket("ws://x.x.x.x:1119");
         ws.onopen = function() {
            alert("連接成功");
            ws.send('tom');
            alert("給服務端發送一個字符串：tom");
         };
         ws.onmessage = function(e) {
            alert("收到服務端的消息：" + e.data);
         };
      </script>
        
   </head>
   <body>

   </body>
</html>