ReadViewSDK/Sources/RDPDFReaderView/README.md

59 lines
2.9 KiB
Markdown
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# RDPDFReaderView
独立的 UIKit PDF 阅读交互 SDK。当前第一阶段只包含与业务无关的部分分页、双指缩放、双击缩放、放大后拖动以及画笔模式下的手势隔离。
主工程的下载、解密、缓存、链接、标注和持久化仍由现有 PDF Feature 管理;后续通过适配层逐步迁移,避免把业务问题和手势问题混在一起。
## PDF 数据来源
普通 PDF 可以由 SDK 使用 PDFKit 直接解析:
```swift
let reader = try RDPDFReaderViewController(
pdfURL: fileURL,
bookIdentifier: stableBookID,
password: standardPDFPassword,
persistence: persistence,
annotationPersistence: annotationStore
)
```
自定义加密 PDF 继续由宿主解密并提供页面图片,不需要把原始文件交给 SDK
```swift
let reader = RDPDFReaderViewController(
pageProvider: encryptedImageProvider,
persistence: persistence,
annotationPersistence: annotationStore
)
```
两种入口最终都转换为 `RDPDFReaderPageProvider`共用翻页、缩放、目录、书签、OCR、标注和画笔功能。内置 PDFKit 数据源按需渲染页面、限制最大图片尺寸并使用内存缓存;能够读取的原生 PDF 文字会直接用于选择和标注,图片扫描页则按配置回退到 OCR。
## 调试入口
在任意测试宿主中 push `RDPDFReaderDebugViewController()`
```swift
navigationController?.pushViewController(RDPDFReaderDebugViewController(), animated: true)
```
验证顺序:
1. 双指捏合能连续放大和缩小。
2. 双击能在适配尺寸与两倍缩放之间切换。
3. 放大后单指只能拖动内容,不能翻页。
4. 切到“画笔模式”后,单指不再翻页,双指仍能缩放和拖动。
如果这个独立页面工作正常,而主阅读页仍失效,问题就能确定在主工程的页面层/覆盖层,而不是缩放内核。
## 图片型 PDF 的文本、复制与标注
主程序即使只能提供每页图片,也可以接入文字功能:
1. 若主程序已有 PDF 解析结果,在 `RDPDFReaderPageDescriptor.textRuns` 中传入文字和相对图片的 `0...1` 坐标;这条路径提供最准确的复制和高亮。
2. 若没有文字坐标,使用 `RDPDFReaderImageTextRecognizer` 对当前页图片按需 OCR再把结果赋给 `RDPDFReaderImageTextLayerView.textRuns`
3. OCR 也不可用时,文字层会提供区域框选;区域标注只显示“高亮、注释”,不会错误地提供复制。
高亮与注释统一使用 `RDPDFReaderAnnotation`,坐标同样是相对图片的 `0...1` 比例,缩放、旋转或重新渲染页面后仍能对齐。使用 `RDPDFReaderPersistenceStore` 保存时,请传入宿主稳定的书籍 ID可附账号和内容版本对应的目录并对 `addAnnotation`、`updateAnnotation`、`deleteAnnotation` 的 `throws` 结果做错误提示;文件损坏或版本不兼容时 SDK 会拒绝覆盖原数据。