Web Socket

EasySwoole的Web Socket 其实是由 swoole_websocket_server实现。若想使用WebSocket,请修改/Conf/Config.php,改变服务模式。

  1. "SERVER_TYPE"=>\Core\Swoole\Config::SERVER_TYPE_WEB_SOCKET

开启WebSocket模式之后，需要注册onMessage事件。

相关事件注册

EasySwoole的beforeWorkerStart事件，可以对Server做一些列的补充操作。

  1.  $server->on("message",function (\swoole_websocket_server $server, \swoole_websocket_frame $frame){
  2.             Logger::getInstance()->console("receive data ".$frame->data);
  3.             $json = json_decode($frame->data,1);
  4.             if(is_array($json)){
  5.                 if($json['action'] == 'who'){
  6.                     //可以获取bind后的uid
  7.                     //var_dump($server->connection_info($frame->fd));
  8.                     $server->push($frame->fd,"your fd is ".$frame->fd);
  9.                 }else{
  10.                     $server->push($frame->fd,"this is server and you say :".$json['content']);
  11.                 }
  12.             }else{
  13.                 $server->push($frame->fd,"command error");
  14.             }
  15.         }
  16.  );

注册message事件后，客户端发送过来的全部数据包都会被该函数处理。

  1. $server->on("handshake",function (\swoole_http_request $request, \swoole_http_response $response){
  2.             //自定定握手规则，没有设置则用系统内置的（只支持version:13的）
  3.             if (!isset($request->header['sec-websocket-key']))
  4.             {
  5.                 //'Bad protocol implementation: it is not RFC6455.'
  6.                 $response->end();
  7.                 return false;
  8.             }
  9.             if (0 === preg_match('#^[+/0-9A-Za-z]{21}[AQgw]==$#', $request->header['sec-websocket-key'])
  10.                 || 16 !== strlen(base64_decode($request->header['sec-websocket-key']))
  11.             )
  12.             {
  13.                 //Header Sec-WebSocket-Key is illegal;
  14.                 $response->end();
  15.                 return false;
  16.             }
  18.             $key = base64_encode(sha1($request->header['sec-websocket-key']
  19.                 . '258EAFA5-E914-47DA-95CA-C5AB0DC85B11',
  20.                 true));
  21.             $headers = array(
  22.                 'Upgrade'               => 'websocket',
  23.                 'Connection'            => 'Upgrade',
  24.                 'Sec-WebSocket-Accept'  => $key,
  25.                 'Sec-WebSocket-Version' => '13',
  26.                 'KeepAlive'             => 'off',
  27.             );
  28.             foreach ($headers as $key => $val)
  29.             {
  30.                 $response->header($key, $val);
  31.             }
  32.             //注意 一定要有101状态码，协议规定
  33.             $response->status(101);
  34.             Logger::getInstance()->console('fd is '.$request->fd);
  35.             //再做标记，保证唯一性，此操作可选
  36.             Server::getInstance()->getServer()->bind($request->fd,time().Random::randNumStr(6));
  37.             $response->end();
  38.         }
  39. );

连接验证

WS的链接建立，其实是一个特殊的HTTP请求，因此，客户端在发起链接的时候，其实是像服务端发送了一个带有特殊标记的HTTP 请求，
该请求会被handshake回调函数处理，在该回调函数中，可以根据request的cookie或者header进行判断，允许不允许该用户进行链接。

Swoole支持自定义WebSocket 握手规则。若对此握手规则有疑问的，请自行百度RFC规范，查看关于WebSocket的规定。

  1.  $server->on("close",function ($ser,$fd){
  2.             Logger::getInstance()->console("client {$fd} close");
  3.         }
  4.  );

当客户端与服务的断开链接时，均会触发此操作，注意：HTTP 协议也会触发该请求，可以通过server->connection_info()函数来判定链接类型。

HTTP对WebSocket操作

模拟简单的WebSocket客户端

