QAExchange-RS 文档中心

版本: v1.0.0 最后更新: 2025-10-07

欢迎使用 QAExchange-RS 文档！本文档中心提供完整的系统架构、API 参考、集成指南和开发文档。

📚 文档导航

🚀 01. 快速开始

新用户入门必读，快速搭建和运行 QAExchange-RS。

• 快速开始指南 - 5分钟快速上手
• 构建检查清单 - 构建前必读

🏗️ 02. 系统架构

深入了解 QAExchange-RS 的核心架构设计。

• 系统总览 - 整体架构与模块划分
• 高性能架构 - P99 < 100μs 延迟设计
• 数据模型 - QIFI/TIFI/DIFF 协议详解
• 交易机制 - 撮合引擎与交易流程
• 解耦存储架构 - 零拷贝 + WAL 持久化

⚙️ 03. 核心模块

核心功能模块详细说明。

存储系统

• WAL 设计 - Write-Ahead Log 崩溃恢复
• MemTable 实现 - OLTP/OLAP 内存表
• SSTable 格式 - rkyv/Parquet 持久化
• 查询引擎 - Polars SQL 查询
• 复制系统 - 主从复制与故障转移

市场数据模块 ✨ 新增

• 市场数据模块 - 行情数据服务总览
• 快照生成器 - 每秒级别市场快照

通知系统

• 通知架构 - 零拷贝通知推送
• 订阅管理 - 订阅过滤与路由

📡 04. API 参考

完整的 API 文档和协议规范。

WebSocket API

• 协议规范 - DIFF 协议完整定义
• DIFF 协议详解 - 差分同步机制
• 快速开始 - WebSocket 客户端示例

HTTP API

• 用户 API - 用户/账户/订单管理接口
• 管理员 API - 系统管理接口

错误处理

• 错误码参考 - 完整错误码列表

🔌 05. 集成指南

前端集成和序列化指南。

前端集成

• 集成指南 - Vue.js 集成示例
• API 使用指南 - 前端 API 调用规范
• 集成检查清单 - 集成验收标准

序列化

• 序列化指南 - rkyv/JSON 序列化最佳实践

🛠️ 06. 开发指南

开发、测试、部署文档。

• WebSocket 集成指南 - DIFF 协议接入详解
• 测试指南 - 单元测试与集成测试
• K线系统测试指南 - K线端到端测试流程 ✨ 最新
• 部署指南 - 生产环境部署

📖 07. 参考资料

术语表、常见问题、性能基准。

• 术语表 - 专业术语解释（待创建）
• 常见问题 FAQ - 常见问题解答（待创建）
• 性能基准 - 性能测试数据（待创建）

🎓 08. 高级主题

深度技术文档和实现报告。

Phase 报告

• Phase 6-7 实现报告 - 复制系统与性能优化

实现总结

• 市场数据实现 - Phase 9 市场数据增强
• 管理功能实现 - Phase 10 用户管理
• K线实时推送系统 - K线聚合与WebSocket推送完整实现 ✨ 最新

技术深度

• 市场数据增强 - L1 缓存与 WAL 恢复

DIFF 测试报告

• 主测试报告 - DIFF 协议测试结果

🗄️ 09. 归档

历史文档和已废弃的计划。

• 旧计划 - 已完成或废弃的计划文档
• 历史报告 - 开发过程历史报告
• 已废弃 - 已废弃的功能文档

🔍 快速查找

按角色查找

• 新手开发者: 快速开始 → 系统架构
• 前端开发者: WebSocket API → 前端集成
• 后端开发者: 核心模块 → 开发指南
• 运维工程师: 部署指南 → 性能基准
• 架构师: 高性能架构 → 高级主题

按主题查找

• 性能优化: 高性能架构, 解耦存储
• 数据持久化: WAL, SSTable
• 市场数据: 快照生成器, K线聚合系统, K线实时推送 ✨ 最新
• 协议集成: DIFF 协议, 数据模型
• WebSocket: 协议规范, 前端集成, K线推送
• 测试部署: 测试指南, K线测试, 部署指南

📊 文档版本信息

🤝 贡献文档

发现文档问题或想要改进？请参考 贡献指南（待创建）。

📮 反馈与支持

• 问题报告: 请提交 GitHub Issue
• 功能建议: 请提交 Feature Request
• 文档改进: 欢迎提交 Pull Request

最后更新: 2025-10-06 维护者: QAExchange-RS 开发团队