• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# 应用接入数据备份恢复
2<!--Kit: Core File Kit-->
3<!--Subsystem: FileManagement-->
4<!--Owner: @lvzhenjie-->
5<!--Designer: @wang_zhangjun; @chenxi0605-->
6<!--Tester: @liuhonggang123-->
7<!--Adviser: @foryourself-->
8
9应用接入数据备份恢复需要通过BackupExtensionAbility实现。
10
11BackupExtensionAbility，是[Stage模型](../application-models/stage-model-development-overview.md)中扩展组件[ExtensionAbility](../application-models/extensionability-overview.md)的派生类。开发者可以通过修改配置文件定制备份恢复框架的行为，包括是否允许备份恢复，备份哪些文件等。
12
13## 接口说明
14
15备份恢复扩展能力关键接口如下表所示。API的接口使用指导请参见[BackupExtensionAbility API参考](../reference/apis-core-file-kit/js-apis-application-backupExtensionAbility.md#backupextensionability)和[BackupExtensionContext API参考](../reference/apis-core-file-kit/js-apis-file-backupextensioncontext.md)。
16
17| 接口名                                                       | 描述             |
18| ------------------------------------------------------------ | ---------------- |
19| onBackup(): void | 数据备份准备阶段，迁移备份数据前回调。 |
20| onBackupEx(backupInfo: string): string \| Promise&lt;string&gt; | 数据备份准备阶段，迁移备份数据前回调，支持传递备份信息和返回备份结果。     |
21| onRestore(bundleVersion: BundleVersion): void | 数据恢复阶段，备份数据迁移完成后回调。 |
22| onRestoreEx(bundleVersion: BundleVersion, restoreInfo: string): string \| Promise&lt;string&gt; | 数据恢复阶段，备份数据迁移完成后回调，支持传递恢复信息和返回恢复结果。 |
23| onRelease(scenario: number): Promise&lt;void&gt; | 备份或恢复完成时的特殊处理，备份或恢复完成时回调。<br>**说明**：从API version 20开始支持该接口。 |
24
25## 约束与限制
26
27- 当备份恢复时，所有待备份文件及目录的路径不得超过4095字节，否则将导致未定义行为。
28- 当备份目录时，应用进程必须拥有读取该目录及其所有子目录的权限（DAC中的`r`），否则将导致备份失败。
29- 当备份文件时，应用进程必须拥有搜索该文件所有祖父级目录的权限（DAC中的`x`），否则将导致备份失败。
30- 当备份恢复时，所有待备份恢复的文件及目录不支持相对路径(../)和软链接。
31
32## 开发步骤
33
341. 在应用配置文件`module.json5`中注册`extensionAbilities`相关配置
35
36   新增`"extensionAbilities"`字段，其中注册类型`"type"`设置为`"backup"`，元数据信息["metadata"](../reference/apis-ability-kit/js-apis-bundleManager-metadata.md)新增一个`"name"`为`"ohos.  extension. backup"`的条目。
37
38   BackupExtensionAbility配置文件示例：
39
40   ```json
41   {
42       "extensionAbilities": [
43           {
44               "description": "$string:ServiceExtAbility",
45               "icon": "$media:icon",
46               "name": "BackupExtensionAbility",
47               "type": "backup",
48               "exported": false,
49               "metadata": [
50                   {
51                       "name": "ohos.extension.backup",
52                       "resource": "$profile:backup_config"
53                   }
54               ],
55               // 在BackupExtension.ets文件里自定义继承BackupExtensionAbility，重写其中的onBackup/onBackupEx和
56               // onRestore/onRestoreEx方法，推荐使用onBackupEx/onRestoreEx。
57               // 如果没有特殊要求可以空实现，则备份恢复服务会按照统一的备份恢复数据规则进行备份恢复。
58               "srcEntry": "./ets/BackupExtension/BackupExtension.ets"
59           }
60       ]
61   }
62   ```
63
642. 新增元数据资源配置文件
65
66   在元数据资源配置文件中，定义备份恢复时需要传输的文件。元数据资源配置文件名称需要与`module.json5`中`"metadata.resource"例如"backup_config.json"`名称保持一致，其保存位置在工程的`resources/base/profile`文件夹下。
67
68   元数据资源配置文件示例：
69
70   ```json
71   {
72       "allowToBackupRestore": true,
73       "includes": [
74           "/data/storage/el2/base/files/users/"
75       ],
76       "excludes": [
77           "/data/storage/el2/base/files/users/hidden/"
78       ],
79       "fullBackupOnly": false,
80       "restoreDeps": ""
81   }
82   ```
83
843. 开发者可以在`BackupExtension.ets`文件中自定义类继承的`BackupExtensionAbility`，通过重写其`onBackup/onBackupEx`和`onRestore/onRestoreEx`方法，使其达到在备份预加工应用数据或者在恢复阶段加工待恢复文件。
85
86   如果没有特殊要求可以空实现，则备份恢复服务会按照统一的备份恢复数据规则进行备份恢复。
87
88   下面的示例展示了一个空实现的`BackupExtension.ets`文件：
89
90    ```ts
91    //onBackup && onRestore
92    import { BackupExtensionAbility, BundleVersion } from '@kit.CoreFileKit';
93    import {hilog} from '@kit.PerformanceAnalysisKit';
94
95    const TAG = `FileBackupExtensionAbility`;
96    export default class BackupExtension extends  BackupExtensionAbility {
97      //onBackup
98      async onBackup ()   {
99        hilog.info(0x0000, TAG, `onBackup ok`);
100      }
101      //onRestore
102      async onRestore (bundleVersion : BundleVersion) {
103        hilog.info(0x0000, TAG, `onRestore end`);
104      }
105    }
106    ```
107
108    ```ts
109    //onBackupEx && onRestoreEx
110    import { BackupExtensionAbility, BundleVersion } from '@kit.CoreFileKit';
111
112    interface ErrorInfo {
113      type: string,
114      errorCode: number,
115      errorInfo: string
116    }
117
118    class BackupExt extends BackupExtensionAbility {
119      //onBackupEx
120      async onBackupEx(backupInfo: string): Promise<string> {
121        console.info(`onBackupEx ok`);
122        let errorInfo: ErrorInfo = {
123          type: "ErrorInfo",
124          errorCode: 0,
125          errorInfo: "app diy error info"
126        }
127        return JSON.stringify(errorInfo);
128      }
129
130      // onRestoreEx
131      async onRestoreEx(bundleVersion : BundleVersion, restoreInfo: string): Promise<string> {
132        console.info(`onRestoreEx begin`);
133        let errorInfo: ErrorInfo = {
134          type: "ErrorInfo",
135          errorCode: 0,
136          errorInfo: "app diy error info"
137        }
138        return JSON.stringify(errorInfo);
139      }
140    }
141    ```
142
1434. 从API 20开始，开发者如需在应用备份恢复完成后执行一些特殊操作，例如清理备份或恢复时应用创建的临时文件，可以在`BackupExtension.ets`文件中自定义类继承的`BackupExtensionAbility`，通过重写其`onRelease`方法，当备份或恢复完成时，会执行`onRelease`方法以执行开发者自定义的行为。
144
145   `onRelease`具有超时机制，应用若在5秒内未完成`onRelease`操作，将触发备份恢复结束时的应用进程退出流程。
146
147   下面的示例展示了需要清理临时文件目录时`onRelease`的实现：
148
149    ```ts
150    import { BackupExtensionAbility, fileIo } from '@kit.CoreFileKit';
151
152    const SCENARIO_BACKUP: number = 1;
153    const SCENARIO_RESTORE: number = 2;
154    // 需要清理的临时目录
155    let filePath: string = '/data/storage/el2/base/.temp/';
156
157    class BackupExt extends BackupExtensionAbility {
158      async onRelease(scenario: number): Promise<void> {
159        try {
160          if (scenario == SCENARIO_BACKUP) {
161            // 备份场景，应用自行实现处理，以清理备份产生的临时文件为例
162            console.info(`onRelease begin`);
163            await fileIo.rmdir(filePath);
164            console.info(`onRelease end, rmdir succeed`);
165          }
166          if (scenario == SCENARIO_RESTORE) {
167            // 恢复场景，应用自行实现处理，以清理恢复产生的临时文件为例
168            console.info(`onRelease begin`);
169            await fileIo.rmdir(filePath);
170            console.info(`onRelease end, rmdir succeed`);
171          }
172        } catch (error) {
173          console.error(`onRelease failed with error. Code: ${error.code}, message: ${error.message}`);
174        }
175      }
176    }
177    ```
178
179### 元数据资源配置文件说明
180
181| 属性名称             | 数据类型   | 必填 | 含义                                                         |
182| -------------------- | ---------- | ---- | ------------------------------------------------------------ |
183| allowToBackupRestore | 布尔值     | 是   | 是否允许备份恢复，默认为false。true为允许备份恢复，false为不允许备份恢复。                              |
184| includes             | 字符串数组 | 否   | 应用沙箱中需要备份的文件和目录。<br>当模式串以非/开始时，表示一个相对于根路径的相对路径。<br>`includes`支持的路径清单列表如下述代码段内容所示，当配置`includes`时请确保配置路径范围包含在其中。<br>当`includes`已配置时，备份恢复框架会采用开发者配置的模式串，否则将会采用下述代码段内容作为默认值。 |
185| excludes             | 字符串数组 | 否   | `includes`中无需备份的例外项。格式同`includes`。<br>在配置`excludes`时，请确保其范围在`includes`的子集中。<br>当`excludes`已配置时，备份恢复框架会采用开发者配置的模式串，否则将会采用**空数组**作为默认值。 |
186| fullBackupOnly       | 布尔值     | 否   | 是否使用应用默认恢复目录，默认值为false。当值为true时，恢复数据时会通过临时路径进行缓存，临时路径可通过[backupDir](../reference/apis-core-file-kit/js-apis-file-backupextensioncontext.md#属性)获取。当值为false或者不配置该字段时，恢复数据会以'/'为根目录解压数据。 |
187| restoreDeps          | 字符串     | 否   | **不推荐使用**，应用恢复时依赖其他应用数据，默认值为""，需要配置依赖应用名称。当前仅支持最多一个依赖项。配置的依赖仅在一次恢复任务上下文生效，如果一次恢复任务中没有检测到依赖应用，则忽略该依赖描述继续执行恢复任务。**依赖应用未恢复或者恢复失败都会导致本应用恢复失败**。 |
188| extraInfo            | json串     | 否   | 额外信息可通过该字段传递。                                   |
189
190> **说明：**
191>
192> 1、**有关fullBackupOnly字段的说明**
193>
194> - 当fullBackupOnly为false时，恢复数据会以 **/** 为根目录解压数据，同路径下的同名文件会被覆盖。
195> - 当fullBackupOnly为true时，恢复数据会以临时目录为根目录解压数据，开发者需要在OnRestore/OnRestoreEx内自行实现恢复数据的逻辑，进行最终的恢复。
196>
197> 开发者可根据自身的业务场景，选择对应的恢复数据方式。
198>
199> 示例：
200> 假设应用的数据备份路径为：**data/storage/el2/base/files/A/** 。那么在恢复时，如果配置了fullBackupOnly为false，数据会被直接解压到：**/data/storage/el2/base/files/A/** 目录下；如果配置了fullBackupOnly为true，数据则会被解压到：**临时路径[backupDir](../reference/apis-core-file-kit/js-apis-file-backupextensioncontext.md) + /restore/data/storage/el2/base/files/A/** 目录下。
201
202**includes支持的路径清单列表如下：**
203
204```json
205{
206    "includes": [
207    "data/storage/el1/database/",
208    "data/storage/el1/base/files/",
209    "data/storage/el1/base/preferences/",
210    "data/storage/el1/base/haps/*/files/",
211    "data/storage/el1/base/haps/*/preferences/",
212    "data/storage/el2/database/",
213    "data/storage/el2/base/files/",
214    "data/storage/el2/base/preferences/",
215    "data/storage/el2/base/haps/*/files/",
216    "data/storage/el2/base/haps/*/preferences/",
217    "data/storage/el2/distributedfiles/",
218    "data/storage/el5/database/",
219    "data/storage/el5/base/files/",
220    "data/storage/el5/base/preferences/",
221    "data/storage/el5/base/haps/*/files/",
222    "data/storage/el5/base/haps/*/preferences/"
223    ]
224}
225```
226
227## 相关实例
228
229针对应用接入数据的备份与恢复，有以下相关实例可供参考：
230
231- [应用接入数据备份恢复（ArkTS）（Full SDK）（API10）](https://gitcode.com/openharmony/applications_app_samples/tree/master/code/BasicFeature/FileManagement/FileBackupExtension)
232