鸿蒙开发实践案例分析——PageAbility组件创建/启动/停止本地PageAbility，及启动远程PageAbility

于 2025-06-06 15:39:05 发布
阅读量735 收藏 16
点赞数 27
分类专栏： HarmonyOS 移动开发 鸿蒙开发 文章标签： harmonyos OpenHarmony 鸿蒙开发 移动开发 ArkUI ArkTS 组件化
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/2501_91726491/article/details/148476267
版权

📝往期推文全新看点（文中附带最新·鸿蒙全栈学习笔记）

1️⃣ 鸿蒙应用开发与鸿蒙系统开发哪个更有前景？

2️⃣ 嵌入式开发适不适合做鸿蒙南向开发？看完这篇你就了解了~

3️⃣ 对于大前端开发来说，转鸿蒙开发究竟是福还是祸？

4️⃣ 鸿蒙岗位需求突增！移动端、PC端、IoT到底该怎么选？

5️⃣ 记录一场鸿蒙开发岗位面试经历~

6️⃣ 持续更新中……

开发者需要重写app.js/app.ets中的生命周期回调函数，开发者通过DevEco Studio开发平台创建PageAbility时，DevEco Studio会在app.js/app.ets中默认生成onCreate()和onDestroy()方法，其他方法需要开发者自行实现。接口说明参见前述章节，创建PageAbility示例如下：

import featureAbility from '@ohos.ability.featureAbility';
import Logger from '../utils/Logger';

const TAG: string = 'MainAbility';

class MainAbility {
  onCreate() {
    // 获取context并调用相关方法
    let context = featureAbility.getContext();
    context.getBundleName((data, bundleName) => {
      Logger.info(TAG, 'ability bundleName:' + bundleName);
    });
    Logger.info(TAG, 'Application onCreate');
  }

  onDestroy() {
    Logger.info(TAG, 'Application onDestroy');
  }

  onShow(): void {
    Logger.info(TAG, 'Application onShow');
  }

  onHide(): void {
    Logger.info(TAG, 'Application onHide');
  }

  onActive(): void {
    Logger.info(TAG, 'Application onActive');
  }

  onInactive(): void {
    Logger.info(TAG, 'Application onInactive');
  }

  onNewWant() {
    Logger.info(TAG, 'Application onNewWant');
  }
}

export default new MainAbility();

PageAbility创建成功后，其abilities相关的配置项在config.json中体现，一个名字为EntryAbility的config.json配置文件示例如下：

{
  ...
  "module": {
    ...
    "abilities": [
      {
        "skills": [
          {
            "entities": [
              "entity.system.home"
            ],
            "actions": [
              "action.system.home"
            ]
          }
        ],
        "orientation": "unspecified",
        "formsEnabled": false,
        "name": ".MainAbility",
        "srcLanguage": "ets",
        "srcPath": "MainAbility",
        "icon": "$media:icon",
        "description": "$string:MainAbility_desc",
        "label": "$string:MainAbility_label",
        "type": "page",
        "visible": true,
        "launchType": "singleton"
      },
      ...
    ]
    ...
  }
}

FA模型中，可以通过featureAbility的getContext接口获取应用上下文，进而使用上下文提供的能力。

表1 featureAbility接口说明

通过getContext获取应用上下文并获取分布式目录的示例如下：

import featureAbility from '@ohos.ability.featureAbility';
import fs from '@ohos.file.fs';
import promptAction from '@ohos.promptAction';
import Logger from '../../utils/Logger';

const TAG: string = 'PagePageAbilityFirst';

(async (): Promise<void> => {
  let dir: string;
  try {
    Logger.info(TAG, 'Begin to getOrCreateDistributedDir');
    dir = await featureAbility.getContext().getOrCreateDistributedDir();
    promptAction.showToast({
      message: dir
    });
    Logger.info(TAG, 'distribute dir is ' + dir);
    let fd: number;
    let path = dir + '/a.txt';
    fd = fs.openSync(path, fs.OpenMode.READ_WRITE).fd;
    fs.close(fd);
  } catch (error) {
    Logger.error(TAG, `getOrCreateDistributedDir failed with : ${error}`);
  }
})()

启动本地PageAbility

PageAbility相关的能力通过featureAbility提供，启动本地Ability通过featureAbility中的startAbility接口实现。

