前言

官网地址：SW-X框架-专一高性能便捷开发而生的PHP-SwooleX框架

心愿各大佬举起小手，给小弟一个star：https://github.com/swoolex/swoolex

1、服务阐明

在SW-X中，启动websocket服务时，会同时反对HTTP和WebSocket两种申请。

部署好SW-X源码后，批改/config/server.php配置文件中的host和port，0.0.0.0示意不限度内外网IP，port默认为9502端口。

实现后，应用php sw-x start websocket命令启动websocket服务即可。

若你应用云服务器，记得在服务商的控制台->平安组中凋谢对应的端口号；若你还装的是宝塔环境，还须要在宝塔面板的平安组中再凋谢一次端口才行，否则外网是无法访问的。

2、事件反对

家喻户晓，websocket的日常开发，至多都须要用到onOpen和onClose两种音讯事件。

在SW-X中，会对Swoole的事件进行转发定义，对立寄存在/box/event/server/目录下，文件名称为对应音讯的事件名。

失常状况WebSocket开发，只须要改变到以下3种事件：

// 连贯握手时 [这里实现业务鉴权]onOpen.php// 接管到客户端音讯时 [少数状况下这里都不须要重写]onMessage.php// 敞开连贯时 [这里实现下线销毁]onClose.php

3、WSS配置

SW-X的WebSocket服务要开启WSS很简略，只须要批改/config/server.php配置项中的，ssl_cert_file、ssl_key_file证书门路即可。

4、承受客户端音讯

当/config/server.php配置文件中的is_onMessage设置为true时【默认值】，则示意启用框架对onMessage事件进行监听解决，也代表启用框架对WebSocket的控制器解决。

也不倡议改为false，除非你对Swoole很相熟，同时也很相熟WebSocket服务的开发工作。

SW-X对WebSocket服务的数据处理，仅反对固定格局的JSON数据包，同时反对配置启用对数据进行AES加解密，只须要批改/config/server.php中的配置项即可开启。

客户端数据包，未加密前的格局应该为：

{    "action":"申请路由",    "data":申请数据}

若是将is_onMessage设置为false时，框架则不再监听onMessage事件，改由开发者本人监听/box/event/server/下的onMessage事件，进而实现数据分包。

5、服务端推出音讯

WebSocket控制器中输入返回值跟HTTP控制器一样，都是调用fetch()办法，只不过传入的参数格局不一样。

该办法按以下程序，共反对4个参数传递：

$action  状态码$msg  阐明，默认值：success，非必填$data 后果集，默认值：[]，非必填$fd 客户端的连贯标识符[Swoole的fd]，默认值：以后客户端连贯，非必填

若须要群发音讯时，须要循环调用该办法，传入客户端对应的$fd值即可。

fetch()最终推送进来的数据结构如下（未开启加密前）：

{    "action":"状态值",    "msg":"形容",    "data":"返回值",}
倡议用HTTP-API接口的交互方式，来解读SW-X对WebSocket服务的设计会比拟好了解一些。

6、WebSocket控制器

WebSocekt的控制器会依据action字段进行路由匹配，最终找到/app/websocket/目录下的控制器文件进行解决。

该目录下的事件控制器，都须要继承\x\controller\WebSocekt基类。

WebSocekt的路由解决，与HTTP服务的一样，如果你相熟SW-X的路由模式，上手将会非常简单。

例如，定义一个user/login的路由，只须要创立/app/websocket/user/login.php文件，并写入以下代码即可：

namespace app\websocket\user;use x\controller\WebSocket;class login extends WebSocket{    // index是默认疏忽的办法    public function index() {        return $this->fetch(200, '形容', []);    }}

7、承受客户端传递的data内容

因为WebSocket服务是应用JSON格局进行数据交互，同时反对AES数据加解密，所以日常开发中，只能通过控制器提供的办法来取得客户端申请的表单内容，$this->param()办法用于取得解密后的data内容，返回值是一个多维数组。

例如，将下面的user/login路由文件，改成以下代码：

namespace app\websocket\user;use x\controller\WebSocket;class login extends WebSocket{    // index是默认疏忽的办法    public function index() {        // 接管申请参数        $param = $this->param();        // 推回给前端做显示        return $this->fetch(200, '别乱发货色', $param);    }}

8、简略调试

SW-X官网提供了WebSocket的在线测试工具，具体地址：http://websocket.sw-x.cn/debu...

如果你是wss，应用：https://www.sw-x.cn/debug/web...

应用该工具，咱们能够对下面的user/login路由进行在线测试。

输出IP端口后，点击连贯，而后发送上面的数据包进行测试：

{  "action": "user/login",  "data": {    "id": "123",    "username": "SW-X真简略！"  }}

效果图如下：