应用接入数据备份恢复需要通过配置BackupExtensionAbility实现。
BackupExtensionAbility,是 Stage模型 中扩展组件 ExtensionAbility 的派生类。开发者可以通过修改配置文件定制备份恢复框架的行为,包括是否允许备份恢复,备份哪些文件等。
本sample主要给备份流程提供应用,用于生成数据和显示数据。
使用说明:
entry/src/main/ets/
|---Application
|---Common
| |---Logger.ts // 日志工具
|---MainAbility
| |---EntryAbility.ts // Ability类
|---fileFs
| |---CreateFile.ts // 创建文件
|---pages
| |---Index.ets // 首页
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"
}
],
"srcEntrance": "./ets/common/BackupExtension.ts",
}
]
}
在元数据资源配置文件中,定义备份恢复时需要传输的文件。元数据资源配置文件名称需要与module.json5
中 "metadata.resource"
名称保持一致,其保存位置在Profile文件夹下。
元数据资源配置文件示例:
{
"allowToBackupRestore": true,
"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/"
],
"excludes": [
"/data/storage/el2/base/files/users/"
]
}
其中includes里面的文件夹是用户需要备份数据的路径,excludes为用户在includes内所需要排除的备份数据目录。includes配置内中<module-name>是应用子Hap名称。
点击界面的“生成文件数据”按钮,会使用以下代码生成文件,并在onPageShow中获取文件名列表和文件大小列表,然后显示在界面上。
async createTestFiles(): Promise<void> {
try {
let num = Math.floor(Math.random() * FILE_NUM_MAX) + FILE_NUM_MIN;
if (!fs.accessSync(this.baseDir)) {
fs.mkdirSync(this.baseDir);
}
let dpath = this.baseDir;
Logger.info(TAG, 'sanBoxFileDir = ' + dpath);
Logger.info(TAG, 'num is = ' + num);
for (let i = 0; i < num; i++) {
let myFile = dpath + `/TestFile_${i}.txt`;
Logger.info(TAG, 'readyFile myFile = ' + myFile);
let file = fs.openSync(myFile, fs.OpenMode.CREATE | fs.OpenMode.READ_WRITE);
fs.writeSync(file.fd, new ArrayBuffer(ONE_KILOBYTE * Math.random()));
fs.closeSync(file);
}
} catch (e) {
Logger.error(TAG, 'Failed to prepare media files, error:' + e.message + e.code);
}
}
由于目前备份与恢复尚未提供具体的应用接口,所以备份与功能仅提供命令行方式进行检验:
应用备份
backup_tool backup --isLocal=true --bundle com.sample.backupextension --pathCapFile /data/backup/tmp
备份成功提示:
BundleStarted errCode = 0, BundleName = com.example.backupextension
FileReady owner = com.example.backupextension, fileName = manage.json, sn = 0, fd = 9
FileReady owner = com.example.backupextension, fileName = part.0.tar, sn = 0, fd = 9
BundleFinished errCode = 0, BundleName = com.example.backupextension
backup successful
应用恢复
backup_tool restore --bundle com.sample.backupextension --pathCapFile /data/backup/tmp
恢复成功提示:
BundleStarted errCode = 0, BundleName = com.example.backupextension
FileReady owner = com.example.backupextension, fileName = part.0.tar, sn = 0, fd = 8
FileReady owner = com.example.backupextension, fileName = manage.json, sn = 0, fd = 8
BundleFinished errCode = 0, BundleName = com.example.backupextension
Restore successful
backup详细说明可以使用backup -help查看。
不涉及。
1.本示例仅支持标准系统上运行,支持设备:RK3568。
2.本示例为Stage模型,支持API11版本SDK,SDK版本号(API Version 11 Beta1),镜像版本号(4.1 Beta1)
3.本示例需要使用DevEco Studio 版本号(4.0 Release)及以上版本才可编译运行。
4.本示例所配置的权限ohos.permission.GET_BUNDLE_INFO_PRIVILEGED为system_basic级别(相关权限级别可通过 权限定义列表 查看),需要手动配置对应级别的权限签名(具体操作可查看 自动化签名方案 ) 。
如需单独下载本工程,执行如下命令:
git init
git config core.sparsecheckout true
echo code/BasicFeature/FileManagement/FileBackupExtension > .git/info/sparse-checkout
git remote add origin https://gitee.com/openharmony/applications_app_samples.git
git pull origin master
如果你觉得这篇内容对你还蛮有帮助,我想邀请你帮我三个小忙:
原创声明:本文系作者授权腾讯云开发者社区发表,未经许可,不得转载。
如有侵权,请联系 cloudcommunity@tencent.com 删除。
原创声明:本文系作者授权腾讯云开发者社区发表,未经许可,不得转载。
如有侵权,请联系 cloudcommunity@tencent.com 删除。