HarmonyOS 应用开发之跨端迁移保姆级教程~(2)，限时发布

最新推荐文章于 2024-06-13 16:45:49 发布

2301_77116622

最新推荐文章于 2024-06-13 16:45:49 发布

阅读量927

点赞数 11

分类专栏： 2024年程序员学习文章标签： harmonyos 华为

本文链接：https://blog.csdn.net/2301_77116622/article/details/137567968

版权

2024年程序员学习专栏收录该内容

270 篇文章 0 订阅

订阅专栏

在某个组件的触发事件中设置应用迁移能力。

// Page_MigrationAbilityFirst.ets
import AbilityConstant from ‘@ohos.app.ability.AbilityConstant’;
import common from ‘@ohos.app.ability.common’;
import hilog from ‘@ohos.hilog’;
import promptAction from ‘@ohos.promptAction’;

const TAG: string = ‘[MigrationAbility]’;
const DOMAIN_NUMBER: number = 0xFF00;

@Entry
@Component
struct Page_MigrationAbilityFirst {
private context = getContext(this) as common.UIAbilityContext;
build() {
// …
Button() {
// …
}
.onClick(()=>{
// 点击该按钮时，将应用设置为可迁移状态
this.context.setMissionContinueState(AbilityConstant.ContinueState.ACTIVE, (result) => {
hilog.info(DOMAIN_NUMBER, TAG, ‘%{public}s’, setMissionContinueState ACTIVE result: ${JSON.stringify(result)});
});
})
}
}

保证迁移连续性

由于迁移加载时，对端拉起的应用可能执行过自己的迁移状态设置命令（例如，冷启动时对端在 onCreate() 中设置了 INACTIVE ；热启动时对端已打开了不可迁移的页面，迁移状态为 INACTIVE 等情况）。为了保证迁移过后的应用依然具有可以迁移回源端的能力，应在 onCreate() / onNewWant() 的迁移调用判断中，将迁移状态设置为 ACTIVE 。

// MigrationAbility.ets
import AbilityConstant from ‘@ohos.app.ability.AbilityConstant’;
import hilog from ‘@ohos.hilog’;
import UIAbility from ‘@ohos.app.ability.UIAbility’;
import type Want from ‘@ohos.app.ability.Want’;

const TAG: string = ‘[MigrationAbility]’;
const DOMAIN_NUMBER: number = 0xFF00;

export default class MigrationAbility extends UIAbility {
// …
onCreate(want: Want, launchParam: AbilityConstant.LaunchParam): void {
// …
// 调用原因为迁移时，设置状态为可迁移，应对冷启动情况
if (launchParam.launchReason == AbilityConstant.LaunchReason.CONTINUATION) {
this.context.setMissionContinueState(AbilityConstant.ContinueState.ACTIVE, (result) => {
hilog.info(setMissionContinueState ACTIVE result: ${JSON.stringify(result)});
});
}
}

onNewWant(want: Want, launchParam: AbilityConstant.LaunchParam): void {
// …
// 调用原因为迁移时，设置状态为可迁移，应对热启动情况
if (launchParam.launchReason == AbilityConstant.LaunchReason.CONTINUATION) {
this.context.setMissionContinueState(AbilityConstant.ContinueState.ACTIVE, (result) => {
hilog.info(DOMAIN_NUMBER, TAG, setMissionContinueState ACTIVE result: ${JSON.stringify(result)});
});
}
}
// …
}

按需迁移页面栈

支持应用动态选择是否进行页面栈恢复（默认进行页面栈信息恢复）。如果应用不想使用系统默认恢复的页面栈，则可以设置不进行页面栈迁移，而需要在onWindowStageRestore()设置迁移后进入的页面，参数定义见 SUPPORT_CONTINUE_PAGE_STACK_KEY 。

应用在源端的页面栈中存在Index和Second路由，而在对端恢复时不需要按照源端页面栈进行恢复，需要恢复到指定页面。

例如，UIAbility迁移不需要自动迁移页面栈信息。

const TAG: string = ‘[MigrationAbility]’;
const DOMAIN_NUMBER: number = 0xFF00;

export default class MigrationAbility extends UIAbility {
// …
onContinue(wantParam: Record<string, Object>):AbilityConstant.OnContinueResult {
hilog.info(DOMAIN_NUMBER, TAG, onContinue version = ${wantParam.version}, targetDevice: ${wantParam.targetDevice});
wantParam[wantConstant.Params.SUPPORT_CONTINUE_PAGE_STACK_KEY] = false;
return AbilityConstant.OnContinueResult.AGREE;
}

onWindowStageRestore(windowStage: window.WindowStage) : void {
// 若不需要自动迁移页面栈信息，则需要在此处设置应用迁移后进入的页面
windowStage.loadContent(‘pages/page_migrationability/Page_MigrationAbilityThird’, (err, data) => {
if (err.code) {
hilog.error(DOMAIN_NUMBER, TAG, ‘Failed to load the content. Cause: %{public}s’, JSON.stringify(err) ?? ‘’);
return;
}
});
}
}