表1 featureAbility接口说明

接口名接口描述
startAbility(parameter: StartAbilityParameter)启动Ability。
startAbilityForResult(parameter: StartAbilityParameter)启动Ability，并在该Ability被销毁时返回执行结果。

如下示例通过startAbility显式启动PageAbility。启动Ability的参数包含want，关于want的说明详见 对象间信息传递载体Want ，相应的，隐式启动与显式启动也不在此赘述。

import featureAbility from '@ohos.ability.featureAbility'
import Want from '@ohos.app.ability.Want';
import Logger from '../../utils/Logger';

const TAG: string = 'PagePageAbilityFirst';

(async (): Promise<void> => {
  try {
    Logger.info(TAG, 'Begin to start ability');
    let want: Want = {
      bundleName: 'com.samples.famodelabilitydevelop',
      moduleName: 'entry',
      abilityName: 'com.samples.famodelabilitydevelop.PageAbilitySingleton'
    };
    await featureAbility.startAbility({ want: want });
    Logger.info(TAG, `Start ability succeed`);
  }
  catch (error) {
    Logger.error(TAG, 'Start ability failed with ' + error);
  }
})()

停止PageAbility

停止PageAbility通过featureAbility中的terminateSelf接口实现。

表1 featureAbility接口说明

如下示例展示了停止Ability的方法。

import featureAbility from '@ohos.ability.featureAbility';
import Logger from '../../utils/Logger';

const TAG: string = 'PagePageAbilityFirst';

(async (): Promise<void> => {
  try {
    Logger.info(TAG, 'Begin to terminateSelf');
    await featureAbility.terminateSelf();
    Logger.info(TAG, 'terminateSelf succeed');
  } catch (error) {
    Logger.error(TAG, 'terminateSelf failed with ' + error);
  }
})()

启动远程PageAbility同样通过featureAbility中的startAbility接口实现。

除引入’@ohos.ability.featureAbility’外，还需引入’@ohos.distributedHardware.deviceManager’，通过DeviceManager（该组件提供帐号无关的分布式设备的认证组网能力）的getTrustedDeviceListSync接口（获取信任设备列表）获取远端的deviceId，写入want中，用于启动远程PageAbility。

由于当前DeviceManager的getTrustedDeviceListSync接口仅对系统应用开放，故现阶段非系统应用无法获取其他设备信息，无远程启动设备选择入口，远程启动Ability开发。

表1 featureAbility接口说明

接口名接口描述
startAbility(parameter: StartAbilityParameter)启动Ability。
startAbilityForResult(parameter: StartAbilityParameter)启动Ability，并在该Ability被销毁时返回执行结果。

表2 deviceManager接口说明

接口名接口描述
getTrustedDeviceListSync(): Array同步获取所有可信设备列表。

在跨设备场景下，启动远程PageAbility首先需要向用户申请数据同步的权限，相关接口说明如下：

表3 AtManager接口说明

接口名接口描述
checkAccessToken(tokenID: number, permissionName: string)
: Promise校验应用是否授予权限。使用Promise异步回调。返回值GrantStatus。建议使用checkAccessToken代替verifyAccessToken（已废弃），verifyAccessToken从API version 9开始不再维护。

表4 context接口说明


trequestpermissionsfromuser7-1)。 |

如下示例代码展示了向用户申请数据同步权限的方法：

import abilityAccessCtrl from "@ohos.abilityAccessCtrl";
import featureAbility from '@ohos.ability.featureAbility';
import bundle from '@ohos.bundle.bundleManager';
import Logger from '../../utils/Logger';

const TAG: string = 'PagePageAbilitySecond';

