OpenHarmony菜单如何进行数据备份与恢复

OpenHarmony菜单数据备份与恢复

一、先明确备份对象与范围

• 菜单数据通常分为两类：
  1. 应用内菜单配置（如侧边栏、设置页、桌面快捷方式等的顺序、分组、可见性、自定义项）；
  2. 系统级菜单配置（如全局设置项、系统应用菜单项）。
• 备份方式取决于数据存放位置：
  • 若菜单配置保存在应用的用户目录（如应用私有目录或应用文件目录），可通过系统的备份恢复框架纳入备份；
  • 若菜单配置保存在分布式数据/KV存储（如 MMKV），可使用其提供的备份/恢复接口；
  • 若应用提供导入/导出功能，可直接使用 JSON/XML 文件进行手动迁移。
• 注意：系统级菜单配置通常受系统策略限制，普通应用无法直接读写，需由系统应用或厂商配置能力开放。

二、原生应用接入系统备份恢复框架

• 适用场景：将应用的菜单配置（JSON/配置表/数据库等）纳入系统级备份，随系统备份任务自动处理。
• 核心步骤：
  1. 在模块配置中注册备份扩展：在 module.json5 的 extensionAbilities 增加类型为 “backup” 的 BackupExtensionAbility，并在 metadata 中声明资源 “ohos.extension.backup” 指向备份配置文件。
  2. 在工程的 resources/base/profile 下提供备份配置文件（如 backup_config.json），通过 allowToBackupRestore、includes、excludes、fullBackupOnly、restoreDeps 控制备份范围与行为。
  3. 在 BackupExtensionAbility 中可按需重写 onBackup/onBackupEx、onRestore/onRestoreEx 做数据预处理/后处理（如无特殊需求可空实现，框架将按规则备份 includes 路径）。
  4. 权限与限制：应用自身不能主动触发备份/恢复；备份/恢复由系统按计划或用户触发，且需满足路径长度、访问权限、相对路径与软链接等约束。
• 示例配置与要点（精简）：
  • module.json5 片段：
    • “extensionAbilities”: [{ “name”: “BackupExtensionAbility”, “type”: “backup”, “exported”: false, “metadata”: [{ “name”: “ohos.extension.backup”, “resource”: “$profile:backup_config” }], “srcEntry”: “./ets/BackupExtension/BackupExtension.ets” }]
  • backup_config.json 片段：
    • { “allowToBackupRestore”: true, “includes”: [“/data/storage/el2/base/files/users/your_app/”], “excludes”: [], “fullBackupOnly”: false, “restoreDeps”: “” }
      以上做法适用于将应用私有目录中的菜单配置纳入系统备份。

三、系统应用主动触发备份与恢复

• 适用对象：仅对系统应用开放。系统应用可在特定流程中主动发起备份/恢复，例如设备迁移、OTA 后数据迁移、企业设备管理。
• 关键接口与流程：
  1. 申请权限：ohos.permission.BACKUP；
  2. 导入模块：@ohos.file.backup；
  3. 获取能力文件：调用 backup.getLocalCapabilities()，得到当前用户下各应用的可备份信息与空间占用；
  4. 创建会话并发起备份/恢复：备份阶段服务会将应用数据打包，通过回调 onFileReady 提供打开的文件句柄，应用可读取并持久化到目标位置；恢复阶段按同样机制写入。
• 示例（获取能力文件）：
  • import backup from ‘@ohos.file.backup’; import common from ‘@ohos.app.ability.common’; import fs from ‘@ohos.file.fs’;
  • let context = getContext(this) as common.UIAbilityContext;
  • let filesDir = context.filesDir;
  • let fileData = await backup.getLocalCapabilities();
  • fs.copyFileSync(fileData.fd, filesDir + ‘/localCapabilities.json’); fs.closeSync(fileData.fd);
• 说明：该能力面向系统应用，普通应用无法调用；备份/恢复的具体打包与传输由框架完成，应用侧主要做会话管理与文件持久化。

四、使用 MMKV 对菜单配置做轻量级备份恢复

• 适用场景：菜单配置保存在 MMKV（键值对/可序列化对象）中，需要快速迁移或本地备份。
• 核心步骤：
  1. 初始化 MMKV：设置 rootPath/cachePath；
  2. 使用支持备份的实例：如 MMKV.getBackedUpMMKVWithID(…)；
  3. 备份：
     • 单实例：MMKV.backupOneToDirectory(mmapID, backupRootDir, otherDir)；
     • 全部：MMKV.backupAllToDirectory(backupRootDir)；
  4. 恢复：
     • 单实例：MMKV.restoreOneMMKVFromDirectory(mmapID, srcDir, otherDir)；
     • 全部：MMKV.restoreAllFromDirectory(srcDir)。
• 说明：MMKV 适合菜单这类结构化小数据的快速备份/恢复与跨设备迁移，接口简洁、可加密、支持对象序列化。

五、无框架支持时的手动导出导入

• 适用场景：应用未接入备份框架、或需要跨设备/离线迁移菜单配置。
• 实现建议：
  • 在应用内提供“导出配置”功能，将菜单配置序列化为 JSON/XML 并保存到公共可访问目录（如 Documents）；
  • 在目标设备上通过“导入配置”读取文件并校验版本/兼容性后写回应用配置；
  • 注意对相对路径、软链接、特殊字符的处理，并做好加密与完整性校验（如哈希/签名），避免配置被篡改。
• 说明：该方式依赖应用自身实现，灵活度高，但对版本兼容与数据安全需自行保障。