书籍数据多端同步方案梳理-iOS

Epub

笔摘记同步方案

上报笔记摘记数据

上报接口均为：API_addNote，后台以 note_type 字段值作为区分，具体参数如下：

NSMutableDictionary *params = @{
        @"note_type":           type,           //0--笔记；1--摘记
        @"app_type":            @"iOS",
        @"take_note":           markModel.markContent,  // 原文内容
        @"notes":               markModel.markInfo, // 用户笔记内容，摘记时为空
        @"book_id":             markModel.bookId,
        @"ios_location_note":   jsonString,     // 定位数据
    }.mutableCopy;
/// 

/// 上报成功处理提示：
if ([type isEqualToNumber:@1]) {
    [ToastTool showTipMessageInWindow:@"可到‘我的笔记’查看"];
} else {
    [ToastTool showTipMessageInWindow:@"可到‘我的摘记本’查看"];
}

获取笔记摘记数据

获取接口为：
笔记 - API_getNoteByBookId
摘记 - API_getNoteByBookId

/** 模型
@property (nonatomic, copy) NSString *iosLocationNote;  // iOS定位数据
@property (nonatomic, copy) NSString *webLocationNote;  // Android定位数据
@property (nonatomic, copy) NSString *takeNote;     // Web定位数据
*/

/** 某条笔/摘记解析后的数据模型示例：
<MyNoteModel> 
   [takeNote]: 她惊异地摇了摇头：“没有。你怎么会想到他要给我包裹？”
   [id]: 4625f96c6f0b4e45b48e5579e6bd1a03
   [notes]: ?shide
   [webLocationNote]: <nil>
   [locationNote]: <nil>
   [chapterTitle]: <nil>
   [iosLocationNote]: {"playOrder":5,"CharIndex":0,"ParagraphIndex":1007,"Element...
   [createTime]: 2020-07-14 08:50:37
   [isOpening]: 0
</MyNoteModel>
*/

/** iosLocationNote 定位数据
{
    "playOrder":5,
    "CharIndex":0,
    "ParagraphIndex":1007,
    "ElementIndex":0,
    "timeStamp":1594687821.30233,
    "indexEnd":2115,
    "chapterId":"8232126329250033",
    "startOffset":0,
    "markContent":"她惊异地摇了摇头：“没有。你怎么会想到他要给我包裹？”",
    "markInfo":"?shide",
    "markType":0,
    "endText":"她惊异地摇了摇头：“没有。你怎么会想到他要给我包裹？”",
    "contentPathId":"id122",
    "markId":"6612626366525154",
    "paragraph":1007,
    "startText":"她惊异地摇了摇头：“没有。你怎么会想到他要给我包裹？”",
    "Uid":"6612626366525154",
    "bookId":"18d109dbf6ff4c3fb5e3f54d150615df",
    "myEnd":{
        "ParagraphIndex":1007,
        "CharIndex":1,
        "ElementIndex":27
    },
    "endOffset":26,
    "indexStart":2089
}
*/

其中用于同步的字段为：

/*三端笔记摘记数据同步/
@property (nonatomic, copy) NSString *contentPathId; //笔记所在章节的文件ID，解析书籍内opf文件可知'id'
@property (nonatomic, copy) NSString *startText; //笔记起始段落内容
@property (nonatomic, copy) NSString *endText; //笔记结束段落内容

@property (nonatomic, assign) NSInteger startOffset; //笔记结束位置本段落内偏移量
@property (nonatomic, assign) NSInteger endOffset; //笔记结束位置本段落内偏移量

方案描述：

三端（iOS、Android、Web）均上报以上字段值，解析不同端的数据时以此为准！
具体描述：
epub书籍文件是一个大的压缩包，里面包含着若干描述书籍信息和内容的文件，阅读时会先将其解压缩后放置一个文件夹内，然后再对这些文件做解析处理。通常，epub书籍内容是由N个文件的内容组合而成，一个文件里存放着一个章节的内容；然而，也有少部分epub书籍的内容只有一个内容文件，这个仅有的文件里存放着N个章节。但是无论那种情况，这些章节文件都有对应的ID（即上报的字段contentPathId），它们的对应关系在++content.opf++文件里可以看到。

content.opf

由于Android、iOS两端所采用对epub的底层解析库的不同，使得两端对各自数据的定位方式不一样（Android解析后的内容数据都是基于段落的位置，其段落的规则较复杂，iOS无法与其准确对应），经过多次调试验证，最终决定++采用章节内内容匹配的方式来定位数据，然后转换成各自需要的数据进行处理++。
++为减少误差，先进行开始段落和结束段落的位置匹配，然后再根据段落内的偏移量确定具体内容++。
例如：iOS数据定位是根据章节内容的偏移量来定位，当获取到Android或Web的数据后，将他端原始数据经过方法处理后转成自己需要的章节序列号及偏移量，再进行后续操作即可。


**数据转换**
- (EpubMarkModel *)epubMarkModelConversion:(id)object {
    if ([object isKindOfClass:[EpubMarkModelForAndroid class]]) {
    //安卓笔摘记
    /**********数据处理***********/
    return iOSModel;
    } else {
    //Web笔摘记
    /**********数据处理***********/
    return iOSModel;    
    }
}

进度同步:

章节contentPathId、基于章节内容的偏移量currentIndex

Txt

txt书籍内容结构简单，仅有单独一个txt文件，直接加载内容。
笔摘记同步方案：

上报笔记摘记划线内容的起始位置、结束位置，这个是相对于整本书的内容的。

@property (nonatomic, assign) NSInteger indexStart; //想法起始位置
@property (nonatomic, assign) NSInteger indexEnd;   //想法结束位置

进度同步:

章节contentPathId、基于章节内容的偏移量currentIndex

PDF

同步方案：
// 无笔记摘记

进度同步：页码 page