ThinkPHP5 集成使用 GatewayWorker 进行即时通信的配置操作

• 背景

  首先，最近鄙人想在后台管理系统中添加一个；
  可以跟其他管理员交流的即时通讯的小窗口；
  同时也是一种学习积累；
  在资源比较中我认为 GatewayWorker 是很合适的
  于是，在此进行一番使用技巧的整理，以方便各位避免踩雷

- 环境
	框架：	ThinkPHP 5.1.40
	系统：	Windows10、CentOS7.2

• GatewayWorker 手册 (推荐详细阅读哦！)

  GatewayWorker 是基于 Workerman开发的一个项目框架，用于快速开发 TCP长连接 应用，例如 app 推送服务端、即时IM服务端、游戏服务端、物联网、智能家居 等等
  同时，提供非常方便的API，可以全局广播数据、可以向某个群体广播数据、也可以向某个特定客户端推送数据。配合 Workerman 的定时器，也可以定时推送数据 。

---

步骤指导：

• 以鄙人的操作过程为参考，请举一反三哦！！！

第一步、 首先进行框架的下载

• 首先进入【 官方下载地址】

  选择 【GatewayWorker 框架 (Linux Windows通用)】压缩文件 （附带鄙人的的 【百度网盘备份 (提取码：ahn3)】）
  以我的操作为例，为了开发方便，将解压下载后的文件夹
  直接放在了 ThinkPHP框架（网站项目） 的 "extend" 目录

  【注意】：待开发完毕后，我直接提取了整个 "GatewayWorker" 目录放置于另一台阿里云服务器，相当于作为了 【gatewayWorker 服务器】(注意下文提到的就是这个称呼)

---

第二步、进行框架的编码开发

• 建议参考 【 官方 — 与 ThinkPHP 框架的结合 】

【提示：】
	此处的代码开发，就是针对自己的业务，说的越多感觉会更糊涂，所以，此处建议参考官方文档

以下是作为本人的业务需求，进行的处理，参考时注意举一反三

• ① . 对 "\extend\GatewayWorker\Applications\YourApp\Events.php" 文件的处理

  作为 GatewayWorker 的服务端，
  针对于消息的处理业务，主要就是这一文件,
  如下，为鄙人业务的核心源码，可参照优化：

/**
     * 当客户端连接时触发
     * 如果业务不需此回调可以删除onConnect
     * @param int $client_id 连接id
     */
    public static function onConnect($client_id)
    {
        // 向当前 client_id 发送数据
        Gateway::sendToClient($client_id,json_encode(['type' => 'init', 'client_id' => $client_id]));
    }
    
   /**
    * 当客户端发来消息时触发
    * @param int $client_id 连接id
    * @param mixed $message 具体消息
    */
   public static function onMessage($client_id, $message)
   {
       //示例： $message = '{"type":"send_to_uid","uid":"xxxxx", "message":"...."}'
       $message_data = json_decode($message,true);
       if ($message_data){
           //TODO 方便区分信息传递类型
           $type = $message_data['type'];
           // 发送人ID,此处为数据库中管理员的ID
           $from_id = $message_data['from_id'];
           // 接收人ID
           $to_id = isset($message_data['to_id'])?$message_data['to_id']:0;
           switch ($type){
               case 'bind':
                   //将client_id与uid绑定，用来唯一确定一个客户端用户或者设备
                   Gateway::bindUid($client_id,$from_id);
                   $_SESSION['gateway-worker|'.$client_id] = $from_id;
                   return;
               case 'online':
                   //判断接收人是否在线
                   	$onlineStatusForTo_id = Gateway::isUidOnline($to_id);
                   	$onlineStatusForFrom_id = Gateway::isUidOnline($to_id);
                   	Gateway::sendToUid($from_id, json_encode(['type'=>'online','to_id'=>$to_id,'status'=>$onlineStatusForTo_id]));
                   	Gateway::sendToUid($to_id, json_encode(['type'=>'online','to_id'=>$from_id,'status'=>$onlineStatusForFrom_id]));
					return;
               case 'say':
                   //发送文字
                   $text = nl2br(htmlspecialchars($message_data['content']));
                   $sayData = [
                       'type' => 'say',
                       'content' => $text,
                       'from_id' => $from_id,
                       'to_id' => $to_id
                   ];
                   if (Gateway::isUidOnline($to_id)){
                       $sayData['is_read'] = 1;
                       Gateway::sendToUid($to_id, json_encode($sayData));
                   }else{
                       $sayData['is_read'] = 0;
                   }
                   Gateway::sendToUid($from_id,json_encode($sayData));
                   return;
           }
       }else{
           return;
       }
   }
   
   /**
    * 当用户断开连接时触发
    * 当 client_id下线（连接断开）时会自动与 uid 解绑，开发者无需在 onClose 事件调用
    * @param int $client_id 连接id
    */
   public static function onClose($client_id)
   {
       $uid = $_SESSION['gateway-worker|'.$client_id];
       // 向所有人发送
       $send_msg = json_encode(['type'=>'online','to_id'=>$uid,'status'=>0,'content'=>'对方掉线了！']);
       $_SESSION['gateway-worker|'.$client_id] = null;
       Gateway::sendToAll($send_msg);
       //GateWay::sendToClient($client_id,$send_msg);
   }

• ②. 前端连接需求

  一般在网站页面设计中，对于连接使用的 js 片段举例如下：

/**
 * 与 GatewayWorker 建立websocket连接，域名和端口改为你实际的域名端口，
 * 其中端口为 Gateway 端口，即 start_gateway.php 指定的端口。
 * start_gateway.php 中需要指定 websocket协议，像这样
 * $gateway = new Gateway(websocket://0.0.0.0:8282);
 */
