备份手机端设计说明书.docVIP

备份手机端设计说明书 产品版本号：v0.1 修订记录 版本 简要变更说明 变更人 变更日期 0.1.0 新建 曾永昌 2012-12- v0.1.1 表格调整 邵彬 2012-12-21 v0.1.2 API返回结果需要增加result_code, result_msg 邵彬 2012-12-21 v0.1.3 改成并行上传/下载 曾永昌 2012-12-24   目录 1. 功能概况 1 2. 备份过程描述 1 3. 恢复过程描述 2 4. 删除云端已备份记录过程描述 3 5. 希望服务器端做出的调整 3 5.1. 新增3张表 3 5.2. 上传文件的API变更 4 5.3. 下载文件的api不变 5 5.4. 去掉返回文件信息的filelists api和获取空间信息的userspaces api 5 5.5. 新增get overview api 5 5.6. 新增get detail api 6 5.7. 删除api变更 7 6. 对比同类产品 7 6.1. Sprite backup 7 6.2. 乐同步（联想的安卓备份） 8 6.3. QQ同步助手 8 6.4. YY备份 9 1. 功能概况 按‘次’备份。按次就是用户备份的历史记录，用户点了多少次备份按钮，就相当于备份了多少次。用户可以将以前某一次的已备份数据拿来恢复。 本备份产品包含7个备份种类：联系人、短信、彩信、日程、记事本、图片、应用程序。 对于前5个种类，用户可以选其中之1，之2...之5个来备份。每个种类要向云端上传的就是1个打包文件。于是生成5个文件。并行上传，如果检测到中途断网或用户点击取消上传，需要让用户选择是否保留已经上传成功的类别；或者是舍弃，会把已经传进去的删了。 对于上传图片、应用程序分得较细：1张1张地传图片，1个程序1个程序地传（这里指的1个程序的备份是apk + app_data的打包文件）。 每传一个文件都带上备份时间，使服务器知道这个文件属于那次备份。服务器端需要维护一个backup_history的表（后面会详细介绍）。 2. 备份过程描述 7个分类各自并行备份，都是先本地备份，再上传到云端。传一个应用程序要传两个文件：appIcon和appPkg，且先传appIcon，再传appPkg。每个分类上传都调用upload api（后面会详细介绍），upload api会返回是否上传成功，如果所有分类的上传都返回成功，就告知用户云备份顺利完成。 上传时显示一个上传的剩余时间。当中途断网或用户取消上传，会提示让用户选择是否保留已上传的数据。如果不保留就删除已上传数据。 上传都会带上file_type(详细介绍见后面的一节：‘希望服务器端做出的调整’）： 当file_type小于6时，还会带上small_file_category_count，服务器接收并存储了文件，得到的fileId写到backup_history表对应种类的xx_fileId栏。small_file_category_count写入backup_history表对应种类的xx_count栏。 当file_type等于6，得到的fileId插入到image表。 当file_type为7或8时，得到的fileId插入或更新app表的icon_fileId或appPkg_fileId栏。 上传流程示例图(见下页,右半边是服务器的)： 3. 恢复过程描述 准备工作是加载已备份列表，就是获取backup_history表的历次备份信息，该表的一行里面包含的字段主要有7个类别的每个类别的个数，（就是几条短信，几个联系人），当然用户的那次备份不一定选满7个类别，就返回其中有值的类别就可以了,还有返回一个占用空间的total_size字段，即每一次备份记录占用云端多少空间，用于删除。 用户点进某次备份记录后，再获取这次备份的各文件的fileId、每个应用程序压缩包的fileId、图标文件fileId、应用程序名称、应用程序大小。每一条备份记录包含若干个类别，用户勾选了一些类别来恢复，选上的类别知道fileId，就可以去下载文件。下载有优先级，即图片和应用程序的优先级比其他分类要低（因为它们块头大），先下那5个类别，并行下载，下完一个类别开始恢复一个类别。在断网前，下了多少恢复多少。 恢复过程示例图（右半边是服务器的）： 4. 删除云端已备份记录过程描述 在客户端是按次删除的，客户端把这次备份的backup_time传给服务器，服务器删除这次备份