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>