关于php框架:PHP-基于-SWX-框架搭建WebSocket服务器一

前言

官网地址：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 真简略！"
  }
}

效果图如下：