OpenHarmony实战开发-通过BackupExtensionAbility实现应用接入数据备份恢复

应用接入数据备份恢复需要通过BackupExtensionAbility实现。

BackupExtensionAbility，是Stage模型中扩展组件ExtensionAbility的派生类。开发者可以通过修改配置文件定制备份恢复框架的行为，包括是否允许备份恢复，备份哪些文件等。

接口说明

约束与限制

• 当备份恢复时，所有待备份文件及目录的路径不得超过4095字节，否则将导致未定义行为。
• 当备份目录时，应用进程必须拥有读取该目录及其所有子目录的权限（DAC中的r），否则将导致备份失败。
• 当备份文件时，应用进程必须拥有搜索该文件所有祖父级目录的权限（DAC中的x），否则将导致备份失败。

开发步骤

1.在应用配置文件module.json5中注册extensionAbilities相关配置

新增"extensionAbilities"字段，其中注册类型"type"设置为"backup"，元数据信息"metadata"新增一个"name"为"ohos. extension. backup"的条目。

BackupExtensionAbility配置文件示例：

{
    "extensionAbilities": [
        {
            "description": "$string:ServiceExtAbility",
            "icon": "$media:icon",
            "name": "BackupExtensionAbility",
            "type": "backup",
            "visible": true,
            "metadata": [
                {
                    "name": "ohos.extension.backup",
                    "resource": "$profile:backup_config"
                }
            ],
            // 在BackupExtension.ts文件里自定义继承BackupExtensionAbility，重写其中的onBackup和onRestore方法。
            // 如果没有特殊要求可以空实现，则备份恢复服务会按照统一的备份恢复数据规则进行备份恢复。
            "srcEntrance": "./ets/BackupExtension/BackupExtension.ts", 
        }      
    ]
}

2.新增元数据资源配置文件

在元数据资源配置文件中，定义备份恢复时需要传输的文件。元数据资源配置文件名称需要与module.json5中"metadata.resource"名称保持一致，其保存位置在工程的resources/profile文件夹下。

元数据资源配置文件示例：

{
    "allowToBackupRestore": true,
    "includes": [
        "/data/storage/el2/base/files/users/"
    ],
    "excludes": [
        "/data/storage/el2/base/files/users/hidden/"
    ],
    "fullBackupOnly": false,
    "restoreDeps": "",
}

3.开发者可以在BackupExtension.ts文件中自定义类继承的BackupExtensionAbility，通过重写其onBackup和onRestore方法，使其达到在备份预加工应用数据或者在恢复阶段加工待恢复文件。

如果没有特殊要求可以空实现，则备份恢复服务会按照统一的备份恢复数据规则进行备份恢复。

下面的示例展示了一个空实现的BackupExtension.ts文件。

import BackupExtensionAbility, {BundleVersion} from '@ohos.application.BackupExtensionAbility';
import {hilog} from '@Kit.PerformanceAnalysisKit';

const TAG = `FileBackupExtensionAbility`;
export default class BackupExtension extends  BackupExtensionAbility {
  async onBackup ()   {
    hilog.info(TAG, `onBackup ok`);
  }

  async onRestore (bundleVersion : BundleVersion) {
    hilog.info(TAG, `onRestore ok ${JSON.stringify(bundleVersion)}`);
    hilog.info(TAG, `onRestore end`);
  }
}

元数据资源配置文件说明

说明：

有关fullBackupOnly字段的说明

• 当fullBackupOnly为false时，恢复的数据意味着会对同路径下的同名文件进行覆盖。
• 当fullBackupOnly为true时，恢复数据会以 /data/storage/el2/backup/restore/
  为根目录解压数据，开发者可在OnRestore内访问数据进行最终的恢复。

开发者可根据自身的业务场景，选择对应的恢复数据方式。如果配置了fullBackupOnly为true，那么开发者需要在OnRestore内自行实现恢复数据的逻辑。

举个例子：假设应用的数据备份路径为：data/storage/el2/base/files/A/
。那么在恢复时，数据会被解压到：/data/storage/el2/backup/restore/data/storage/el2/base/files/A/
目录下。

includes默认值：

{
    "includes": [
    "data/storage/el1/database/",
    "data/storage/el1/base/files/",
    "data/storage/el1/base/preferences/",
    "data/storage/el1/base/haps/<module-name>/files/",
    "data/storage/el1/base/haps/<module-name>/preferences/",
    "data/storage/el2/database/",
    "data/storage/el2/base/files/",
    "data/storage/el2/base/preferences/",
    "data/storage/el2/base/haps/<module-name>/files/",
    "data/storage/el2/base/haps/<module-name>/preferences/",
    "data/storage/el2/distributedfiles/"
    ]
}

如果大家还没有掌握鸿蒙，现在想要在最短的时间里吃透它，我这边特意整理了《鸿蒙语法ArkTS、TypeScript、ArkUI、相关教学视频》以及《鸿蒙生态应用开发白皮书V2.0PDF》《鸿蒙开发学习手册》（共计890页）鸿蒙开发资料等…希望对大家有所帮助：https://docs.qq.com/doc/DZVVBYlhuRkZQZlB3

鸿蒙语法ArkTS、TypeScript、ArkUI等…视频教程：https://docs.qq.com/doc/DZVVBYlhuRkZQZlB3

OpenHarmony APP开发教程步骤：https://docs.qq.com/doc/DZVVBYlhuRkZQZlB3

鸿蒙生态应用开发白皮书V2.0PDF：https://docs.qq.com/doc/DZVVkRGRUd3pHSnFG

南北双向高工技能基础：https://docs.qq.com/doc/DZVVBYlhuRkZQZlB3

应用开发中高级就业技术：https://docs.qq.com/doc/DZVVBYlhuRkZQZlB3

全网首发-工业级 南向设备开发就业技术：https://docs.qq.com/doc/DZVVBYlhuRkZQZlB3

《鸿蒙开发学习手册》：

如何快速入门：https://docs.qq.com/doc/DZVVBYlhuRkZQZlB3

1.基本概念
2.构建第一个ArkTS应用
3.……

开发基础知识：https://docs.qq.com/doc/DZVVBYlhuRkZQZlB3

1.应用基础知识
2.配置文件
3.应用数据管理
4.应用安全管理
5.应用隐私保护
6.三方应用调用管控机制
7.资源分类与访问
8.学习ArkTS语言
9.……

基于ArkTS 开发：https://docs.qq.com/doc/DZVVBYlhuRkZQZlB3

1.Ability开发
2.UI开发
3.公共事件与通知
4.窗口管理
5.媒体
6.安全
7.网络与链接
8.电话服务
9.数据管理
10.后台任务(Background Task)管理
11.设备管理
12.设备使用信息统计
13.DFX
14.国际化开发
15.折叠屏系列
16.……