文档、文件下载地址
聊天库： Workerman
文档: http://doc2.workerman.net/
手册: http://www.workerman.net/gatewaydoc/
下载Demo: http://doc2.workerman.net/
CatewayWorker 服务端安装 Liunx: http://www.workerman.net/download/GatewayWorker.zip
CatewayWorker 服务端安装 Window: http://www.workerman.net/download/GatewayWorker-for-win.zip
GatewayWorker框架与MVC结合总体原则:
现有mvc框架项目与GatewayWorker独立部署互不干扰
所有的业务逻辑都由网站页面post/get到mvc框架中完成
GatewayWorker不接受客户端发来的数据，即GatewayWorker不处理任何业务逻辑，GatewayWorker仅仅当做一个单向的推送通道
仅当mvc框架需要向浏览器主动推送数据时才在mvc框架中调用Gateway的API GatewayClient完成推送。
MVC框架(客户)端安装
composer 安装 GatewayClinet 客户端
composer require workerman/gatewayclient
//使用时引入vendor/autoload.php 类似如下： use GatewayClient\Gateway; require_once '真实路径/vendor/autoload.php';
或是下载源文件到任意目录，手动引入 GatewayClient/Gateway.php, 类似如下：
use GatewayClient\Gateway; require_once '真实路径/GatewayClient/Gateway.php';
服务端安装
CatewayWorker 服务端安装，可以直接下载源文件
composer require workerman/gateway-worker-for-win //安装Windows版本的gateway composer require workerman/gateway-worker //安装Linux版本的gateway
服务端项目目录结构，GatewayWorker单独部署的
├── Applications // 这里是所有开发者应用项目 │ └── YourApp // 其中一个项目目录，目录名可以自定义 │ ├── Events.php // 开发者只需要关注这个文件 │ ├── start_gateway.php // gateway进程启动脚本，包括端口号等设置 │ ├── start_businessworker.php // businessWorker进程启动脚本 │ └── start_register.php // 注册服务启动脚本 │ ├── start.php // 全局启动脚本，此脚本会依次加载Applications/项目/start_*.php启动脚本 │ └── vendor // GatewayWorker框架和Workerman框架源码目录，此目录开发者不用关心
服务端文件操作
创建 start.bat，一般放根目录，Window 启动文件，双击
php worker\win\start_register.php worker\win\start_gateway.php worker\win\start_businessworker.php pause
创建 start.php，一般放根目录，Liunx 启动文件，命令行 php start.php start
/** * run with command * php start.php start 官网文件 */ ini_set('display_errors', 'on'); use Workerman\Worker; if(strpos(strtolower(PHP_OS), 'win') === 0) { exit("start.php not support windows, please use start_for_win.bat\n"); } // 检查扩展 if(!extension_loaded('pcntl')) { exit("Please install pcntl extension. See http://doc3.workerman.net/appendices/install-extension.html\n"); } if(!extension_loaded('posix')) { exit("Please install posix extension. See http://doc3.workerman.net/appendices/install-extension.html\n"); } // 标记是全局启动 define('GLOBAL_START', 1); require_once __DIR__ . '/worker/vendor/autoload.php'; // 加载所有Applications/*/start.php，以便启动所有服务， 此处我放根目录/worker/win/ 下，其他要启动的文件是start.bat文件中指定的文件 foreach(glob(__DIR__.'/worker/win/start*.php') as $start_file) { require_once $start_file; } // 运行所有服务 Worker::runAll();
两种启动方式 ，start_gateway.php start_businessworker.php start_register.php分别是进程启动脚本，三个脚本统一由根目录的start.php/ start.bat启动。
start_register.php 为注册服务启动脚本，用于协调GatewayWorker集群内部Gateway与Worker的通信，参见Register类使用一节。
注意：客户端不要连接Register服务端口，客户端应该连接Gateway端口
use \Workerman\Worker; use \GatewayWorker\Register; // 自动加载类，根据需求自定义 require_once __DIR__ . '/../../vendor/autoload.php'; // register 必须是text协议，服务注册地址 $register = new Register('text://127.0.0.1:1234'); // 如果不是在根目录启动，则运行runAll方法 if(!defined('GLOBAL_START')) { Worker::runAll(); }
start_gateway.php 为gateway进程启动脚本，主要定义了客户端连接的端口号、协议等信息，具体参见 Gateway类的使用一节。
use \Workerman\Worker; use \Workerman\WebServer; use \GatewayWorker\Gateway; use \GatewayWorker\BusinessWorker; use \Workerman\Autoloader; // 自动加载类 require_once __DIR__ . '/../vendor/autoload.php'; /** * 与GatewayWorker建立websocket连接，域名和端口改为你实际的域名端口， * 其中端口为Gateway端口，即start_gateway.php指定的端口。 * start_gateway.php 中需要指定websocket协议，像这样 * $gateway = new Gateway(websocket://0.0.0.0:7272); * js部分： * ws = new WebSocket("ws://your_domain.com:7272"); */ // gateway 进程，这里使用Text协议，可以用telnet测试 $context = array( // 更多ssl选项请参考手册 http://php.net/manual/zh/context.ssl.php 'ssl' => array( // 请使用绝对路径 'local_cert' => __dir__.'/certificate/server.pem', // 也可以是crt文件 'local_pk' => __dir__.'/certificate/server.key', 'verify_peer' => false, // 'allow_self_signed' => true, //如果是自签名证书需要开启此选项 ) ); // websocket协议(端口任意，只要没有被其它程序占用就行) $gateway = new Gateway("websocket://0.0.0.0:8899", $context); // 开启SSL，websocket+SSL 即wss $gateway->transport = 'ssl'; // gateway名称，status方便查看 $gateway->name = 'YourAppGateway'; // gateway进程数 $gateway->count = 4; // 本机IP，分布式部署时使用内网IP,GatewayWorker与GatewayClient不在同一台服务器使用当前服务器内网IP,如果不在同一个内网改为公网IP $gateway->lanIp = '127.0.0.1'; // 内部通讯起始端口，假如$gateway->count=4，起始端口为4000 // 则一般会使用4000 4001 4002 4003 4个端口作为内部通讯端口 $gateway->startPort = 2900; // 服务注册地址 $gateway->registerAddress = '127.0.0.1:1234'; // 心跳间隔 //$gateway->pingInterval = 10; // 心跳数据 //$gateway->pingData = '{"type":"ping"}'; /* // 当客户端连接上来时，设置连接的onWebSocketConnect，即在websocket握手时的回调 $gateway->onConnect = function($connection) { $connection->onWebSocketConnect = function($connection , $http_header) { // 可以在这里判断连接来源是否合法，不合法就关掉连接 // $_SERVER['HTTP_ORIGIN']标识来自哪个站点的页面发起的websocket链接 if($_SERVER['HTTP_ORIGIN'] != 'http://kedou.workerman.net') { $connection->close(); } // onWebSocketConnect 里面$_GET $_SERVER是可用的 // var_dump($_GET, $_SERVER); }; }; */ // 如果不是在根目录启动，则运行runAll方法 if(!defined('GLOBAL_START')) { Worker::runAll(); }
start_businessworker.php 为businessWorker进程启动脚本，也即是调用Events.php的业务处理进程，具体参见 BusinessWorker类的使用一节。
use \Workerman\Worker; use \Workerman\WebServer; use \GatewayWorker\Gateway; use \GatewayWorker\BusinessWorker; use \Workerman\Autoloader; // 自动加载类 require_once __DIR__ . '/../../vendor/autoload.php'; // bussinessWorker 进程 $worker = new BusinessWorker(); // worker名称 $worker->name = 'YourAppBusinessWorker'; // bussinessWorker进程数量 $worker->count = 4; // 服务注册地址 $worker->registerAddress = '127.0.0.1:1234'; // 如果不是在根目录启动，则运行runAll方法 if(!defined('GLOBAL_START')) { Worker::runAll(); }
注意：注册端口
文件： start_register.php start_gateway.php start_businessworker.php 中的注册地址要一样。
//start_gateway.php // 服务注册地址 $gateway->registerAddress = '127.0.0.1:1238'; //start_businessworker.php // 服务注册地址 $worker->registerAddress = '127.0.0.1:1238'; //start_register.php // register 必须是text协议 $register = new Register('text://0.0.0.0:1238');
Events.php 所有业务代码都在这里
/*
* 用于检测业务代码死循环或者长时间阻塞等问题 * 如果发现业务卡死，可以将下面declare打开（去掉//注释），并执行php start.php reload * 然后观察一段时间workerman.log看是否有process_timeout异常 */ //declare(ticks=1); use \GatewayWorker\Lib\Gateway; /** * 主逻辑 * 主要是处理 onConnect onMessage onClose 三个方法 * onConnect 和 onClose 如果不需要可以不用实现并删除 */ class Events { /** * 当客户端连接时触发 * 如果业务不需此回调可以删除onConnect * @param int $client_id 连接id * @desc $client_id 为系统自动生成 */ public static function onConnect($client_id) { // 向当前client_id发送数据 /*Gateway::sendToClient($client_id, "Hello $client_id\r\n"); // 向所有人发送 Gateway::sendToAll("$client_id login\r\n");*/ } /** * 当客户端发来消息时触发 * @param int $client_id 连接id * @param mixed $message 具体消息 */ public static function onMessage($client_id, $message) { // 向所有人发送 Gateway::sendToAll("$client_id said $message\r\n"); } /** * 当用户断开连接时触发 * @param int $client_id 连接id */ public static function onClose($client_id) { } }
启动与停止
注意：Workerman启动停止等命令都是在命令行中完成的。
以debug（调试）方式启动
php start.php start
以daemon（守护进程）方式启动
php start.php start -d
php start.php stop
php start.php restart
php start.php reload
php start.php status
1、以debug方式启动，代码中echo、var_dump、print等打印函数会直接输出在终端。
2、以daemon方式启动，代码中echo、var_dump、print等打印会默认重定向到/dev/null文件，可以通过设置Worker::$stdoutFile = '/your/path/file';来设置这个文件路径。
3、以debug方式启动，终端关闭后workerman会随之关闭并退出。
4、以daemon方式启动，终端关闭后workerman继续后台正常运行。