MeBox/docs/reader-plan.md

MeBox 阅读功能实施计划（legado 书源兼容）

分支：feature/reading 目标：在首页增加「影视 / 阅读」模式切换，阅读模式完整兼容阅读 3.0（legado）书源体系，覆盖 文本（bookSourceType=0）、音频（=1）、漫画/图片（=2） 三类源。 实现方式（用户明确要求）：样式与逻辑全部仿造 refgd/legado 本体，不参考其他重实现项目；相当于用 Go + React 18 + TypeScript 5 重写该项目。 界面与交互的唯一规格：docs/reader-ui-spec.md（从 legado 源码逐屏调研产出）。 规则引擎的唯一语义基准：legado app/src/main/java/io/legado/app/model/analyzeRule/ 源码，Go 侧逐方法移植对拍（源码克隆在 C:\MyProject\_ref\legado，仅作对照，不进入构建）。

1. 范围

做：

• 首页「影视/阅读」切换，阅读模式下有独立首页（书架/搜索/发现/最近阅读）
• legado 书源导入与管理（URL 导入、文本/JSON 粘贴导入、启停、分组、排序）
• 三类书源的完整链路：搜索 → 详情 → 目录 → 正文/播放列表/图片列表
• Go 侧规则引擎：CSS(jsoup 风格) / JSONPath / XPath / 正则 / 内嵌 JS 五种语法及其组合
• 文本阅读器、音频播放器、漫画阅读器三套前端 UI
• 追更、阅读进度同步（服务端存储，多端一致）、换源、替换净化规则

不做（本期明确排除）：

• webView 类规则（需要无头浏览器，识别后标记该源为不兼容并提示）
• 登录类书源（loginUrl / loginUi 交互）
• RSS/订阅源、TTS 朗读、文件类型源（bookSourceType=3）
• 本地 TXT/EPUB 导入（列为后续可选）

2. 总体架构

沿用 MeBox 现有分层，全部新增代码集中在：

internal/
  model/            # 新增 5 张表，注册进 AllModels() 自动迁移
  repository/       # reader 相关 GORM 封装
  service/reader/   # 规则引擎 + 书源业务（核心新增，预计占全部后端代码 70%）
  handler/          # /api/reader/* 路由组
web/src/
  pages/reader/     # 阅读端独立页面群（懒加载路由）
  components/reader/

基建复用：internal/helper/http.go（浏览器 UA + 代理回退 HTTP 客户端）、internal/service/runtime_cache.go（正文/目录/搜索缓存，内存+Redis）、internal/service/image_proxy*（封面与漫画图片代理）、internal/handler/ws.go 的 WSHub（搜索进度、追更任务推送，新增 reader:* topic）。

数据流：书源 JSON 存库 → 搜索/发现时按启用的源并发抓取（errgroup + 信号量限流，超时熔断）→ 结果聚合 → 前端。正文、播放地址、图片列表由服务端组装（含 nextContentUrl 翻页合并）后带 TTL 缓存下发；音频流与漫画图片按需经服务端代理补 UA/Referer 头。

3. 规则引擎（核心工作）

语义基准：gedoor/legado app/src/main/java/io/legado/app/model/analyzeRule/ 下的 AnalyzeRule / AnalyzeByJSoup / AnalyzeByJSonPath / AnalyzeByRegex / AnalyzeUrl，逐项对拍测试。

3.1 组件与选型

组件	选型	说明
HTML/CSS	PuerkitoBio/goquery	jsoup 等价物；jsoup 特有语法（class.x / id.x / tag.x / text.x / children / @text / @textNodes / @html / 属性选择）自己包一层
XPath	antchfx/htmlquery	对齐 JsoupXpath 语义
JSONPath	PaesslerAG/jsonpath（备选 ohler55/ojg）	Jayway 语义 + 自实现 ||/&& 合并层，选型阶段需验证
正则	Go regexp（RE2）	legado 部分源用 Java 正则语法，回退换 dlclark/regexp2
JS	dop251/goja	ES2017+，跑书源内嵌 JS
字符集	golang.org/x/text	GBK/GB18030 解码

