文档管理中心
您当前浏览的HarmonyOS 5.0.0(API 12)文档归档不再维护,推荐您使用最新版本。详细请参考文档维护策略变更

UIAbility组件基本用法

UIAbility组件的基本用法包括:指定UIAbility的启动页面以及获取UIAbility的上下文UIAbilityContext

指定UIAbility的启动页面

应用中的UIAbility在启动过程中,需要指定启动页面,否则应用启动后会因为没有默认加载页面而导致白屏。可以在UIAbility的onWindowStageCreate()生命周期回调中,通过WindowStage对象的loadContent()方法设置启动页面。

收起
自动换行
深色代码主题
复制
  1. import { UIAbility } from '@kit.AbilityKit';
  2. import { window } from '@kit.ArkUI';
  3. export default class EntryAbility extends UIAbility {
  4. onWindowStageCreate(windowStage: window.WindowStage): void {
  5. // Main window is created, set main page for this ability
  6. windowStage.loadContent('pages/Index', (err, data) => {
  7. // ...
  8. });
  9. }
  10. // ...
  11. }
说明

在DevEco Studio中创建的UIAbility中,该UIAbility实例默认会加载Index页面,根据需要将Index页面路径替换为需要的页面路径即可。

获取UIAbility的上下文信息

UIAbility类拥有自身的上下文信息,该信息为UIAbilityContext类的实例,UIAbilityContext类拥有abilityInfo、currentHapModuleInfo等属性。通过UIAbilityContext可以获取UIAbility的相关配置信息,如包代码路径、Bundle名称、Ability名称和应用程序需要的环境状态等属性信息,以及可以获取操作UIAbility实例的方法(如startAbility()connectServiceExtensionAbility()terminateSelf()等)。

如果需要在页面中获得当前Ability的Context,可调用getContext接口获取当前页面关联的UIAbilityContext或ExtensionContext

  • 在UIAbility中可以通过this.context获取UIAbility实例的上下文信息。

    收起
    自动换行
    深色代码主题
    复制
    1. import { UIAbility, AbilityConstant, Want } from '@kit.AbilityKit';
    2. export default class EntryAbility extends UIAbility {
    3. onCreate(want: Want, launchParam: AbilityConstant.LaunchParam): void {
    4. // 获取UIAbility实例的上下文
    5. let context = this.context;
    6. // ...
    7. }
    8. }
  • 在页面中获取UIAbility实例的上下文信息,包括导入依赖资源context模块和在组件中定义一个context变量两个部分。

    收起
    自动换行
    深色代码主题
    复制
    1. import { common, Want } from '@kit.AbilityKit';
    2. @Entry
    3. @Component
    4. struct Page_EventHub {
    5. private context = getContext(this) as common.UIAbilityContext;
    6. startAbilityTest(): void {
    7. let want: Want = {
    8. // Want参数信息
    9. };
    10. this.context.startAbility(want);
    11. }
    12. // 页面展示
    13. build() {
    14. // ...
    15. }
    16. }

    也可以在导入依赖资源context模块后,在具体使用UIAbilityContext前进行变量定义。

    收起
    自动换行
    深色代码主题
    复制
    1. import { common, Want } from '@kit.AbilityKit';
    2. @Entry
    3. @Component
    4. struct Page_UIAbilityComponentsBasicUsage {
    5. startAbilityTest(): void {
    6. let context = getContext(this) as common.UIAbilityContext;
    7. let want: Want = {
    8. // Want参数信息
    9. };
    10. context.startAbility(want);
    11. }
    12. // 页面展示
    13. build() {
    14. // ...
    15. }
    16. }
  • 当业务完成后,开发者如果想要终止当前UIAbility实例,可以通过调用terminateSelf()方法实现。

    收起
    自动换行
    深色代码主题
    复制
    1. import { common } from '@kit.AbilityKit';
    2. import { BusinessError } from '@kit.BasicServicesKit';
    3. @Entry
    4. @Component
    5. struct Page_UIAbilityComponentsBasicUsage {
    6. // 页面展示
    7. build() {
    8. Column() {
    9. //...
    10. Button('FuncAbilityB')
    11. .onClick(() => {
    12. let context = getContext(this) as common.UIAbilityContext;
    13. try {
    14. context.terminateSelf((err: BusinessError) => {
    15. if (err.code) {
    16. // 处理业务逻辑错误
    17. console.error(`terminateSelf failed, code is ${err.code}, message is ${err.message}`);
    18. return;
    19. }
    20. // 执行正常业务
    21. console.info('terminateSelf succeed');
    22. });
    23. } catch (err) {
    24. // 捕获同步的参数错误
    25. let code = (err as BusinessError).code;
    26. let message = (err as BusinessError).message;
    27. console.error(`terminateSelf failed, code is ${code}, message is ${message}`);
    28. }
    29. })
    30. }
    31. }
    32. }
在 指南 中进行搜索
请输入您想要搜索的关键词