shenlei
3e60bf1869
阅读器在多会话朗读、加密 EPUB 资源、并发打开同一本书和多 UserDefaults 容器等场景下，存在旧异步结果覆盖新状态、锁屏控制串会话、大型明文资源被误拒绝、解压半成品被复用及标注跨容器混用的风险；同时高亮、书签、搜索和设置面板的空状态与自动化可访问性入口不完整。\n\n本次为朗读会话引入代次和当前 utterance 校验，远程控制改为仅响应当前会话并按自身 token 清理；加密资源 provider 先判定是否实际返回解密数据，明文大资源继续流式读取；解压缓存串行化以避免并发复用未完成目录。书签与高亮迁移至受保护文件，按 UserDefaults 容器隔离命名空间，保留标准容器旧文件兼容并确保新副本成功落盘后才删除历史数据。\n\n同步调整缓存淘汰、FoundationModels 弱链接、搜索/标注/设置面板交互与 UI 测试，并更新 Pod 生成配置及 API、风险文档。已执行 git diff --check 和 ReadViewDemo Debug Simulator 构建，结果为 BUILD SUCCEEDED。
5.3 KiB
5.3 KiB
ReadViewSDK 文档索引
最后更新：2026-07-25
核心文档
| 文档 | 说明 |
|---|---|
| ARCHITECTURE.md | 系统架构总览：分层架构、核心数据流、缓存架构、目录结构、设计模式 |
| UML_CLASS_DIAGRAMS.md | UML 类图（Mermaid 格式）：模块关系、核心类图、并发模型、缓存键设计 |
| BUSINESS_LOGIC.md | 业务逻辑详解：EPUB 解析、文本渲染管线、后台解析优化、翻页容器、标注系统、搜索、设置 |
代码级参考文档
| 文档 | 说明 |
|---|---|
| EPUBCore_CODE_REFERENCE.md | EPUBCore 模块代码级文档：解析器、Publication、WebView、JS 桥接、CFI、搜索、资源解析（~50 文件） |
| EPUBTextRendering_CODE_REFERENCE.md | EPUBTextRendering 模块代码级文档：排版管线、文本渲染、分页引擎、构建管线、索引表（~30 文件） |
| EPUBUI_CODE_REFERENCE.md | EPUBUI 模块代码级文档：阅读器控制器、协调器、章节运行时、设置、文本页面、标注（~60 文件） |
| ReaderView_CODE_REFERENCE.md | ReaderView 模块代码级文档：翻页容器、预加载、双页布局、手势、流式布局（14 文件） |
工程规范与风险
| 文档 | 说明 |
|---|---|
| CONCERNS.md | 代码库风险与关注点：12 项安全/性能/可维护性风险（顶部有 2026-07-30 状态复核表） |
| TESTING.md | 测试基础设施：UI 测试文件清单、运行方式、覆盖率 |
| CONVENTIONS.md | 编码规范：命名约定、代码风格、导入规范、错误处理 |
专题文档
| 文档 | 说明 |
|---|---|
| RDAIReaderView/RDAIReaderView-SPEC.md | AI 阅读能力产品范围、兼容策略、实施路线与商用验收门槛 |
| RDAIReaderView/RDAIReaderView-ARCHITECTURE.md | RDAIReaderView 模块、索引、检索、存储、引用和降级架构 |
| RDAIReaderView/RDAIReaderView-API.md | RDAIReaderView 公共模型、Provider、Reader Adapter 和服务 API 合同 |
| RDAIReaderView/RDAIReaderView-AI-SPEC.md | Natural Language 与 Foundation Models 的 Prompt、结构化输出、安全和评测合同 |
| RDAIReaderView/RDAIReaderView-TEST-PLAN.md | AI 商用测试集、质量指标、真机矩阵、CI、灰度与发布门禁 |
| RDAIReaderView/RDAIReaderView-RELEASE-CHECKLIST.md | 本地构建后所需的真机、隐私、TestFlight 与发布验证清单 |
| TYPESetter_PIPELINE.md | Typesetter 排版管线详解：HTML 规范化、语义标记注入、CFI 标记、样式合成为、字体规范化、片段标记 |
| CHAPTER_RUNTIME.md | 章节运行时详解：按需加载、章节窗口协调、页图管理、磁盘缓存、后台补全 |
| CFI_SUBSYSTEM.md | CFI 子系统详解：EPUB CFI 解析、生成、序列化、范围、恢复引擎 |
| CFI_ISSUES_REVIEW.md | CFI 实现问题分析报告：11 个问题（3 高 / 5 中 / 3 低），含修复优先级建议 |
| PAGINATION_ISSUES_2026-07-06.md | 分页问题调查记录：脚注图标 avoid-trim 裁行（已修复）＋页范围/显示度量错配行中断页（待复现），含调试命令备忘 |
| LONG_CHAPTER_MEMORY_OPTIMIZATION_PLAN.md | 长章节内存优化低风险实施方案：在保留整章上下文布局正确性的前提下，分阶段收敛整章副本、共享 layouter、治理缓存与图片内存 |
| API_REFERENCE.md | 公开 API 参考：RDEPUBReaderController 公开接口、委托协议、配置模型 |
| 当前阅读器问题修复开发清单.md | 基于当前代码实现整理的逐任务开发计划：10 个任务、修改位置、实施步骤、风险点与验收标准 |
| 大书远距目录跳转与后台补全优化方案.md | 面向大书按需分页模式的完整优化方案：远距目录跳转、后台补全优先级、页图接管协议与分阶段实施路径 |
| 标准级EPUB定位与兼容能力开发蓝图.md | 面向商业级 EPUB 阅读器的可执行蓝图：完整版 CFI、无 id 节点双向恢复、脚注弹层、字体回退与 CSS 兼容层 |
| 大书后台解析优化实施清单_30秒目标.md | 《凡人修仙传》后台解析性能优化方案，目标从 70s 压缩到 30-50s |
项目信息
- 模块总数： 4 个（EPUBCore、EPUBTextRendering、RDEpubReaderView、EPUBUI）
- Swift 文件数： 142 个（SDK Sources）
- 测试用例数： 23 个测试类，约 99 个测试方法（UI 测试）
- 最低 iOS 版本： 15.6
- 构建方式： CocoaPods（本地 pod）