代码拉取完成，页面将自动刷新
应用接入数据备份恢复需要通过配置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": "",
}
]
}
在元数据资源配置文件中，定义备份恢复时需要传输的文件。元数据资源配置文件名称需要与module.json5中 "metadata.resource"名称保持一致，其保存位置在Profile文件夹下。
元数据资源配置文件示例：
{
"allowToBackupRestore": true,
"includes": [
"data/storage/el2/database/",
"data/storage/el2/base/files/",
"data/storage/el2/base/preferences/",
"data/storage/el2/base/haps/*/database/",
"data/storage/el2/base/haps/*/base/files/",
"data/storage/el2/base/haps/*/files/",
"data/storage/el2/base/haps/entry/files/TextDir/",
"data/storage/el2/base/haps/*/base/preferences/",
"/data/storage/el2/base/files/users/*/*.json"
],
"excludes": [
"/data/storage/el2/base/files/users/*/hidden.json"
]
}
其中includes里面的文件夹是用户需要备份数据的路径，excludes为用户不想备份数据的路径。
点击界面的“生成文件数据”按钮，会使用以下代码生成文件，并在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 = 1.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 = 1.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查看。
ohos.permission.GET_BUNDLE_INFO_PRIVILEGED
不涉及。
1.本示例仅支持标准系统上运行。
2.本示例已适配API version 10版本SDK，需要手动替换Full SDK才能编译通过，具体操作可参考替换指南 。
3.本示例需要使用DevEco Studio 3.1.1 Release (Build Version: 3.1.0.501, built on June 20, 2023)及以上版本才可编译运行。
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
此处可能存在不合适展示的内容，页面不予展示。您可通过相关编辑功能自查并修改。
如您确认内容无涉及 不当用语 / 纯广告导流 / 暴力 / 低俗色情 / 侵权 / 盗版 / 虚假 / 无价值内容或违法国家有关法律法规的内容，可点击提交进行申诉，我们将尽快为您处理。
马建仓 AI 助手