WebSocket控制器

EasySwoole 2.x支持以控制器模式来开发你的代码。

首先，修改项目根目录下配置文件Config.php，修改SERVER_TYPE为:

  1. \EasySwoole\Core\Swoole\ServerManager::TYPE_WEB_SOCKET_SERVER

新人帮助

  • 本文遵循PSR-4自动加载类规范，如果你还不了解这个规范，请先学习相关规则。
  • 本节基础命名空间App 默认指项目根目录下Application文件夹，如果你的App指向不同，请自行替换。
  • 只要遵循PSR-4规范，无论你怎么组织文件结构都没问题，本节只做简单示例。

实现命令解析

新人提示

这里的命令解析，其意思为根据请求信息解析为具体的执行命令;

在easyswoole中，可以让WebSocket像传统框架那样按照控制器->方法这样去解析请求;

需要实现EasySwoole\Core\Socket\AbstractInterface\ParserInterface接口中的decode 和encode方法;

创建App/Parser.php文件，写入以下代码

  1. namespace App;
  4. use EasySwoole\Core\Socket\AbstractInterface\ParserInterface;
  5. use EasySwoole\Core\Socket\Common\CommandBean;
  7. class Parser implements ParserInterface
  8. {
  10.     public static function decode($raw, $client)
  11.     {
  12.         // TODO: Implement decode() method.
  13.         $command = new CommandBean();
  14.         $json = json_decode($raw,1);
  15.         $command->setControllerClass(\App\WebSocket\Test::class);
  16.         $command->setAction($json['action']);
  17.         $command->setArg('content',$json['content']);
  18.         return $command;
  20.     }
  22.     public static function encode(string $raw, $client): ?string
  23.     {
  24.         // TODO: Implement encode() method.
  25.         return $raw;
  26.     }
  27. }

注意，请按照你实际的规则实现，本测试代码与前端代码对应。

注册服务

新人提示

如果你尚未明白easyswoole运行机制，那么这里你简单理解为，当easyswoole运行到一定时刻，会执行以下方法。

这里是指注册你上面实现的解析器。

在根目录下EasySwooleEvent.php文件mainServerCreate方法下加入以下代码

  1. //注意：在此文件引入以下命名空间
  2. use \EasySwoole\Core\Swoole\EventHelper;
  4. public static function mainServerCreate(ServerManager $server,EventRegister $register): void
  5. {
  6.     // TODO: Implement mainServerCreate() method.
  7.     EventHelper::registerDefaultOnMessage($register,\App\Parser::class);
  8. }

在EasySwooleEvent中注册该服务。

测试前端代码

友情提示

easyswoole 提供了更强大的WebSocket调试工具，[foo]: http://www.evalor.cn/websocket.html ‘WEBSOCKET CLIENT’；

创建Application/HttpController/websocket.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.             <option value="delay">delay</option>
  18.             <option value="404">404</option>
  19.         </select>
  20.         <input type="text" id="says">
  21.         <button onclick="say()">发送</button>
  22.     </div>
  23. </div>
  24. </body>
  25. <script src="http://apps.bdimg.com/libs/jquery/2.1.4/jquery.min.js"></script>
  26. <script>
  27.     var wsServer = 'ws://127.0.0.1:9501';
  28.     var websocket = new WebSocket(wsServer);
  29.     window.onload = function () {
  30.         websocket.onopen = function (evt) {
  31.             addLine("Connected to WebSocket server.");
  32.         };
  34.         websocket.onclose = function (evt) {
  35.             addLine("Disconnected");
  36.         };
  38.         websocket.onmessage = function (evt) {
  39.             addLine('Retrieved data from server: ' + evt.data);
  40.         };
  42.         websocket.onerror = function (evt, e) {
  43.             addLine('Error occured: ' + evt.data);
  44.         };
  45.     };
  46.     function addLine(data) {
  47.         $("#line").append("<li>"+data+"</li>");
  48.     }
  49.     function say() {
  50.         var content = $("#says").val();
  51.         var action = $("#action").val();
  52.         $("#says").val('');
  53.         websocket.send(JSON.stringify({
  54.             action:action,
  55.             content:content
  56.         }));
  57.     }
  58. </script>
  59. </html>

测试用HttpController 视图控制器

新人提示

这里仅提供了前端基本的示例代码，更多需求根据自己业务逻辑设计

