鸿蒙UIAbility组件的用法（附带实例）

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

指定UIAbility的启动页面

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

我们可以观察“ArkUIHelloWorld”应用中的 EntryAbility.ets 文件，代码如下：

import { AbilityConstant, UIAbility, Want } from '@kit.AbilityKit';
import { hilog } from '@kit.PerformanceAnalysisKit';
import { window } from '@kit.ArkUI';

export default class EntryAbility extends UIAbility {
    onCreate(want: Want, launchParam: AbilityConstant.LaunchParam): void {
        hilog.info(0x0000, 'testTag', '%{public}s', 'Ability onCreate');
    }

    onDestroy(): void {
        hilog.info(0x0000, 'testTag', '%{public}s', 'Ability onDestroy');
    }

    onWindowStageCreate(windowStage: window.WindowStage): void {
        hilog.info(0x0000, 'testTag', '%{public}s', 'Ability onWindowStageCreate');
        // 通过WindowStage对象的loadContent()方法设置启动页面
        windowStage.loadContent('pages/Index', (err) => {
            if (err.code) {
                hilog.error(0x0000, 'testTag', 'Failed to load the content. Cause: %{public}s', JSON.stringify(err) ?? '');
                return;
            }
            hilog.info(0x0000, 'testTag', 'Succeeded in loading the content.');
        });
    }

    onWindowStageDestroy(): void {
        hilog.info(0x0000, 'testTag', '%{public}s', 'Ability onWindowStageDestroy');
    }

    onForeground(): void {
        hilog.info(0x0000, 'testTag', '%{public}s', 'Ability onForeground');
    }

    onBackground(): void {
        hilog.info(0x0000, 'testTag', '%{public}s', 'Ability onBackground');
    }
}

在上述代码中，可用看到 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 实例的上下文信息：

import { UIAbility, AbilityConstant, Want } from '@kit.AbilityKit';

export default class EntryAbility extends UIAbility {
    onCreate(want: Want, launchParam: AbilityConstant.LaunchParam): void {
        // 获取UIAbility实例的上下文信息
        let context = this.context;
        // ...
    }
}

以下示例是在页面中获取 UIAbility 实例的上下文信息，包括导入依赖资源 context 模块和在组件中定义一个 context 变量两个部分：

import { common, Want } from '@kit.AbilityKit';

@Entry
@Component
struct Page_EventHub {
    private context = getContext(this) as common.UIAbilityContext;

    startAbilityTest(): void {
        let want: Want = {
           // Want参数信息
       };
        this.context.startAbility(want);
    }

    // 页面展示
    build() {
        // ...
    }
}

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

import { common, Want } from '@kit.AbilityKit';

@Entry
@Component
struct Page_UIAbilityComponentsBasicUsage {
    startAbilityTest(): void {
        let context = getContext(this) as common.UIAbilityContext;
        let want: Want = {
            // Want参数信息
        };
        context.startAbility(want);
    }

    // 页面展示
    build() {
        // ...
    }
}