docs(plan): 更新 Windows 兼容性状态

- 将 Windows 兼容性标记为已完成
- 更新当前状态:跨平台抽象层 platform.h + platform.c
- 更新待办池:移除 Windows 任务,聚焦 HTTPS/TLS 和 HTTP/2
- 添加 Windows 兼容性实现详情章节
This commit is contained in:
xfy 2026-06-05 00:51:09 +08:00
parent 556caf4412
commit 782bce9122

View File

@ -21,22 +21,23 @@
- [x] 最大并发连接数限制 ✅ 2026-06-03
- [x] 分级日志系统error / warn / info / debug✅ 2026-06-03
- [x] Gzip 压缩 ✅ 2026-06-03已接入响应流程
- [x] 集成测试 suite30 项 curl/bash 测试全部通过)✅ 2026-06-03
- [x] 集成测试 suite37 项 curl/bash 测试全部通过)✅ 2026-06-03
- [x] 性能基准wrk: ~16.2K RPS / ~60μs 延迟)✅ 2026-06-03
- [x] 请求体解析POST 支持)✅ 2026-06-03
- Content-Length 读取
- JSON / form-urlencoded 回显
- **multipart/form-data 文件上传**(保存到 root_dir/uploads/)✅ 2026-06-04
- [x] C 语言单元测试框架 ✅ 2026-06-03Unity 框架,99 个测试全部通过)
- [x] C 语言单元测试框架 ✅ 2026-06-03Unity 框架,113 个测试全部通过)
### Phase 3 — 扩展
- [x] **配置文件支持** — JSON 配置替代纯命令行 ✅ 2026-06-04
- `config.c` / `config.h`:极简 JSON 解析器(数字、字符串、布尔、注释)
- `cocoon_config_t` 结构体root_dir / port / threaded / num_workers / max_connections / timeout_ms / log_level / gzip_enabled
- `cocoon_config_t` 结构体root_dir / port / threaded / num_workers / max_connections / timeout_ms / log_level / gzip_enabled / brotli_enabled
- `config_merge()`:命令行参数覆盖配置文件
- `cocoon.json` 示例配置
- `--no-gzip` 命令行选项禁用压缩
- `--no-gzip` / `--no-brotli` 命令行选项禁用压缩
- [x] **Brotli 压缩** — 比 gzip 更高压缩率,现代浏览器均支持 ✅ 2026-06-04
- [x] **Windows 兼容性** — 跨平台抽象层,支持 Linux/macOS/Windows(MinGW/MSVC) ✅ 2026-06-04
- [ ] HTTPS / TLS
- [ ] HTTP/2
@ -49,40 +50,50 @@
- 编译通过,零警告(除 coco 子模块的 linker .note.GNU-stack 提示)
- **37 项集成测试全部通过**GET/HEAD/POST/404/Range/304/gzip/brotli/MIME/目录浏览/路径防护/文件上传)
- **113 个单元测试全部通过**Unity 框架,覆盖 http.c / static.c / multipart.c / config.c 核心逻辑)
- **113 个单元测试全部通过**Unity 框架,覆盖 http.c / static.c / multipart.c / config.c / server.c 核心逻辑)
- 压测数据wrk -t4 -c100 -d10s → 16,179 RPS平均延迟 59.86μs
- POST 支持JSON 和 form-urlencoded 回显multipart 文件上传Content-Length 解析8MB 上限
- **配置文件支持**JSON 格式8 个字段,命令行参数可覆盖
- README / Makefile 已更新
- **配置文件支持**JSON 格式9 个字段,命令行参数可覆盖
- **Windows 兼容性**:跨平台抽象层 platform.h + platform.cCMakeLists.txt 自动检测平台Makefile 在 Windows 下自动链接 ws2_32
- README / Makefile / CMakeLists.txt 已更新
## 待办池
1. **[高] Windows 兼容性** — 支持 Windows 构建与运行
2. **[高] HTTPS / TLS** — 生产部署必备
3. **[高] HTTP/2 多路复用** — 长期演进方向
4. **[中] server.c 单元测试** — 需要 mock socket 和 coco 协程环境
5. **[中] 完善 Doxygen 中文注释** — 所有模块的公共 API 需要完整文档
1. **[高] HTTPS / TLS** — 生产部署必备
2. **[高] HTTP/2 多路复用** — 长期演进方向
3. **[中] 完善 Doxygen 中文注释** — 所有模块的公共 API 需要完整文档
### Windows 兼容性详细计划
## Windows 兼容性实现详情
**目标**:在 Windows 上编译运行 cocoon目前仅支持 Linux/macOS
**方案**:引入 `platform.h` + `platform.c` 跨平台抽象层,通过条件编译实现双平台支持
**核心发现**coco 库**已有完整 Windows 支持**`poll_windows.c` 使用 WSAPoll`coco_read/coco_write/coco_accept` 内部调用 `recv/send/accept`)。问题在 cocoon 自身直接调用大量 POSIX API。
**POSIX 路径**`fcntl``O_NONBLOCK``sendfile` 零拷贝,`opendir/readdir/closedir``sysconf`
**方案**:引入 `platform.h` + `platform.c` 平台抽象层,封装所有 POSIX/Windows 差异。
**Windows 路径**`ioctlsocket(FIONBIO)``WSAStartup/WSACleanup``FindFirstFile/FindNextFile``GetSystemInfo``read+send` 64KB 循环
| 变更 | 说明 |
|------|------|
| **新增** | `src/platform.h`, `src/platform.c`, `CMakeLists.txt` |
| **修改** | `server.c`, `static.c`, `main.c`, `server.h`, `Makefile` |
| **移除依赖** | `sys/socket.h`, `sendfile.h`, `dirent.h`, `signal.h`, `unistd.h` |
| **关键映射** | `close()``closesocket()`, `fcntl()``ioctlsocket()`, `sendfile()``read+send` 循环, `opendir()``FindFirstFileA()` |
| **零拷贝** | Windows 上暂时移除 sendfile后续可用 TransmitFile 优化) |
**错误码统一**`WSAEWOULDBLOCK``EAGAIN``WSAEINTR``EINTR``WSAECONNRESET``ECONNRESET`
**执行方式**Option 1 — Subagent-Driven子代理逐个 Task 实现,每步自动 review
**文件清单**
- `platform.h` — 跨平台类型定义、函数声明、宏定义(全部中文注释)
- `platform.c` — POSIX 实现 + Windows 实现(条件编译)
- `CMakeLists.txt` — 全新跨平台构建配置,支持 Linux/macOS/Windows
- 修改 `server.c` — socket 类型、非阻塞设置、socket 关闭、文件元数据、路径处理、CPU 核心数
- 修改 `static.c` — 文件打开/读取/关闭/seek/发送目录遍历socket 发送,路径处理
- 修改 `main.c` — 信号处理、socket 初始化/清理
- 修改 `Makefile` — 添加 platform.cWindows 下链接 ws2_32
## 最近行动记录
- 2026-06-04: **本轮行动 — Windows 兼容性**
- `platform.h`:跨平台抽象层头文件,定义 `cocoon_socket_t`/`cocoon_file_t`/`cocoon_dir_iter_t` 类型
- `platform.c`双平台实现POSIX 分支fcntl/sendfile/opendir+ Windows 分支ioctlsocket/WSAStartup/FindFirstFile
- `server.c`:移除全部 POSIX 头文件,使用跨平台 API`int fd``cocoon_socket_t`
- `static.c`文件操作和目录遍历全部跨平台化sendfile 替代方案 64KB 缓冲区
- `main.c`:信号处理跨平台化,新增 `cocoon_socket_init()`/`cocoon_socket_cleanup()`
- `CMakeLists.txt`:全新跨平台构建配置,自动检测 Windows/POSIX
- `Makefile`:添加 `platform.c`Windows 下自动链接 `ws2_32`
- 单元测试113 个通过Linux 验证集成测试37 项通过
- 推送到 feature/windows-compat-impl
- 2026-06-04: **本轮行动 — Brotli 压缩支持**
- `static.c``brotli_compress()` 函数,使用 `libbrotlienc` 高质量压缩(质量 11窗口 22
- `static_serve_file()`:优先 Brotli回退 Gzip不可压缩/二进制文件跳过