在其它项目项目中主动推送消息

需求

有时候需要在非GatewayWorker环境中向客户端推送数据。例如在一个普通的Web项目中通过GatewayWorker推送数据（前提是已经部署了GatewayWorker，客户端已经连接GatewayWorker）。目前有三种比较方便方法推送数据。

方法一、使用GatewayClient客户端推送，接口与GatewayWorker中的接口一致

客户端源码：

https://github.com/walkor/GatewayClient

GatewayWorker1.0请使用1.0版本的GatewayClient

GatewayWorker2.0.1-2.0.4请使用2.0.4版本的GatewayClient

GatewayWorker2.0.5-2.0.6版本请使用2.0.6版本的GatewayClient

GatewayWorker2.0.7版本请使用 2.0.7版本的GatewayClient

GatewayWorker3.0.0及以上版本请使用 3.0.0版本的GatewayClient

GatewayWorker3.0.8及以上版本请使用 3.0.13及以上版本的GatewayClient 注意：GatewayClient3.0.0开始支持composer并加了命名空间GatewayClient

查看GatewayWorker版本方法请点击点击这里

注意：

  • 下载后GatewayClient目录可以放在项目中的任意位置，只要项目能引用到GatewayClient/Gateway.php即可。

  • 如果GatewayClient和GatewayWorker不是在同一台服务器上，则需要先将start_gateway.php中的lanIp改成当前服务器的内网ip（如果不在一个内网可改成公网ip，需要GatewayWorker版本>=v3.0.22）。注意，无论何时lanIp都不能写成0.0.0.0，否则将无法通讯。

注意 GatewayClient跨公网通讯需要GatewayWorker版本>=v3.0.22 跨公网通讯有风险，建议都放在一个内网。

  • 如果GatewayClient和GatewayWorker不是在同一台服务器上，还要设置防火墙(云服务器的话还要设置安全组)让以下端口可以被GatewayClient所在服务器访问：1、start_gateway.php中的$gateway->startPort起始的几个端口(要开放的端口个数和$gateway->count有关)。2、start_register.php中的Register服务端口 反之如果GatewayClient和GatewayWorker在同一台服务器上运行，则不用做任何更改，直接按照示例使用GatewayClient即可。

  • 通过GatewayClient发送的数据不会经过Event.php，而是直接经由Gateway进程转发给客户端。

  • GatewayClient无法接收客户端发来的数据。

  • GatewayClient无法直接用$_SESSION变量来操作GatewayWorker的session，但可以用Gateway::setSession/getSession/updateSession等接口操作GatewayWorker的session。

    客户端使用示例

  1. require_once '/your/path/GatewayClient/Gateway.php';
  3. /**
  4.  * gatewayClient 3.0.0及以上版本加了命名空间
  5.  * 而3.0.0以下版本不需要use GatewayClient\Gateway;
  6.  **/
  7. use GatewayClient\Gateway;
  9. /**
  10.  *====这个步骤是必须的====
  11.  *这里填写Register服务的ip和Register端口，注意端口不是gateway端口
  12.  *ip不能是0.0.0.0，端口在start_register.php中可以找到
  13.  *这里假设GatewayClient和Register服务都在一台服务器上，ip填写127.0.0.1。
  14.  *如果不在一台服务器则填写真实的Register服务的内网ip(或者外网ip)
  15.  **/
  16. Gateway::$registerAddress = '127.0.0.1:1236';
  19. // 以下是调用示例，接口与GatewayWorker环境的接口一致
  20. // 注意除了不支持sendToCurrentClient和closeCurrentClient方法
  21. // 其它方法都支持
  22. Gateway::sendToAll($data);
  23. Gateway::sendToClient($client_id, $data);
  24. Gateway::closeClient($client_id);
  25. Gateway::isOnline($client_id);
  26. Gateway::bindUid($client_id, $uid);
  27. Gateway::isUidOnline($uid);
  28. Gateway::getClientIdByUid($client_id);
  29. Gateway::unbindUid($client_id, $uid);
  30. Gateway::sendToUid($uid, $data);
  31. Gateway::joinGroup($client_id, $group);
  32. Gateway::sendToGroup($group, $data);
  33. Gateway::leaveGroup($client_id, $group);
  34. Gateway::getClientCountByGroup($group);
  35. Gateway::getClientSessionsByGroup($group);
  36. Gateway::getAllClientCount();
  37. Gateway::getAllClientSessions();
  38. Gateway::setSession($client_id, $session);
  39. Gateway::updateSession($client_id, $session);
  40. Gateway::getSession($client_id);
  41. ...

方法二、用一个特殊的账号当做管理客户端，通过这个账号推送数据

此方法通俗易懂，可以通过现有客户端直接操作，具体代码根据自己的业务实现

方法三、开启一个内部Gateway端口，用于推送数据

方法二虽然简单，但是局限于只能通过客户端界面操作，定时推送等需求不好直接操作客户端，而通过PHP模拟客户端可能会受到复杂协议的限制不好操作，这时我们可以开启一个内部文本协议的Gateway端口，通过PHP代码使用文本协议连接WorkerMan作为客户端向其它客户端推送数据。

示例（workerman-chat为例）

服务端： 新建文件Applications/Chat/start_text_gateway.php，用于增加一个文本协议Gateway端口，内容如下

  1. <?php
  2. use \Workerman\Worker;
  3. use \GatewayWorker\Gateway;
  4. use \Workerman\Autoloader;
  5. require_once __DIR__ . '/../../Workerman/Autoloader.php';
  6. Autoloader::setRootPath(__DIR__);
  8. // #### 内部推送端口(假设当前服务器内网ip为192.168.100.100) ####
  9. // #### 端口不能与原来start_gateway.php中一样 ####
  10. $internal_gateway = new Gateway("Text://192.168.100.100:7273");
  11. $internal_gateway->name='internalGateway';
  12. // #### 不要与原来start_gateway.php的一样####
  13. // #### 比原来跨度大一些，比如在原有startPort基础上+1000 ####
  14. $internal_gateway->startPort = 3300;
  15. // #### 这里设置成与原start_gateway.php 一样 ####
  16. $internal_gateway->registerAddress = '127.0.0.1:1236';
  17. // #### 内部推送端口设置完毕 ####
  19. if(!defined('GLOBAL_START'))
  20. {
  21.     Worker::runAll();
  22. }

客户端： 在其它项目中就可以直接用PHP socket 使用文本协议调用，代码类似如下:

  1. // 建立连接，@see https://php.net/manual/zh/function.stream-socket-client.php
  2. $client = stream_socket_client('tcp://192.168.100.100:7273');
  3. if(!$client)exit("can not connect");
  4. // 模拟超级用户，以文本协议发送数据，注意Text文本协议末尾有换行符（发送的数据中最好有能识别超级用户的字段），这样在Event.php中的onMessage方法中便能收到这个数据，然后做相应的处理即可
  5. fwrite($client, '{"type":"send","content":"hello all", "user":"admin", "pass":"******"}'."\n");