var ws =  new WebSocket("ws://127.0.0.1:8282");
    ws.onmessage = function (e) {
        var message = eval('(' + e.data + ')');
        console.log('message', message);
        switch (message.type) {
            case 'init':
                changeNoReadLogs();
                var bind = '{"type":"bind","from_id":"' + from_id + '","to_id":"' + to_id + '"}';
                ws.send(bind);
                message_load();
                var online = '{"type":"online","from_id":"' + from_id + '","to_id":"' + to_id + '"}';
                ws.send(online);
                break;
            case 'online':
                if (message.status == 1) {
                    set_online_status(true);
                } else {
                    set_online_status(false);
                }
                return;
            case "say":
                    To_receive_message('txt',message);
                    $(".chat-content").scrollTop(3000);
                    return;
        }
    };

【建议】

    以鄙人在开发过程中的经验，
    建议对话界面的记录展示，不管是发送方还是接收方，都要放在接收信息后进行刷新
    如此一来，避免同时打卡多个页面而显得不够专业
    
    其次，注意用户离线、关闭浏览器等状况的信息获取
    此处我的处理是通过之前绑定的 $_SESSION 数据，确定用户ID
    实际业务开发中多注意灵活运用 ...

【提示】：

	对于上述的前端页面中，会出现大量的处理方法；
	注意，形如 "ws.send(message)" 的代码就是客户端向 GatewayWorker 服务端发送信息的操作；
	
	而出现的其他自定义方法，
	比如 "changeNoReadLogs()、message_load（）、save_message（）"
	一般都是向后台服务发送的业务异步处理请求操作；
	比如获取当前用户和一级管理员的聊天记录、处理发送人的未读消息、保存聊天记录 ...

【注意】:

如果前端网站所处的服务器，网络协议不同，连接也有区别

• 如果是 Windows 本地测试 可配置的连接为： 【ws://127.0.0.1:8282】;
  如果是 Linux 服务器(http 协议)， 举例 【ws://139.xxx.x.xx:8282】
  如果是 Linux 服务器(https协议)， 举例 【wss://www.wenjiehorse.com/wss】

---

第三步、 GatewayWorker 的启动与停止

• 如果是 windows 环境，这种情况基本就是本地的开发测试，直接点击运行 "start_for_win.bat" 文件即可

• ★ 如果是 Linux 环境或者是 macOS，则需要在命令行中进行操作

	php start.php start  # 以 debug（调试）方式启动   
    php start.php start -d # 以 daemon（守护进程）方式启动
 
  	php start.php stop # 停止

	php start.php restart # 重启
	php start.php reload # 平滑重启 (业务代码更改后)
	
	php start.php status # 查看状态

• ★ 在 Linux 下的启动效果如图所示：

---

第四步、websocket 的连接

• GatewayWorker 默认使用的 【8282】 端口（鄙人自定义了 8283）

  注意防火墙的端口开放，如果是 阿里云服务器 ，【注意还要设置安全组】

• 可以使用 【 WebSocket 在线测试工具】，方便测试 【gatewayWorker 服务器】是否可以连接成功

• 整合完成的效果截图如下：
  

---

附录

补充一点点个人的温馨提示，Good Luck ！

【附录 1.WSS 服务配置】

• 首先，本地开发的测试一般都能通信成功
• 而且，如果客户端为 【http】网络协议的网站，
  那么 js 代码基本就是类似—— var ws = new WebSocket("ws://47.104.110.54:8283"); 的连接方式
  出错率是很低的，基本不做赘述
• 最大的难点，个人认为是 WSS 服务配置 …

为避免篇幅冗杂，特意整理一篇 ：【鄙人在 创建 WSS服务过程中遇到的各种踩坑建议】

---

【附录 2.开启一个内部 Gateway端口，用于推送数据】

• 前面介绍的都是 客户端发起请求的对话方式
  对于后台开发的实际需求中会发现，我们更倾向于主动的推送消息

• 文档指导如下 —— 【在其它项目项目中主动推送消息】
  我在此实际操作一下文档中介绍的 【方法三、开启一个内部Gateway端口，用于推送数据】

• 首先是 start_text_gateway.php 文件的创建，此处我直接放在了 start_gateway.php 同级目录下，并且内容修改如下：

• 在项目的业务代码中，当需要进行主动推送消息时，调用如下整理的方法即可：

    public function activePushMsg(){
        // 建立连接
        $client = stream_socket_client('tcp://47.134.119.54:8227');
        if(!$client)exit("can not connect");
        // 模拟超级用户，以文本协议发送数据，
        // 注意Text文本协议末尾有换行符（发送的数据中最好有能识别超级用户的字段），
        // 这样在Event.php 中的 onMessage 方法中便能收到这个数据，然后做相应的处理即可
        fwrite($client,
            '{"type":"active-send","content":"快接着我的命令！ "}'."\n");
    }

• 后面便是 在 Event.php 中的 onMessage() 方法中便能收到这个数据，然后做相应的处理即可
  

---

【附录 3.请勿闭门造车】

• 值得一提的是：对 websocket 的原生开发是很耗费精力的
  从 socket 的连接、建立、绑定、监听等都需要开发者自己去操作完成
  而很多团队已经为我们做好了轮子，
  所以，学会使用评价好的轮子既能减少开发周期，又能避免很多的无辜踩雷
• 在此推荐几个比较成熟的框架：
  【GoEasy API，让websocket更简单】
【EasySwoole 是一款基于 Swoole Server 开发的常驻内存型的分布式PHP框架】

---

【附录 4.参考、推荐文章】

• 深入理解 GatewayWorker 框架
• HTTPS站点使用WebSocket的常见错误及解决方案
• 提供一份获取的学习视频 【 workerman实战之PHP在线客服 提取码：s1jn 】