本模块目前仅向系统版本 >= v2.0.8-Beta提供~

介绍

• 相同的请求php think run耗时约366ms而本模块仅需9ms，快到看不清保存按钮加载态！
• 系统内置的API已完成常驻内存兼容，包括CRUD、终端、模块管理、文件上传等接口(v2.0.8)！
• 本模块直接依赖 workerman/gateway-worker，您可以使用它提供的方法，也可以直接使用 Workerman 4.x+ 的方法。

功能特性

1. 本模块默认提供一个HTTP服务和一个WebSocket服务。
2. 基于Workerman，就像Webman也是基于它一样，但本模块的整合方式更加简洁（TP本身比Webman复杂）。
3. 文件监听热重载支持。
4. ...

HTTP服务

• 本服务配置文件位于/config/worker_http.php，默认端口为8000，所以一旦启动本服务，就不需要启动php think run了。
• BuildAdmin系统内置的前后台API已经兼容本服务（不包含模块提供的接口，也不意味着您自行撰写的接口也已经兼容本服务）。
• 我们额外提供了一个示例接口/app/worker/controller/HttpExamples.php，以便您更快的上手。
• 若您需要一些常驻内存运行程序的相关建议，请参考本介绍页的下半部分。

Windows

• 直接双击/modules/workerman/commands/http_worker_start_for_win.bat文件来启动服务。

Linux/Mac

• 以下命令权限不足请自行加sudo
• 执行php think worker http start以调试模式启动服务
• 执行php think worker http start -d以守护进程模式启动服务
• php think worker http stop停止服务
• php think worker http restart重启服务
• php think worker http reload柔性重启服务
• php think worker http status查看服务状态

WebSocket服务

• 本服务配置文件位于/config/worker_ws.php，默认端口为2828
• 我们额外提供了一个示例接口/app/worker/controller/WebSocketExamples.php，以便您更快的上手。
• 若您需要一些常驻内存运行程序的相关建议，请参考本介绍页的下半部分。
• ws服务的心跳保活机制已经内置，前端每50s向服务端发送一次字符串ping即可（您当然也可以自行实现不同的心跳方案）。
• 以下提供一份前台测试ws的代码

// 连接
var websocket = new WebSocket('ws://127.0.0.1:2828');
websocket.onopen = function() {
    console.log('连接成功了');

    // 定时发送心跳以保持连接 - 50秒间隔为推荐值
    setInterval(() => {
        websocket.send('ping')
    }, 50000);

    // 发送消息
    websocket.send('{"pathInfo":"worker/WebSocketExamples/message"}')
};
websocket.onclose = function(evt) {
    console.log('连接关闭中', evt);
};
websocket.onmessage = function(evt) {
    console.log('收到消息', evt);
};

Windows

• 直接双击/modules/workerman/commands/ws_worker_start_for_win.bat文件来启动服务。

Linux/Mac

• 以下命令权限不足请自行加sudo
• 执行php think worker ws start以调试模式启动服务
• 执行php think worker ws start -d以守护进程模式启动服务
• php think worker ws stop停止服务
• php think worker ws restart重启服务
• php think worker ws reload柔性重启服务
• php think worker ws status查看服务状态

常驻内存须知

php cli下不支持的特性

1. Cookie和Session：框架本身并未使用它们，我们也建议您无必要不使用，通常无需担心。
2. move_uploaded_file：框架的文件上传类中已经兼容rename进行上传文件的移动。
3. header：请使用TP的return Response()->header()方案设置响应头，如果是SSE等比较特别的，可以参考/extend/ba/Terminal.php的响应头发送方案。

对比传统PHP应用

1. 常驻内存模式载入程序文件、解析等之后，并不会销毁内存中的数据，使得类的定义、全局对象、类的静态成员 不会释放！ 便于后续重复利用。
2. 避免多次require/include相同的类或者常量的定义文件。
3. 避免使用exit、die，它们将导致子进程直接退出。
4. 事出反常，重启服务，顺风顺水也不妨刷新再看一遍。
5. 大多数情况下，代码在常驻内存的服务上能跑，那么php think run的服务上也能跑，可以相互映照。

常见问题

http无法访问，ws无法连接？

• 请首先排除端口问题，端口未开放占此类问题的80%以上，服务器面板开放端口，同时服务商的安全组、负载均衡、CDN等服务若有使用也需要同步开放对应端口。

创建https，wss服务？

• 创建https服务
• 创建wss服务

菜单规则数据异常？

• 菜单规则的数据通过静态变量进行缓存（以组为单位），这是为了提升性能而做出的设计，若您的菜单规则发生了变动而页面上显示的菜单并未更新，请重启Workerman服务即可

旧API的灰度迁移？

• 本模块的http服务支持单独指定端口号，您可以对前端进行改造（或使用Nginx转发），先将部分API请求转到本服务完成逐步迁移，除非经过完整的测试，或您对常驻内存开发非常熟悉，否则我们不推荐您直接全量使用本服务来处理旧API的请求。

自定义后台入口后无法访问？

• 请于config/app.php内，设置好应用映射app_map即可，key为随机入口名（不含.php），value为固定的admin，可参考下方示例，系统新版本已对此进行优化，无需手动配置

return [
    // ...
    // 应用映射（自动多应用模式有效）
    'app_map'          => ['New entrance name' => 'admin'],
];

自定义协议/服务？

• 请先检查config/worker_*.php中的配置能否满足您的需求，然后您可以参考已有的http和ws服务创建您自己的定制化服务，模块作者也可以以相同的方式添加新的服务。

模块如何监听onWorkerStart等事件？

• 在模块开发中，您只需要于模块核心控制器中直接定义onWorkerStart、onWorkerStop、onWebSocketConnect、onWebSocketClose方法，即可监听对应的事件（http服务不支持，仅ws），若不能满足您的需求，请参考已有的ws和http服务自定义您的专属服务，并告知用户如何启动该服务即可。

特别鸣谢

• Workerman(手册直达)
• GatewayWorker(手册直达)
• Webman