Websocket

简介

CabalPHP 默认支持websocket

只需要在routes中添加路由即可：

  1. // $route->ws('/chat', '类@前缀');
  2. $route->ws('/chat', 'WebsocketController@on');

注册后当请求 ws://host:port/chat 会触发以下事件

  • HandShake(\Server $server, Request $request, $vars = []) 非必选
    • 刚开始连接时握手事件，可以增加逻辑判断，拒绝非法请求。
  • Open(\Server $server, Request $request) 非必选
    • 连接成功的打开事件，可以发送欢迎消息或初始化消息等。
  1. Message(\Server $server, Frame $frame, $vars = []) 必选
    • 接受到消息的时候触发的事件
  • Close(\Server $server, $fd, $reactorId) 非必选
    • 连接断开触发的事件，清理连接存储数据等。

对应到 WebsocketController@on 则是：

  1. WebsocketController@onHandShake
  2. WebsocketController@onOpen
  3. WebsocketController@onMessage
  4. WebsocketController@onClose

fdSession

fdSession 是一个可以用来存储连接相关信息的缓存对象，数据存储在 worker 进程中，会随着 worker 销毁释放。

在 HandShake 和 Open 事件中可以用 $request->fdSession() 获得

在 onMessage 事件中可以用 $frame->fdSession() 获得

使用方法和 session 类似。

?> HandShake 事件中可以正常使用 $request->session()，而在 Open 事件中可以读取 $request->session()。

聊天室示例

一个简单的聊天室：

?> 复杂业务可以在 Message 事件中使用 Cabal-Route 转发请求哦！

  1. <?php
  2. namespace App\Controller;
  4. use Cabal\Core\Http\Request;
  5. use Cabal\Core\Http\Frame;
  6. use Cabal\Core\Http\Response;
  8. class WebsocketController
  9. {
  10.     public function chat(\Server $server, Request $request, $var = [])
  11.     {
  12.         $response = new Response();
  13.         $response->getBody()
  14.             ->write(
  15.                 $server->plates()->render('chat')
  16.             );
  17.         return $response;
  18.     }
  20.     public function onHandShake(\Server $server, Request $request, $vars = [])
  21.     {
  22.         $session = $request->session();
  23.         $session['test'] = date('Y-m-d H:i:s');
  25.         $fdSession = $request->fdSession();
  26.         $fdSession['test'] = date('Y-m-d H:i:s');
  27.         $onlines = $server->onlines->add();
  29.     }
  31.     public function onOpen(\Server $server, Request $request)
  32.     {
  33.     }
  34.     public function onMessage(\Server $server, Frame $frame, $vars = [])
  35.     {
  36.         $fdSession = $frame->fdSession();
  37.         $data = trim($frame->data);
  38.         if (strlen($data) >= 6 && strtolower(substr($data, 0, 6)) == '/name ') {
  39.             $nickname = substr($data, 6);
  40.             if (mb_strlen($nickname, 'utf-8') > 12 || mb_strlen($nickname, 'utf-8') < 2) {
  41.                 $server->push($frame->fd, json_encode([
  42.                     'systemMsg' => '昵称必须是2至12个字！',
  43.                 ]));
  44.             } else {
  45.                 $fdSession['nickname'] = $nickname;
  46.                 $server->push($frame->fd, json_encode([
  47.                     'systemMsg' => "昵称修改为 " . $nickname . " 成功！",
  48.                 ]));
  49.             }
  50.             return;
  51.         } elseif (strlen($data) >= 5 && strtolower(substr($data, 0, 5)) == '/join') {
  52.             $onlines = $server->onlines->get();
  53.             $server->push($frame->fd, json_encode([
  54.                 'systemMsg' => "欢迎你加入聊天室！",
  55.             ]));
  56.             foreach ($server->connections as $fd) {
  57.                 $connectionInfo = $server->connection_info($fd);
  58.                 if (isset($connectionInfo['websocket_status']) && $connectionInfo['websocket_status'] == WEBSOCKET_STATUS_FRAME) {
  59.                     $server->push($fd, json_encode([
  60.                         'onlineNums' => $onlines,
  61.                     ]));
  62.                 }
  63.             }
  64.             return;
  65.         } elseif (strlen($data) < 1) {
  66.             // $server->push($frame->fd, json_encode([
  67.             //     'systemMsg' => "内容不能为空哦！",
  68.             // ]));
  69.             return;
  70.         }
  72.         $nickname = isset($fdSession['nickname']) ? $fdSession['nickname'] : "游客" . $frame->fd;
  73.         foreach ($server->connections as $fd) {
  74.             $connectionInfo = $server->connection_info($fd);
  75.             if (isset($connectionInfo['websocket_status']) && $connectionInfo['websocket_status'] == WEBSOCKET_STATUS_FRAME) {
  76.                 $server->push($fd, json_encode([
  77.                     'nickname' => $nickname,
  78.                     'datetime' => date('Y-m-d H:i:s'),
  79.                     'msg' => $frame->data,
  80.                 ]));
  81.             }
  82.         }
  83.     }
  85.     public function onClose(\Server $server, $fd, $reactorId)
  86.     {
  87.         $onlines = $server->onlines->sub();
  88.         foreach ($server->connections as $fd) {
  89.             $connectionInfo = $server->connection_info($fd);
  90.             if (isset($connectionInfo['websocket_status']) && $connectionInfo['websocket_status'] == WEBSOCKET_STATUS_FRAME) {
  91.                 $server->push($fd, json_encode([
  92.                     'onlineNums' => $onlines,
  93.                 ]));
  94.             }
  95.         }
  96.     }
  98. }