3.2 引擎能力清单

• 规则模式识别：@css: / $.(JSONPath) / @XPath:或// / <js>与@js: / ## 正则替换段
• 列表组合符 && / || / %%，变量存取 @put:{} / @get:{}，内嵌 JS {{ }}
• jsoup 分析器、JSONPath 分析器、XPath 分析器、正则分析器，以及混合规则的链式解析（AnalyzeRule 的分段执行语义）
• AnalyzeUrl：{{key}}/{{page}} 变量、<js> 生成 URL、URL 后 ,{...} 选项（method/body/charset/headers/retry/timeout/type/proxy/js/webView）
• JS 沙箱：goja 运行时 + 执行超时中断 + 禁止直接 IO；上下文注入 java、source、book、baseUrl、result 等对象
• java.* 桥接函数（按书源实际使用频率分批实现）：
  • 网络：ajax / ajaxAll / connect / get / post / head
  • 编解码：base64Decode/Encode（含 URL-safe）、hexDecode、encodeURI/decodeURI、htmlDecode
  • 加解密：md5(16/32)、sha1/sha256、AES/DES/3DES/RSA（CBC/ECB + 常见 padding/key 语义，legado 源里最常见的坑）
  • 字符串与时间：replaceAll/substring/正则族、timeFormat 等
  • 规则回调：java.getString/getElement 等，桥回 Go 规则引擎（JS 与规则互相嵌套的关键）

3.3 兼容策略

• 引擎按能力分层实现，每个能力配真实书源样本的单测（fixtures 放 internal/service/reader/testdata/）
• 提供 CLI 冒烟工具（如 cmd/reader-smoke）：对批量导入的公开书源集跑 搜索/详情/目录/正文 全链路，输出成功率报告，作为每个阶段验收依据
• 含 webView 选项的源直接判定不兼容并在书源管理页标注

4. 数据模型（新增表）

表	关键字段
book_sources	name, group, type(0/1/2), source_url, json(原文), enabled, custom_order, last_check_at, comment
books（书架）	source_url, book_url, name, author, cover_url, intro, kind, type(文本/音频/图片), latest_chapter, total_chapters, last_read_chapter_index, last_read_at
book_chapters	book_id, index, title, url, is_volume, update_time
read_progress	book_id(唯一), chapter_index, position(滚动/秒/图片序), updated_at
replace_rules	name, find, replace, scope, is_regex, enabled, order

阅读器显示设置（主题/字体/翻页方式）存前端 localStorage，不上服务端。