按需退出

支持应用动态选择迁移成功后是否退出迁移源端应用（默认迁移成功后退出迁移源端应用）。如果应用不想让系统自动退出迁移源端应用，则可以设置不退出，参数定义见 SUPPORT_CONTINUE_SOURCE_EXIT_KEY 。

示例：UIAbility设置迁移成功后，源端不需要退出迁移应用。

import AbilityConstant from ‘@ohos.app.ability.AbilityConstant’;
import hilog from ‘@ohos.hilog’;
import UIAbility from ‘@ohos.app.ability.UIAbility’;
import wantConstant from ‘@ohos.app.ability.wantConstant’;

const TAG: string = ‘[MigrationAbility]’;
const DOMAIN_NUMBER: number = 0xFF00;

export default class MigrationAbility extends UIAbility {
// …
onContinue(wantParam: Record<string, Object>):AbilityConstant.OnContinueResult {
hilog.info(DOMAIN_NUMBER, TAG, onContinue version = ${wantParam.version}, targetDevice: ${wantParam.targetDevice});
wantParam[wantConstant.Params.SUPPORT_CONTINUE_SOURCE_EXIT_KEY] = false;
return AbilityConstant.OnContinueResult.AGREE;
}
}

跨端迁移中的数据迁移

当前支持三种不同的数据迁移方式，开发者可以根据实际使用需要进行选择。

说明：
部分ArkUI组件支持通过配置restoreId的方式，在迁移后将特定状态恢复到对端设备。详情请见分布式迁移标识。

如果涉及分布式对象和分布式文件迁移时应注意：

需要申请ohos.permission.DISTRIBUTED_DATASYNC权限，配置方式请参见声明权限。
同时需要在应用首次启动时弹窗向用户申请授权，使用方式请参见向用户申请授权。

使用wantParam迁移数据

在需要迁移的数据较少（100KB以下）时，开发者可以选择在wantParam中增加字段进行数据迁移。示例如下：

import UIAbility from ‘@ohos.app.ability.UIAbility’;
import AbilityConstant from ‘@ohos.app.ability.AbilityConstant’;
import Want from ‘@ohos.app.ability.Want’;

const TAG: string = ‘[MigrationAbility]’;
const DOMAIN_NUMBER: number = 0xFF00;

export default class MigrationAbility extends UIAbility {
// 源端保存
onContinue(wantParam: Record<string, Object>):AbilityConstant.OnContinueResult {
// 将要迁移的数据保存在wantParam的自定义字段（例如data）中
const continueInput = ‘迁移的数据’;
wantParam[‘data’] = continueInput;
return AbilityConstant.OnContinueResult.AGREE;
}

// 对端恢复
onCreate(want: Want, launchParam: AbilityConstant.LaunchParam): void {
if (launchParam.launchReason === AbilityConstant.LaunchReason.CONTINUATION) {
// 将上述保存的数据取出恢复
let continueInput = ‘’;
if (want.parameters !== undefined) {
continueInput = JSON.stringify(want.parameters.data);
hilog.info(DOMAIN_NUMBER, TAG, continue input ${continueInput});
}
// 触发页面恢复
this.context.restoreWindowStage(this.storage);
}
}

onNewWant(want: Want, launchParam: AbilityConstant.LaunchParam): void {
if (launchParam.launchReason == AbilityConstant.LaunchReason.CONTINUATION) {
let continueInput = ‘’;
if (want.parameters !== undefined) {
continueInput = JSON.stringify(want.parameters.data);
hilog.info(DOMAIN_NUMBER, TAG, continue input ${JSON.stringify(continueInput)});
}
// 触发页面恢复
this.context.restoreWindowStage(this.storage);
}
}
}

使用分布式对象迁移数据

当需要迁移的数据较大（100KB以上）时，可以选择分布式对象进行数据迁移。

在源端onContinue()接口中创建一个分布式数据对象 DataObject ，将所要迁移的数据填充到分布式对象数据中，并将生成的sessionId通过want传递到对端。
对端在onCreate()/onNewWant中进行数据恢复时，可以从want中读取该sessionId，通过分布式对象恢复数据。