一、简介GatewayWorker是基于Workerman开发的一个项目框架,用于快速开发TCP长连接应用,如应用推送服务器、即时IM服务器、游戏服务器、物联网、智能家居等。GatewayWorker使用经典的Gateway和Worker进程模型。Gateway进程负责维护客户端连接,并将客户端的数据转发给BusinessWorker进程进行处理。BusinessWorker进程负责处理实际的业务逻辑(默认调用Events.php处理业务)并将结果推送给相应的客户端。Gateway服务和BusinessWorker服务可以分别部署在不同的服务器上,实现分布式集群。GatewayWorker提供了一个非常方便的API,可以全局广播数据,也可以向某个群组广播数据,或者向特定客户端推送数据。配合Workerman的定时器,也可以定时推送数据。2、安装GatewayWorker在LInux服务器上安装:下载地址:GatewayWorker1,下载demo2,在命令行运行unzipGatewayWorker.zip解压GatewayWorker.zip3,在命令行运行cdGatewayWorker,进入GatewayWorker目录4、运行phpstart.php在命令行启动GatewayWorker5,新开几个命令行窗口运行telnet127.0.0.18282,输入任意字符聊天(非本地测试请将127.0.0.1替换为实际ip)。注意:如果telnet超时,请检查服务器防火墙(iptables)。GatewayWorker的默认端口在这里启动。如果需要更改,需要更改以下三个文件:GatewayWorker/Applications/YourApp/start_register.php//register必须是文本协议;这个端口要一致,根据项目自定义$register=newRegister('text://0.0.0.0:1238');GatewayWorker/Applications/YourApp/start_businessworker.php//businessWorker进程$worker=newBusinessWorker();//Worker名称,根据不同项目自定义$worker->name='YourAppBusinessWorker';//bussinessWorker进程数$worker->count=4;//服务注册地址;注意这个端口要一致,不同的项目可以自定义Define$worker->registerAddress='127.0.0.1:1238';GatewayWorker/Applications/YourApp/start_gateway.php//网关进程,这里使用Text协议,可以使用telnet测试$gateway=newGateway("tcp://0.0.0.0:8282");//网关名称,状态方便查看$gateway->name='YourAppGateway';//网关进程数$gateway->count=4;//本地ip,用于分布式部署Networkip$gateway->lanIp='127.0.0.1';//内部通信的初始端口,如果$gateway->count=4,则初始端口为4000//一般使用4个端口4000400140024003作为内部通信端口,不同的项目开启不同的端口$gateway->startPort=2900;//服务注册地址;端口保持不变,项目自定义$gateway->registerAddress='127.0.0.1:1238';//服务端向客户端发送心跳数据的时间间隔单位:秒如果设置为0则表示不发送心跳检测//$gateway->pingInterval=10;//客户端继续如果在$pingNotResponseLimit次$pingInterval内没有响应心跳,则断开链接。//如果设置为0,则表示客户端不需要发送响应数据,即通过TCP层检测连接的连通性(极端情况至少10分钟可以检测到)//$gateway->pingNotResponseLimit=2;//要发送的心跳请求数据和心跳数据是任意的,只要客户端能识别即可//$gateway->pingData='{"type":"ping"}';注意:客户端和服务端需要保持连接不断开,可以开启心跳检测,定时发送心跳数据。服务管理在GatewayWorker的根目录下有一个start.php文件:phpstart.phpstart启动服务(phpstart.phpstart-d以守护进程启动)phpstart.phpstop停止服务phpstart.phprestart重启(-d从守护进程启动)phpstart.phpreloadsmoothrestartphpstart.phpstatusservicestatusvagrant@homestead:~/code/GatewayWorker$phpstart.phpstatusWorkerman[start.php]status------------------------------------------全球状态--------------------------------------------------Workerman版本:3.5.10PHP版本:7.2.3-1+ubuntu16.04.1+deb.sury.org+1starttime:2018-06-0814:00:54run0days2hoursloadaverage:0,0,0event-loop:\Workerman\Events\Select3worker9processesworker_nameexit_statusexit_countYourAppBusinessWorker00YourAppGateway00Register00----------------------------------------------进程状态--------------------------------------------------pid内存监听worker_nameconnectionssend_failtimerstotal_requestqpsstatus46932MnoneYourAppBusinessWorker50030[idle]46942MnoneYourAppBusinessWorker50030[idle]46952MnoneYourAppBusinessWorker5001560[idle]46962MnoneYourAppBusinessWorker0500[空闲]46972Mtcp://0.0.0.0:8282YourAppGateway8002260[空闲]46982Mtcp://0.0.0.0:8282YourAppGateway8002260[空闲]46992Mtcp://0.0.0.0:8282YourAppGateway8002260[空闲]47002Mtcp://0.0.0.0:8282YourAppGateway8003780[idle]47012Mtext://0.0.0.0:1238寄存器800510[idle]----------------------------------------------进程状态---------------------------------------------------摘要18M--600012720[摘要]注意:修改代码重启服务下的GatewayClient安装项目原理:现有的mvc框架项目和GatewayWorker独立部署,互不干扰。所有的业务逻辑都是由网站页面post/get到mvc框架完成的。GatewayWorker不接受客户端发送的数据,即GatewayWorker不处理任何业务逻辑。一种单向推送通道只有当mvc框架需要主动向浏览器推送数据时,才会调用mvc框架中的网关API(GatewayClient)来完成推送。当然这只是官方推荐的组合方式,并不是绝对的。开发者可以自由更改和选择适合自己业务需求的组合方式。当然,业务通信也可以通过client和GatewayWorker直接双向通信的方式来完成。有关更多信息,请参阅官方手册。下载地址:GatewayClient。在项目中执行如下命令:composerrequireworkerman/gatewayclient3.应用结合laravel中的redis消息队列(使用redis队列请参考laravel/lumen)完成消息推送。在控制器中使用dispatch触发队列dispatch(newYourJob($data));Jobs中的示例:id=$id;}publicfunctionhandle(){//业务逻辑Gateway::sendToAll(json_encode(['id'=>xxx,'name'=>xxx]));}}每次更改代码时,都会重新启动队列。supervisorctlreload4.在调试服务器端打开Telnet,无法执行Telnet命令,需要安装。如:vagrant@homestead:~/code/GatewayWorker$telnet127.0.0.18282Trying127.0.0.1...Connectedto127.0.0.1.转义字符为'^]'。你好7f0000010b56000000017f0000010b5600000001loginhello7f0000010b5600000001saidhello{"id":"35","name":"xxx"}通常,你要发送的信息会被输出。转义符是'^]'。调出Telnet是Ctrl+],输入quit退出。5、配置wssWorkerman如何创建一个wss服务,让客户端可以使用wss协议连接通信,比如连接微信小程序中的服务端。wss协议其实就是websocket+SSL,就是在websocket协议上加了一个SSL层,类似于https(http+SSL)。所以只需要在websocket协议的基础上开启SSL就可以支持wss协议了。配置方法一:直接用Workerman开启SSL:准备工作:1、Workerman版本不低于3.3.72,PHP安装openssl扩展。3、证书(pem/crt文件和key文件)已经申请,放在磁盘start_gateway任意目录下。在phparray(//请使用绝对路径'local_cert'=>'diskpath/server.pem',//也可以是crt文件'local_pk'=>'Diskpath/server.key','verify_peer'=>false,//'allow_self_signed'=>true,//如果是自签名证书需要开启这个选项)));//这里设置了websocket协议(端口任意,但需要保证没有被其他程序占用)$worker=newWorker('websocket://0.0.0.0:443',$context);$worker->name=xxx//配置名称方便监控//设置transport开启ssl,websocket+ssl表示wss$worker->transport='ssl';$worker->onMessage=function($con,$msg){$con->send('ok');};Worker::runAll();通过以上代码,Workerman监听wss协议,客户端可以通过wss协议连接workerman,实现安全即时通讯。打开chrome浏览器进行测试,按F12打开调试控制台,在Console栏中输入(或者将以下代码放入html页面,用js运行)//证书会校验域名,请使用要连接的域名ws=newWebSocket("wss://domainname");ws.onopen=function(){alert("连接成功");ws.send('汤姆');alert("sendastringtotheserver:tom");};ws.onmessage=function(e){alert("Receivedthemessagefromtheserver:"+e.data);};注意事项:1、如果启动失败,通常是443端口被占用,请更换其他端口。注意,改成其他端口后,客户端连接时需要带上端口号。客户端连接时,地址类似于wss://domain.com:xxx,其中xxx是端口号。如果一定要使用443端口,请使用方法2通过代理实现wss。2、wss端口只能通过wss协议访问,ws不能访问wss端口。3、证书一般都是绑定域名的,所以在测试的时候,客户端应该使用域名来连接,而不是ip。4.如果无法访问,请检查服务器防火墙。5、该方法需要PHP版本>=5.6,因为微信小程序需要tls1.2,PHP5.6以下版本不支持tls1.2。6、微信小程序连接wss时不需要端口号,即wss端口只能是443。但是443端口一般被nginx/apache占用,此时可以考虑方法2。配置方法二:使用nginx/apache代理wss使用nginx/apache作为wss代理转发给workerman(注意该方法的workerman部分一定不要设置ssl,否则会连接不上)。通信原理及流程为:1.客户端向nginx/apache发起wss连接2,nginx/apache将wss协议数据转换成ws协议数据转发到Workerman的websocket协议端口3.Workerman收到数据后执行业务逻辑处理4、Workerman向客户端发送消息时,是相反的过程。数据通过nginx/apache转换成wss协议,然后发送给客户端。nginx配置参考前提和准备:1.假设Workerman监听8282端口(websocket协议,不要使用tcp)2.已经申请了证书(pem/crt文件和key文件)放在/etc/nginx/下conf.d/ssl3、计划使用nginx开放443端口对外提供wss代理服务(端口可根据需要修改)4、nginx一般作为网站服务器运行其他服务。为了不影响原站点的使用,这里使用地址域名/wss作为wss的代理入口。即客户端连接地址为wss://域名/wssnginx,配置类似如下:server{listen443;SSL开启;ssl_certificate/etc/ssl/server.pem;ssl_certificate_key/etc/ssl/server.key;ssl_session_timeout5m;共享:SSL:50m;ssl_protocolsSSLv3SSLv2TLSv1TLSv1.1TLSv1.2;ssl_ciphersALL:!ADH:!EXPORT56:RC4+RSA:+HIGH:+MEDIUM:+LOW:+SSLv2:+EXP;位置/wss{proxy_passhttp://127.0.0.1:8282;proxy_http_version1.1;proxy_set_header升级$http_upgrade;proxy_set_header连接“升级”;proxy_set_headerX-Real-IP$remote_addr;}#location/{}站点其他配置...}Test//证书会校验域名,请使用域名连接ws=newWebSocket("wss://域名/wss");ws.onopen=function(){alert("连接成功");ws.send('汤姆');alert("Sendastringtotheserver:tom");};ws.onmessage=function(e){alert("Receivedamessagefromtheserver:"+e.data);};另外,为了方便测试,也可以使用在线测试工具,比如websocket在线测试