聊天室客户端：

  1. <!DOCTYPE html>
  2. <html lang="zh-CN">
  3. <head>
  4.     <meta charset="UTF-8">
  5.     <title>Websocket</title>
  6.     <script>
  7.         var ws = new WebSocket('ws://' + location.host + '/ws/chat');
  8.         ws.onmessage = function (event) {
  9.             var data = event.data;
  10.             data = eval('(' + data + ')');
  11.             if ('systemMsg' in data) {
  12.                 var line = document.createElement('div');
  13.                 line.className = 'sysMsg';
  14.                 line.innerHTML = data.systemMsg;
  15.                 document.getElementById('msg').appendChild(line);
  16.             } else if ('onlineNums' in data) {
  17.                 document.getElementById('online-nums').innerHTML = data.onlineNums;
  18.             } else {
  19.                 var line = document.createElement('div');
  20.                 line.innerHTML = '<span>[' + data.nickname + ']</span> ' + data.msg + ' <span class="datetime">' + data.datetime + '</span>';
  21.                 document.getElementById('msg').appendChild(line);
  22.             }
  23.         };
  24.         ws.onopen = function(event) {
  25.             ws.send('/join')
  26.         }
  27.         function send(e, input) {
  28.             if (e.charCode == 13) {
  29.                 ws.send(input.value);
  30.                 input.value = '';
  31.             }
  32.         }
  33.     </script>
  34.     <style>
  35.         .warp{width:400px}
  36.         #msg{padding:10px;border:1px solid #eee;min-height:500px;font-size:14px;line-height:1.8;line-height:1.8}
  37.         #msg span{color:#2b94ff}
  38.         #msg .datetime{color:#ddd}
  39.         #msg .sysMsg{color:#fe684c}
  40.         .infos{font-size:14px;color:#777;padding:8px 13px;text-align:right}
  41.         input{padding:8px 12px;font-size:14px;width:374px;border:1px solid #eee;border-top:none}
  42.     </style>
  43. </head>
  45. <body>
  46.     <div class="warp">
  47.         <div id="msg"></div>
  48.         <div>
  49.             <input type="text" onkeypress="send(event,this)" placeholder="回车发送 /name 昵称 改名" />
  50.         </div>
  51.         <div class="infos">
  52.             在线人数：
  53.             <span id="online-nums"></span>
  54.         </div>
  55.     </div>
  56. </body>
  58. </html>