async requestPermission(): Promise<void> {
  Logger.info(TAG, 'RequestPermission begin');
  let array: Array<string> = ['ohos.permission.DISTRIBUTED_DATASYNC'];
  let bundleFlag = 0;
  let tokenID: number | undefined = undefined;
  let userID = 100;
  let appInfo = await bundle.getApplicationInfo('com.samples.famodelabilitydevelop', bundleFlag, userID);
  tokenID = appInfo.accessTokenId;
  let atManager = abilityAccessCtrl.createAtManager();
  let requestPermissions: Array<string> = [];
  for (let i = 0;i < array.length; i++) {
    let result = await atManager.verifyAccessToken(tokenID, array[i]);
    Logger.info(TAG, 'checkAccessToken result:' + JSON.stringify(result));
    if (result != abilityAccessCtrl.GrantStatus.PERMISSION_GRANTED) {
      requestPermissions.push(array[i]);
    }
  }
  Logger.info(TAG, 'requestPermissions:' + JSON.stringify(requestPermissions));
  if (requestPermissions.length == 0) {
    return;
  }
  let context = featureAbility.getContext();
  context.requestPermissionsFromUser(requestPermissions, 1, (error, data) => {
    Logger.info(TAG, 'error:' + error.message + ',data:' + JSON.stringify(data));
    Logger.info(TAG, 'data requestCode:' + data.requestCode);
    Logger.info(TAG, 'data permissions:' + data.permissions);
    Logger.info(TAG, 'data authResults:' + data.authResults);
  });
  Logger.info(TAG, 'RequestPermission end');
}

在获取数据同步权限后，需要获取可信设备列表，进行设备选择。

如下示例展示了通过getAvailableDeviceListSync获取可信设备列表，选择设备的方法。

import deviceManager from '@ohos.distributedDeviceManager';
import promptAction from '@ohos.promptAction';
import Logger from '../../utils/Logger';

const TAG: string = 'PagePageAbilitySecond';

@State deviceID: string = '';

getRemoteDeviceId(): void {
  let dmClass: deviceManager.DeviceManager;
  dmClass = deviceManager.createDeviceManager('com.samples.famodelabilitydevelop');
  try {
    if (typeof dmClass === 'object' && dmClass !== null) {
      let list = dmClass.getAvailableDeviceListSync();
      if (typeof (list) == undefined || list.length == 0) {
        Logger.info(TAG, 'EntryAbility onButtonClick getRemoteDeviceId err: list is null');
        return;
      }
      Logger.info(TAG, `EntryAbility onButtonClick getRemoteDeviceId success[${list.length}]:` + JSON.stringify(list[0]));
      if (list[0].networkId != undefined) {
        this.deviceID = list[0].networkId;
      }
      promptAction.showToast({
        message: this.deviceID
      });
    } else {
      Logger.info(TAG, 'EntryAbility onButtonClick getRemoteDeviceId err: dmClass is null');
    }
  } catch (error) {
    Logger.info(TAG, `getRemoteDeviceId error, error=${error}, message=${error.message}`);
  }
}

设备选择完成后，通过调用startAbility接口，显式启动远程PageAbility。

如下示例展示了通过startAbility显式启动远程PageAbility的方法。

import featureAbility from '@ohos.ability.featureAbility';
import Want from '@ohos.app.ability.Want';
import promptAction from '@ohos.promptAction';
import { BusinessError } from '@ohos.base';
import Logger from '../../utils/Logger';

const TAG: string = 'PagePageAbilitySecond';;

@State deviceID: string = '';

onStartRemoteAbility(): void {
  Logger.info(TAG, 'onStartRemoteAbility begin');
  let wantValue: Want = {
    bundleName: 'ohos.samples.distributedmusicplayer',
    abilityName: 'ohos.samples.distributedmusicplayer.MainAbility',
    deviceId: this.deviceID, // this.deviceID的获取方式在前面的示例代码中
  };
  Logger.info(TAG, 'onStartRemoteAbility want=' + JSON.stringify(wantValue));
  featureAbility.startAbility({
    want: wantValue
  }).then((data) => {
    promptAction.showToast({
      message: $r('app.string.start_remote_success_toast')
    });
    Logger.info(TAG, 'onStartRemoteAbility finished, ' + JSON.stringify(data));
  }).catch((error: BusinessError) => {
    promptAction.showToast({
      message: JSON.stringify(error)
    });
    Logger.error(TAG, 'onStartRemoteAbility failed: ' + JSON.stringify(error));
  });
  Logger.info(TAG, 'onStartRemoteAbility end');
}

写在最后

  • 如果你觉得这篇内容对你还蛮有帮助，我想邀请你帮我三个小忙：
  • 点赞，转发，有你们的 『点赞和评论』，才是我创造的动力。
  • 关注小编，同时可以期待后续文章ing🚀，不定期分享原创知识。
  • 想要获取更多完整鸿蒙最新学习知识点，请移步前往小编：https://gitee.com/MNxiaona/733GH/blob/master/jianshu

评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值