在/App/Static/Template 目录下建立一个websocket_client.html

  1. <html>
  2. <head>
  3.     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
  4. </head>
  5. <body>
  6. <div>
  7.     <div>
  8.         <p>info below</p>
  9.         <ul  id="line">
  11.         </ul>
  12.     </div>
  13.     <div>
  14.         <select id="action">
  15.             <option value="who">who</option>
  16.             <option value="hello">hello</option>
  17.         </select>
  18.         <input type="text" id="says">
  19.         <button onclick="say()">发送</button>
  20.     </div>
  21. </div>
  22. </body>
  23. <script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.2.1/jquery.js"></script>
  24. <script>
  25.     var wsServer = 'ws://127.0.0.1:9501';
  26.     var websocket = new WebSocket(wsServer);
  27.     window.onload = function () {
  28.         websocket.onopen = function (evt) {
  29.             addLine("Connected to WebSocket server.");
  30.         };
  32.         websocket.onclose = function (evt) {
  33.             addLine("Disconnected");
  34.         };
  36.         websocket.onmessage = function (evt) {
  37.             addLine('Retrieved data from server: ' + evt.data);
  38.         };
  40.         websocket.onerror = function (evt, e) {
  41.             addLine('Error occured: ' + evt.data);
  42.         };
  43.     };
  44.     function addLine(data) {
  45.         $("#line").append("<li>"+data+"</li>");
  46.     }
  47.     function say() {
  48.         var content = $("#says").val();
  49.         var action = $("#action").val();
  50.         $("#says").val('');
  51.         websocket.send(JSON.stringify({
  52.             action:action,
  53.             content:content
  54.         }));
  55.     }
  56. </script>
  57. </html>

建立对应的测试控制器

  1. <?php
  2. /**
  3.  * Created by PhpStorm.
  4.  * User: yf
  5.  * Date: 2017/9/27
  6.  * Time: 上午11:58
  7.  */
  9. namespace App\Controller;
  11. use Core\AbstractInterface\AbstractController;
  12. use Core\Http\Message\Status;
  13. use Core\Component\Logger;
  14. use Core\Swoole\AsyncTaskManager;
  15. use Core\Swoole\Server;
  17. class WebSocket extends AbstractController
  18. {
  20.     function index()
  21.     {
  22.         // TODO: Implement index() method.
  23.         $this->response()->write(file_get_contents(ROOT."/App/Static/Template/websocket_client.html"));
  24.     }
  25.     function push(){
  26.         /*
  27.          * url :/webSocket/push/index.html?fd=xxxx
  28.          */
  29.         $fd = $this->request()->getRequestParam("fd");
  30.         $info =  Server::getInstance()->getServer()->connection_info($fd);
  31.         if($info['websocket_status']){
  32.             Logger::getInstance()->console("push data to client {$fd}");
  33.             Server::getInstance()->getServer()->push($fd,"data from server at ".time());
  34.             $this->response()->write("push to fd :{$fd}");
  35.         }else{
  36.             $this->response()->write("fd {$fd} not a websocket");
  37.         }
  38.     }
  39.     function connectionList(){
  40.         /*
  41.          * url:/webSocket/connectionList/index.html
  42.          * 注意   本example未引入redis来做fd信息记录，因此每次采用遍历的形式来获取结果，
  43.          * 仅供思路参考，不建议在生产环节使用
  44.          */
  45.         $list = array();
  46.         foreach (Server::getInstance()->getServer()->connections as $connection){
  47.             $info =  Server::getInstance()->getServer()->connection_info($connection);
  48.             if($info['websocket_status']){
  49.                 $list[] = $connection;
  50.             }
  51.         }
  52.         $this->response()->writeJson(200,$list,"this is all websocket list");
  53.     }
  54.     function broadcast(){
  55.         /*
  56.          * url :/webSocket/broadcast/index.html?fds=xx,xx,xx
  57.          */
  58.         $fds = $this->request()->getRequestParam("fds");
  59.         $fds = explode(",",$fds);
  60.         AsyncTaskManager::getInstance()->add(function ()use ($fds){
  61.             foreach ( $fds as $fd) {
  62.                 Server::getInstance()->getServer()->push($fd,"this is broadcast");
  63.             }
  64.         });
  65.         $this->response()->write('broadcast to all client');
  66.     }
  67. }

注意：客户端断线问题要处理好，否则会遇见向一个不存在链接推送数据，导致底层发出waring的问题。此问题不会导致服务出错，但对于业务逻辑与保障数据送达方面，会有影响。