Skip to content

云同步 ​

云同步用于在本地数据目录与 WebDAV 服务之间同步笔记数据及笔记引用的图片。同步是双向的:本地新增或修改的内容可以上传,云端新增或修改的内容可以下载。云同步不等同于独立备份,删除确认和冲突处理仍由同步规则控制。

连接设置 ​

云同步使用 WebDAV 服务作为远端存储。连接设置包括以下内容:

  • 启用云同步:控制云同步功能是否可用。关闭后不会执行启动同步、实时同步或手动同步。
  • WebDAV 地址:填写完整的 http 或 https 地址。
  • 账号:填写 WebDAV 服务使用的账号。
  • 密码或应用令牌:填写服务要求的密码或应用专用令牌。

启用云同步后,连接信息可以编辑和测试。测试连接会检查远端服务是否可访问,并尝试准备 SpringNote 使用的远端目录。测试过程不会修改本地笔记或图片;测试失败时,页面会保留本地数据和当前配置。

连接失败通常表现为地址格式错误、账号或令牌无权限、网络连接失败、请求超时,或远端服务返回了无法识别的内容。连接测试成功只表示当前连接和目录准备可以完成,不代表所有后续同步都能成功。

同步策略 ​

页面提供以下同步时机:

  • 应用启动时自动同步:启动时检查云同步是否启用,并在该选项开启时触发同步。
  • 实时同步:本地数据发生变化后,在云同步已启用且连接信息完整时触发同步。
  • 手动同步:通过云同步页面的手动同步操作立即发起一次同步。
  • 最近一次全量同步:显示最近一次完整同步成功的时间,用于了解本地与云端最近一次完成对齐的时间点。

测试连接和同步执行期间,相关按钮会进入忙碌状态,避免同一时间重复发起操作。同步成功后会更新最近一次全量同步时间;同步失败时,本地编辑内容仍然保留,可以在连接恢复后再次触发同步。

同步范围 ​

云同步包含以下内容:

  • 日报
  • 周报
  • 月报
  • Markdown 内容中引用的共享图片

普通首页输入框选择的文件目前只会把文件名和路径加入输入内容,不会作为真正附件复制到笔记数据目录,因此不会被当作云同步文件处理。

文件变化 ​

同步会根据文件内容变化识别双方状态,而不是只根据文件名称判断。常见变化处理如下:

  • 本地新增的笔记或图片会上传到云端。
  • 云端新增的笔记或图片会下载到本地。
  • 只有一侧发生修改时,修改内容会同步到另一侧。
  • 两侧同时修改同一内容时,本地内容会保留,云端版本会保存为冲突副本,并在同步结果中统计冲突数量。

同步只处理 SpringNote 使用的远端目录和同步范围内的文件,不会把 WebDAV 账户中的其他目录作为笔记内容导入。

删除确认 ​

删除是双向同步中需要确认的操作。为了避免一侧的误删除直接传播到另一侧,以下情况不会立即执行删除:

  • 本地文件已删除,但云端仍然存在。
  • 云端文件已删除,但本地仍然存在。

同步页面会列出待删除的本地文件和云端文件,并通过确认弹窗逐项确认。取消确认时,对应删除不会执行,其他不涉及删除的同步内容仍可继续处理。

如果删除发生后,另一侧又修改了同一文件,则会形成删除修改冲突。此时需要选择覆盖本地、覆盖远端或跳过处理。连续存在待确认项目时,页面会分轮处理确认,最多处理五轮;仍有未处理项目时,需要重新发起同步。

冲突处理 ​

冲突表示本地和云端在上一次同步后都产生了变化,无法直接判断哪一份内容应当覆盖另一份。普通的同时修改会保留本地内容,并将云端内容保存为冲突副本,避免原有内容直接丢失。

删除与修改同时发生时,冲突弹窗提供三种处理结果:

  • 覆盖本地:使用云端版本恢复或覆盖本地文件。
  • 覆盖远端:使用本地版本恢复或覆盖云端文件。
  • 跳过:保留双方现状,不处理该冲突。

状态与异常 ​

云同步页面会区分连接测试、同步进行中、同步成功和同步失败等状态。失败原因可能包括:

  • WebDAV 地址格式不正确。
  • 账号或密码、应用令牌无效,或没有远端目录权限。
  • 网络不可用或请求超时。
  • 本地文件读取、写入或删除失败。
  • 远端返回内容无法解析。
  • 云同步功能未启用。

网络不可用时,本地笔记仍可正常创建和编辑。同步不会因为本地操作失败而清空本地内容;待连接和权限恢复后,可以重新执行手动同步,或等待已启用的启动同步、实时同步条件再次满足。

Released under the AGPL-3.0 license.