提交 2de61710 编写于 作者: H huaqingsimeng

backup备份恢复开发者文档相关错误描述调整

Signed-off-by: Nhuaqingsimeng <qiukaiqing@huawei.com>
上级 3fea5e52
...@@ -34,6 +34,7 @@ ...@@ -34,6 +34,7 @@
```js ```js
import fs from '@ohos.file.fs'; import fs from '@ohos.file.fs';
async function getLocalCapabilities() {
try { try {
let fileData = await backup.getLocalCapabilities(); let fileData = await backup.getLocalCapabilities();
console.info('getLocalCapabilities success'); console.info('getLocalCapabilities success');
...@@ -43,6 +44,7 @@ ...@@ -43,6 +44,7 @@
} catch (err) { } catch (err) {
console.error('getLocalCapabilities failed with err: ' + err); console.error('getLocalCapabilities failed with err: ' + err);
} }
}
``` ```
**返回的能力文件内容示例:** **返回的能力文件内容示例:**
...@@ -88,7 +90,9 @@ ...@@ -88,7 +90,9 @@
```ts ```ts
import fs from '@ohos.file.fs'; import fs from '@ohos.file.fs';
// 创建SessionBackup类的实例用于备份数据 // 创建SessionBackup类的实例用于备份数据
let session = new backup.SessionBackup({ let g_session;
function createSessionBackup() {
let sessionBackup = new backup.SessionBackup({
onFileReady: async (err, file) => { onFileReady: async (err, file) => {
if (err) { if (err) {
console.info('onFileReady err: ' + err); console.info('onFileReady err: ' + err);
...@@ -130,13 +134,20 @@ ...@@ -130,13 +134,20 @@
console.info('onBackupServiceDied'); console.info('onBackupServiceDied');
}, },
}); });
return sessionBackup;
}
async function sessionBackup ()
{
g_session = createSessionBackup();
// 此处可根据backup.getLocalCapabilities()提供的能力文件,选择需要备份的应用 // 此处可根据backup.getLocalCapabilities()提供的能力文件,选择需要备份的应用
// 也可直接根据应用包名称进行备份 // 也可直接根据应用包名称进行备份
const backupApps = [ const backupApps = [
"com.example.hiworld", "com.example.hiworld",
] ]
await session.appendBundles(backupApps); await g_session.appendBundles(backupApps);
console.info('appendBundles success'); console.info('appendBundles success');
}
``` ```
## 应用恢复数据 ## 应用恢复数据
...@@ -152,72 +163,79 @@ ...@@ -152,72 +163,79 @@
```ts ```ts
import fs from '@ohos.file.fs'; import fs from '@ohos.file.fs';
// 创建SessionRestore类的实例用于恢复数据 // 创建SessionRestore类的实例用于恢复数据
let session = new backup.SessionRestore({ let g_session;
onFileReady: async (err, file) => { async function publishFile(file)
{
await g_session.publishFile({
bundleName: file.bundleName,
uri: file.uri
});
}
function createSessionRestore() {
let sessionRestore = new backup.SessionRestore({
onFileReady: (err, file) => {
if (err) { if (err) {
console.info('onFileReady err: ' + err); console.info('onFileReady err: ' + err);
} }
try { // 此处开发者请根据实际场景待恢复文件存放位置进行调整 bundlePath
let bundlePath = await globalThis.context.filesDir + '/' + file.bundleName + '/'+ file.uri; let bundlePath;
if (!fs.accessSync(bundlePath)) { if (!fs.accessSync(bundlePath)) {
console.info('onFileReady bundlePath err : ' + bundlePath); console.info('onFileReady bundlePath err : ' + bundlePath);
} }
fs.copyFileSync(bundlePath, file.fd); fs.copyFileSync(bundlePath, file.fd);
fs.closeSync(file.fd); fs.closeSync(file.fd);
// 恢复数据传输完成后,会通知服务端文件准备就绪 // 恢复数据传输完成后,会通知服务端文件准备就绪
await session.publishFile({ publishFile(file);
bundleName: file.bundleName,
uri: file.uri,
});
console.info('onFileReady success'); console.info('onFileReady success');
} catch (e) {
console.error('onFileReady failed with err: ' + e);
}
}, },
onBundleBegin: (err, bundleName) => { onBundleBegin: (err, bundleName) => {
if (err) { if (err) {
console.info('onBundleBegin err: ' + err); console.error('onBundleBegin failed with err: ' + err);
} else {
console.info('onBundleBegin bundleName: ' + bundleName);
} }
console.info('onBundleBegin success');
}, },
onBundleEnd: (err, bundleName) => { onBundleEnd: (err, bundleName) => {
if (err) { if (err) {
console.info('onBundleEnd err: ' + err); console.error('onBundleEnd failed with err: ' + err);
} else {
console.info('onBundleEnd bundleName: ' + bundleName);
} }
console.info('onBundleEnd success');
}, },
onAllBundlesEnd: (err) => { onAllBundlesEnd: (err) => {
if (err) { if (err) {
console.info('onAllBundlesEnd err: ' + err); console.error('onAllBundlesEnd failed with err: ' + err);
} else {
console.info('onAllBundlesEnd');
} }
console.info('onAllBundlesEnd success');
}, },
onBackupServiceDied: () => { onBackupServiceDied: () => {
console.info('onBackupServiceDied'); console.info('service died');
}, }
}); });
return sessionRestore;
}
async function restore ()
{
g_session = createSessionRestore();
const backupApps = [ const backupApps = [
"com.example.hiworld", "com.example.hiworld",
] ]
// 能力文件的获取方式可以根据开发者实际场景进行调整。此处仅为请求示例 // 能力文件的获取方式可以根据开发者实际场景进行调整。此处仅为请求示例
// 开发者也可以根据能力文件内容的结构示例,自行构造能力文件内容 // 开发者也可以根据能力文件内容的结构示例,自行构造能力文件内容
let fileData = await backup.getLocalCapabilities(); let fileData = await backup.getLocalCapabilities();
await session.appendBundles(fileData.fd, backupApps); await g_session.appendBundles(fileData.fd, backupApps);
console.info('appendBundles success'); console.info('appendBundles success');
// 添加需要恢复的应用成功后,请根据需要恢复的应用名称,调用getFileHandle接口获取待恢复应用数文件的文件句柄 // 添加需要恢复的应用成功后,请根据需要恢复的应用名称,调用getFileHandle接口获取待恢复应用数文件的文件句柄
// 应用待恢复数据文件数请依据实际备份文件个数为准,此处仅为请求示例 // 应用待恢复数据文件数请依据实际备份文件个数为准,此处仅为请求示例
await session.getFileHandle({ await g_session.getFileHandle({
bundleName: restoreApps[0], bundleName: restoreApps[0],
uri: "manage.json" uri: "manage.json"
}); });
await session.getFileHandle({ await g_session.getFileHandle({
bundleName: restoreApps[0], bundleName: restoreApps[0],
uri: "1.tar" uri: "1.tar"
}); });
console.info('getFileHandle success'); console.info('getFileHandle success');
}
``` ```
## 应用恢复数据时安装应用 ## 应用恢复数据时安装应用
...@@ -233,18 +251,26 @@ ...@@ -233,18 +251,26 @@
```ts ```ts
import fs from '@ohos.file.fs'; import fs from '@ohos.file.fs';
// 创建SessionRestore类的实例用于恢复数据 // 创建SessionRestore类的实例用于恢复数据
let session = new backup.SessionRestore({ let g_session;
onFileReady: async (err, file) => { async function publishFile(file)
{
await g_session.publishFile({
bundleName: file.bundleName,
uri: file.uri
});
}
function createSessionRestore() {
let sessionRestore = new backup.SessionRestore({
onFileReady: (err, file) => {
if (err) { if (err) {
console.info('onFileReady err: ' + err); console.info('onFileReady err: ' + err);
} }
try {
let bundlePath; let bundlePath;
if( file.uri == "/data/storage/el2/restore/bundle.hap" ) if( file.uri == "/data/storage/el2/restore/bundle.hap" )
{ {
// 此处开发者请根据实际场景安装包的存放位置进行调整 // 此处开发者请根据实际场景安装包的存放位置进行调整
} else { } else {
bundlePath = await globalThis.context.filesDir + '/' + file.bundleName + '/'+ file.uri; // 此处开发者请根据实际场景待恢复文件存放位置进行调整 bundlePath
} }
if (!fs.accessSync(bundlePath)) { if (!fs.accessSync(bundlePath)) {
console.info('onFileReady bundlePath err : ' + bundlePath); console.info('onFileReady bundlePath err : ' + bundlePath);
...@@ -252,40 +278,37 @@ ...@@ -252,40 +278,37 @@
fs.copyFileSync(bundlePath, file.fd); fs.copyFileSync(bundlePath, file.fd);
fs.closeSync(file.fd); fs.closeSync(file.fd);
// 恢复数据传输完成后,会通知服务端文件准备就绪 // 恢复数据传输完成后,会通知服务端文件准备就绪
await session.publishFile({ publishFile(file);
bundleName: file.bundleName,
uri: file.uri,
});
console.info('onFileReady success'); console.info('onFileReady success');
} catch (e) {
console.error('onFileReady failed with err: ' + e);
}
}, },
onBundleBegin: (err, bundleName) => { onBundleBegin: (err, bundleName) => {
if (err) { if (err) {
console.info('onBundleBegin err: ' + err); console.error('onBundleBegin failed with err: ' + err);
} else {
console.info('onBundleBegin bundleName: ' + bundleName);
} }
console.info('onBundleBegin success');
}, },
onBundleEnd: (err, bundleName) => { onBundleEnd: (err, bundleName) => {
if (err) { if (err) {
console.info('onBundleEnd err: ' + err); console.error('onBundleEnd failed with err: ' + err);
} else {
console.info('onBundleEnd bundleName: ' + bundleName);
} }
console.info('onBundleEnd success');
}, },
onAllBundlesEnd: (err) => { onAllBundlesEnd: (err) => {
if (err) { if (err) {
console.info('onAllBundlesEnd err: ' + err); console.error('onAllBundlesEnd failed with err: ' + err);
} else {
console.info('onAllBundlesEnd');
} }
console.info('onAllBundlesEnd success');
}, },
onBackupServiceDied: () => { onBackupServiceDied: () => {
console.info('onBackupServiceDied'); console.info('service died');
}, }
}); });
return sessionRestore;
}
async function restore ()
{
g_session = createSessionRestore();
const backupApps = [ const backupApps = [
"com.example.hiworld", "com.example.hiworld",
] ]
...@@ -296,24 +319,25 @@ ...@@ -296,24 +319,25 @@
"\"versionCode\" : 1000000,\"versionName\" : \"1.0.0\"}],\"deviceType\" : \"default\",\"systemFullName\" : \"OpenHarmony-4.0.6.2(Canary1)\"}"; "\"versionCode\" : 1000000,\"versionName\" : \"1.0.0\"}],\"deviceType\" : \"default\",\"systemFullName\" : \"OpenHarmony-4.0.6.2(Canary1)\"}";
fs.writeSync(file.fd, content); fs.writeSync(file.fd, content);
fs.fsyncSync(file.fd); fs.fsyncSync(file.fd);
await session.appendBundles(file.fd, backupApps); await g_session.appendBundles(file.fd, backupApps);
console.info('appendBundles success'); console.info('appendBundles success');
// 开发者需要请求安装应用的文件句柄 // 开发者需要请求安装应用的文件句柄
await session.getFileHandle({ await g_session.getFileHandle({
bundleName: restoreApps[0], bundleName: restoreApps[0],
uri: "/data/storage/el2/restore/bundle.hap" uri: "/data/storage/el2/restore/bundle.hap"
}); });
await session.getFileHandle({ await g_session.getFileHandle({
bundleName: restoreApps[0], bundleName: restoreApps[0],
uri: "manage.json" uri: "manage.json"
}); });
await session.getFileHandle({ await g_session.getFileHandle({
bundleName: restoreApps[0], bundleName: restoreApps[0],
uri: "1.tar" uri: "1.tar"
}); });
console.info('getFileHandle success'); console.info('getFileHandle success');
}
``` ```
**恢复数据时安装应用所需的能力文件内容示例:** **恢复数据时安装应用所需的能力文件内容示例:**
......
...@@ -63,7 +63,7 @@ onFileReady : AsyncCallback&lt;File&gt; ...@@ -63,7 +63,7 @@ onFileReady : AsyncCallback&lt;File&gt;
> **说明:** > **说明:**
> >
> AsyncCallback回调中返回的File 所属file.backup.[File](#file)类型,返回的文件归备份服务所有,一旦文件关闭,备份服务将选择合适的实际去清理,但客户端必须关闭文件句柄。 > AsyncCallback回调中返回的File 所属file.backup.[File](#file)类型,返回的文件归备份服务所有,一旦文件关闭,备份服务将选择合适的时机去清理,但客户端必须关闭文件句柄。
**系统能力**:SystemCapability.FileManagement.StorageService.Backup **系统能力**:SystemCapability.FileManagement.StorageService.Backup
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册