ZanWebSocket 应用框架 boilerplate 指南

1. 项目介绍

ZanWebSocket 是一个基于 PHP 的高性能 WebSocket 服务器框架，由优赞科技开发并维护。ZanWebSocket Demo boilerplate 提供了一个基础模板，用于快速搭建你的 WebSocket 应用。它集成了 HTTP server 和 WebSocket server，并且遵循 Zan 框架的 websocket 协议规范，方便前后端交互。

2. 项目快速启动

依赖安装

确保已安装 Composer，这是 PHP 的包管理工具。接下来，在项目根目录执行以下命令安装依赖：

composer update

配置

在 PHP 的配置文件中添加或修改 ZanPHP 相关设置：

zanphp.RUN_MODE = test
zanphp.DEBUG = true

启动服务

使用以下命令启动 HTTP server 及 WebSocket server：

php bin/websocket

运行客户端测试

进入 test 目录，并运行测试套件：

cd test
phpunit --bootstrap

3. 应用案例与最佳实践

• 路由复用: 利用 WebSocket 可以复用 HTTP 路由和过滤器功能，实现 URL 资源的灵活管理和权限控制。
• 协议规范: 使用 Zan 提供的请求和响应格式进行通信，以保证数据传输的稳定性和可读性。
• 测试实践: 编写单元测试、集成测试和端到端测试来保证代码质量。

4. 典型生态项目

• ZanPHP: 该项目是 ZanWebSocket 的核心库，提供高性能的协程支持。
• NestJS WebSocket: 对比 ZanWebSocket，NestJS 提供了基于 Node.js 的 WebSocket 解决方案，适合更广泛的开发者群体。
• TypeORM: 类型安全的 ORM 工具，常与 ZanWebSocket 结合使用，实现数据库操作。
• SWagger: 文档工具，可用于构建 API 接口文档，配合 ZanWebSocket 实现更友好的开发者体验。

通过上述内容，你应该对 ZanWebSocket Demo boilerplate 有一个初步的认识，可以开始你的 WebSocket 应用开发之旅了。如需更多详细信息，请参阅项目官方文档。