From 87357c3476ff8a97515d082a58ac662120b06719 Mon Sep 17 00:00:00 2001 From: huaqingsimeng <1004904143@qq.com> Date: Mon, 24 Apr 2023 14:31:24 +0800 Subject: [PATCH] =?UTF-8?q?=E6=9B=B4=E6=96=B0=E5=A4=87=E4=BB=BD=E6=81=A2?= =?UTF-8?q?=E5=A4=8D=E6=9C=8D=E5=8A=A1=E7=9B=B8=E5=85=B3readme?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: huaqingsimeng --- README_ZH.md | 104 +++++++++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 100 insertions(+), 4 deletions(-) diff --git a/README_ZH.md b/README_ZH.md index 9dd07f743..b06f2a025 100644 --- a/README_ZH.md +++ b/README_ZH.md @@ -15,8 +15,8 @@ ## **说明** ### 接口说明 **表1** 应用文件服务接口说明 -| **接口名** | **说明** | -| --- | --- | +| **接口名** | **说明** | +| ------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------- | | createSharePath(fd: number, cid: string, callback: AsyncCallback\): void
createSharePath(fd: number, cid: string): Promise\ | 将文件fd与设备cid传递给分布式文件系统，创建跨设备分享路径 | ### 使用说明 createSharePath接口为分享文件fd创建能够跨设备访问的分布式路径，异步返回创建结果，设备号cid用于指定分享设备。 @@ -34,7 +34,103 @@ remotefileshare.createSharePath(fd, cid).then(function(path) { }); ``` -## **相关仓** +# 备份恢复 + +## **简介** + +备份恢复是为Openharmony设备上三方应用数据、系统应用数据、公共数据和系统服务提供一套完整的数据备份和数据恢复解决方案。主要包括：1.支持三方应用数据、系统应用数据备份能力。2.支持用户数据的备份及恢复能力。3.支持系统服务数据的备份及恢复能力。 + +备份恢复功能主要由三大部分组成： + - 集成在克隆等系统应用中的[JS API](#api接口说明) + - 集成在待备份恢复应用中的[备份服务扩展](#备份服务扩展) + - 具有独立进程的[备份服务](#备份服务) + +## **目录** +``` +/foundation/filemanagement/app_file_service +│── frameworks // 框架层 +| └── native +│ └── backup_ext // 备份服务扩展 +│── interfaces // 接口存放目录 +| ├── api +│ ├── inner_api // 内部接口声明 +│ └── kits +| └── js +| └── backup // js外部接口 +│── services +| └── backup_sa // 备份恢复服务 +│── tests // 测试用例 +│── tools // 备份恢复工具 +└── utils // 工具套 +``` + +## **说明** +### API接口说明 + +**表1** 获取能力文件接口说明 +| **接口名** | **说明** | +| --------------------------------------------------------------------------------------------------------------------------- | ---------------------------------- | +| getLocalCapabilities(callback: AsyncCallback<FileData>): void
getLocalCapabilities(): Promise<FileData> | 用于获取一个描述本地能力的Json文件 | + +**使用说明** +getLocalCapabilities接口为获取一个描述本地能力的Json文件，异步返回获取结果。 + +**示例：** + ```js + import backup from '@ohos.file.backup'; + import fs from '@ohos.file.fs'; + + try { + backup.getLocalCapabilities((err, fileData) => { + if (err) { + console.error('getLocalCapabilities failed with err: ' + err); + } + console.info('getLocalCapabilities success'); + fs.closeSync(fileData.fd); + }); + } catch (err) { + console.error('getLocalCapabilities failed with err: ' + err); + } + + try { + let fileData = await backup.getLocalCapabilities(); + console.info('getLocalCapabilities success'); + fs.closeSync(fileData.fd); + } catch (err) { + console.error('getLocalCapabilities failed with err: ' + err); + } + ``` + +**返回的能力文件内容示例：** + + ```json + { + "bundleInfos" :[{ + "allToBackup" : true, + "extensionName" : "BackupExtensionAbility", + "name" : "com.example.hiworld", + "needToInstall" : false, + "spaceOccupied" : 0, + "versionCode" : 1000000, + "versionName" : "1.0.0" + }], + "deviceType" : "phone", + "systemFullName" : "OpenHarmony-4.0.0.0" + } + ``` + +详细接口说明请参考[API文档](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis/js-apis-file-backup.md) + +### 备份服务扩展 +备份服务扩展是集成在应用中的[服务扩展](https://gitee.com/openharmony/ability_ability_runtime#简介)，负责备份恢复具体应用的数据。应用开发者可通过配置备份恢复策略规则，配置备份恢复场景及过滤隐私等目录。 + +### 备份服务 +备份服务是具有独立进程的系统服务，主要负责调度备份恢复任务。具体而言，其具体职责包括获取及检查备份恢复能力、管理备份服务扩展的生命周期与并发程度、协调零拷贝传输文件、在恢复时可选择安装应用。 + + +# **相关仓** - [Linux内核5.10](https://gitee.com/openharmony/kernel_linux_5.10) -- [文件访问接口](https://gitee.com/zkx48/filemanagement_file_api) \ No newline at end of file +- [文件访问接口](https://gitee.com/openharmony/filemanagement_file_api) +- [元能力子系统](https://gitee.com/openharmony/ability_ability_runtime) +- [系统服务框架](https://gitee.com/openharmony/systemabilitymgr_safwk) \ No newline at end of file -- Gitee