Thorium Reader 高亮注释启动时未绘制问题分析

Thorium Reader 高亮注释启动时未绘制问题分析

thorium-reader A cross platform desktop reading app, based on the Readium Desktop toolkit 项目地址: https://gitcode.com/gh_mirrors/th/thorium-reader

问题背景

在 Thorium Reader 电子书阅读器的开发过程中，发现了一个关于高亮注释功能的回归性问题。具体表现为：当用户启动阅读器时，之前添加的高亮注释不会自动绘制显示在文档中，影响了用户体验。

技术分析

该问题源于代码中对注释加载逻辑的跳过处理。在 Thorium Reader 的代码库中，注释加载功能位于渲染器的 Redux sagas 实现部分。具体来说，问题出现在处理注释加载的条件判断逻辑上。

Thorium Reader 支持多种出版物格式，包括 EPUB、PDF、Divina 和有声读物等。然而，注释功能并非在所有格式中都可用，例如 PDF 和有声读物就不支持注释功能。因此，代码中有一个跳过逻辑用于过滤不支持注释的出版物类型。

问题根源

经过深入分析，发现问题出在以下方面：

1. 条件判断过于宽泛：代码在判断是否跳过注释加载时，将 Divina 格式作为过滤条件之一。然而，Divina 格式检查在某些情况下会误判，导致即使是支持注释的 EPUB 格式也被错误跳过。

2. 可访问性 EPUB3 支持受影响：特别值得注意的是，这个问题影响了可访问性 EPUB3 文档的注释显示功能，这类文档本应完全支持注释功能。

解决方案

开发团队通过以下方式解决了这个问题：

1. 精确化格式判断逻辑：修改了跳过注释加载的条件判断，确保只有真正不支持注释的格式才会被跳过。

2. 增强格式检测：改进了对出版物格式的检测机制，避免将支持注释的格式误判为不支持。

3. 回归测试：添加了针对各种格式的注释加载测试用例，确保类似问题不会再次出现。

技术影响

这个修复确保了：

• 用户之前添加的所有高亮注释都能在启动时正确显示
• 不同格式出版物的注释功能行为一致
• 可访问性 EPUB3 文档的注释功能完全可用

总结

这个问题的解决展示了在开发支持多种格式的阅读器时，格式检测和功能兼容性的重要性。通过精确的条件判断和全面的测试，可以确保各项功能在不同格式下都能正常工作，为用户提供一致的阅读体验。

thorium-reader A cross platform desktop reading app, based on the Readium Desktop toolkit 项目地址: https://gitcode.com/gh_mirrors/th/thorium-reader