5. API 设计（/api/reader/*）

• 书源：GET/POST/DELETE /sources、POST /sources/import（URL 或 JSON/base64 文本，自动识别格式与类型）、PATCH /sources/:id（启停/排序）
• 搜索：POST /search {keyword} → 后台聚合任务，结果经 WS reader:search 增量推送；结果可一键加入书架
• 发现：GET /explore?source=&group=（解析 exploreUrl 的 分组名::url 结构）
• 书架：GET/POST/DELETE /books、GET /books/:id/info、GET /books/:id/toc、POST /books/:id/refresh（追更）
• 内容：GET /books/:id/chapters/:idx/content —— 按书籍类型返回：
  • 文本：{type:"text", content:"..."}（服务端已合并 nextContentUrl 翻页、已应用替换规则）
  • 音频：{type:"audio", tracks:[{url,title}]}（含代理路径与所需请求头）
  • 图片：{type:"image", images:[{url, style}]}（同样经代理）
• 进度：PUT /books/:id/progress
• 替换规则：/replace-rules CRUD
• 调试：POST /debug {source_id, rule, url}（书源调试器后端）
• 图片/流代理：复用现有 image_proxy / stream_proxy 模式，按源配置注入 UA/Referer

6. 前端设计

• 首页切换：HomePage.tsx 顶部加分段控件（仿 LibraryTagBar tab 模式），「阅读」切到阅读首页；选择持久化（zustand + localStorage）
• 阅读首页：继续阅读横排 + 书架封面网格 + 搜索入口 + 追更提示
• 页面群（懒加载，仿 appRoutes.tsx）：/reader（首页）、/reader/search（多源并发搜索 + 实时进度）、/reader/explore、/reader/book/:id（详情 + 目录 + 换源）、/reader/sources（书源管理 + 调试器）
• 三套阅读器：
  • 文本：滚动 + 分页双模式（CSS 分栏测量分页）、主题（含夜间）、字体/行距/边距、点击翻页区、章节预加载、进度上报
  • 音频：hls.js（已是依赖）+ <audio> 兜底，播放列表、倍速、记忆进度、锁屏/息屏策略
  • 漫画：上下滚动 / 左右翻页双模式、相邻图片预加载、imageStyle 支持

7. 阶段划分

阶段	内容	交付物
P0 引擎地基 ✅	规则引擎核心（四分析器 + 规则拆分/组合/变量）+ AnalyzeUrl v1（GET/POST/charset/headers/变量/页码模式）+ 表结构 + 书源导入/管理 API + 搜索/详情/目录/正文/书架/进度/调试 API	已完成：internal/service/reader/rule/（规则引擎，~2800 行，对齐 AnalyzeRule/AnalyzeByJSoup/AnalyzeByJSonPath/AnalyzeByXPath/AnalyzeByRegex/AnalyzeUrl/RuleAnalyzer）+ 服务层 + /api/reader/* 路由 + 单测/端到端测试全绿
P1 文本源全链路 + 首页切换	搜索聚合（WS 进度）/详情/目录/正文（nextContentUrl 合并、缓存）+ 前端首页切换、书架、搜索、详情、文本阅读器 v1（阅读器样式仿 legado：9 宫格点击、主题、翻页动画）	用纯规则型文本源完成「搜书→加入→阅读」全流程
P2 JS 与兼容率爬坡	goja 接入 + java.* 桥分批实现 + 加解密族 + URL 完整选项 + replaceRegex + 替换规则管理 + 书源调试页（仿 legado 逐条日志流式输出）+ 冒烟指标报告	主流公开文本源通过率显著提升，形成回归基线
P3 音频源	播放列表解析、音频代理（带 UA/Referer）、音频播放器页（仿 ReadAloudDialog 布局：上一章/播放/下一章/定时/倍速）、进度记忆	音频源可听
P4 漫画/图片源	图片列表解析（含翻页）、图片代理接入磁盘缓存、漫画阅读器双模式（MangaMenu：顶栏+底部胶囊）、预加载	漫画源可看
P5 体验完善	换源（ChangeBookSourceDialog 四档排序）、追更（定时刷新目录 + 缓存清理）、发现页（exploreUrl 标签条）、阅读器高级设置（页眉页脚提示、点击区域自定义）、书源编辑器六 Tab、备份导出；可选：本地 TXT/EPUB	完整体验

P0–P2 是主体（约全部工作量 60–70%），P3/P4 相对独立可并行。

8. 风险与对策

• 书源质量参差：单源解析全程超时与重试上限；正文翻页循环设页数上限防死循环
• goja 性能：复杂 JS 源解析慢 → 正文/目录强缓存、单源并发限 1、全局执行预算
• Java 正则/JSoup 细节差异：以对拍测试驱动修正，regex 备选 regexp2
• 热源防盗链：图片与音频一律走带请求头的代理
• 合规：不内置任何书源，全部由用户自行导入，管理页附免责说明

9. 参考

• 唯一语义与样式基准：https://github.com/refgd/legado （规则引擎 analyzeRule 源码 + UI 布局/交互，见 docs/reader-ui-spec.md）
• 书源规则教程：https://mgz0227.github.io/The-tutorial-of-Legado/