创建Application/HttpController/Index.php文件，写入以下代码

  1. namespace App\HttpController;
  4. use EasySwoole\Core\Http\AbstractInterface\Controller;
  5. use EasySwoole\Core\Swoole\ServerManager;
  7. class Index extends Controller
  8. {
  10.     function index()
  11.     {
  12.         // TODO: Implement index() method.
  13.         $content = file_get_contents(__DIR__.'/websocket.html');
  14.         $this->response()->write($content);
  15.     }
  17.     /*
  18.      * 请调用who，获取fd
  19.      * http://ip:9501/push/index.html?fd=xxxx
  20.      */
  21.     function push()
  22.     {
  23.         $fd = intval($this->request()->getRequestParam('fd'));
  24.         $info = ServerManager::getInstance()->getServer()->connection_info($fd);
  25.         if(is_array($info)){
  26.             ServerManager::getInstance()->getServer()->push($fd,'push in http at '.time());
  27.         }else{
  28.             $this->response()->write("fd {$fd} not exist");
  29.         }
  30.     }
  32. }

本控制器主要为方便你获得前端页面和从HTTP请求中对websocket 做推送。

WebSocket 控制器

新人提示

WebSocket控制器必须继承EasySwoole\Core\Socket\AbstractInterface\WebSocketController;

actionNotFound方法提供了当找不到该方法时的返回信息，默认会传入本次请求的actionName。

创建Application/WebSocket/Test.php文件，写入以下内容

  1. namespace App\WebSocket;
  4. use EasySwoole\Core\Socket\Response;
  5. use EasySwoole\Core\Socket\AbstractInterface\WebSocketController;
  6. use EasySwoole\Core\Swoole\Task\TaskManager;
  8. class Test extends WebSocketController
  9. {
  10.     function actionNotFound(?string $actionName)
  11.     {
  12.         $this->response()->write("action call {$actionName} not found");
  13.     }
  15.     function hello()
  16.     {
  17.         $this->response()->write('call hello with arg:'.$this->request()->getArg('content'));
  19.     }
  21.     public function who(){
  22.         $this->response()->write('your fd is '.$this->client()->getFd());
  23.     }
  25.     function delay()
  26.     {
  27.         $this->response()->write('this is delay action');
  28.         $client = $this->client();
  29.         //测试异步推送
  30.         TaskManager::async(function ()use($client){
  31.             sleep(1);
  32.             Response::response($client,'this is async task res'.time());
  33.         });
  34.     }
  35. }

测试

如果你按照本文配置，那么你的文件结构应该是以下形式

Application
|—-|HttpController
|—-|—-|Index.php
|—-|—-|websocket.html
|—-|WebSocket
|—-|—-|Test.php
|—-|Parser.php

首先在根目录运行easyswoole

php easyswoole start

如果没有错误此时已经启动了easyswoole服务;
访问127.0.0.1:9501/Index/index 可以看到之前写的测试html文件;
新人提示：这种访问方式会请求HttpController控制器下Index.php中的index方法

扩展

自定义解析器

在上文的Parser.php中，已经实现了一个简单解析器；
我们可以通过自定义解析器，实现自己需要的场景。

  1.     public function decode($raw, $client)
  2.     {
  3.         // TODO: Implement decode() method.
  4.         $CommandBean = new CommandBean();
  6.         //这里的$raw是请求服务器的信息，你可以自行设计，这里使用了JSON字符串的形式。
  7.         $commandLine = json_decode($raw, true);
  9.         //这里会获取JSON数据中class键对应的值，并且设置一些默认值
  10.         //当用户传递class键的时候，会去App/WebSocket命名空间下寻找类
  11.         $control = isset($commandLine['class']) ? 'App\\WebSocket\\'. ucfirst($commandLine['class']) : '';
  12.         $action = $commandLine['action'] ?? 'none';
  13.         $data = $commandLine['data'] ?? null;
  15.         //先检查这个类是否存在，如果不存在则使用Index默认类
  16.         $CommandBean->setControllerClass(class_exists($control) ? $control : Index::class);
  17.         //检查传递的action键是否存在，如果不存在则访问默认方法
  18.         $CommandBean->setAction(class_exists($control) ? $action : 'controllerNotFound');
  19.         $CommandBean->setArg('data', $data);
  21.         return $CommandBean;
  22.     }

例如{“class”:”Test”,”action”:”hello”}
则会访问Application/WebSocket/Test.php 并执行hello方法

当然这里是举例，你可以根据自己的业务场景进行设计