UIAbility 基本用法

• 指定 UIAbility 的启动页面

• 获取 UIAbility 的上下文 UIAbilityContext。

指定 UIAbility 的启动页面

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

import { UIAbility } from "@kit.AbilityKit";
import { window } from "@kit.ArkUI";

export default class EntryAbility extends UIAbility {
  onWindowStageCreate(windowStage: window.WindowStage): void {
    // Main window is created, set main page for this ability
    windowStage.loadContent("pages/Index", (err, data) => {
      // ...
    });
  }
  // ...
}

INFO

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

获取 UIAbility 的上下文信息

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

在 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() {
    // ...
  }
}

UIAbility 组件与 UI 的数据同步

基于当前的应用模型，可以通过以下几种方式来实现 UIAbility 组件与 UI 之间的数据同步。

• 使用 EventHub 进行数据通信：在基类 Context 中提供了 EventHub 对象，可以通过发布订阅方式来实现事件的传递。在事件传递前，订阅者需要先进行订阅，当发布者发布事件时，订阅者将接收到事件并进行相应处理。

• 使用 AppStorage/LocalStorage 进行数据同步：ArkUI 提供了 AppStorage 和 LocalStorage 两种应用级别的状态管理方案，可用于实现应用级别和 UIAbility 级别的数据同步。

使用 EventHub 进行数据通信

EventHub 为 UIAbility 组件提供了事件机制，使它们能够进行订阅、取消订阅和触发事件等数据通信能力。

• (1) 在 UIAbility 中调用 eventHub.on()方法注册一个自定义事件“event1”，eventHub.on()有如下两种调用方式，使用其中一种即可

import { hilog } from "@kit.PerformanceAnalysisKit";
import { UIAbility, Context, Want, AbilityConstant } from "@kit.AbilityKit";

const DOMAIN_NUMBER: number = 0xff00;
const TAG: string = "[EventAbility]";

export default class EntryAbility extends UIAbility {
  onCreate(want: Want, launchParam: AbilityConstant.LaunchParam): void {
    // 获取eventHub
    let eventhub = this.context.eventHub;
    // 执行订阅操作
    eventhub.on("event1", this.eventFunc);
    eventhub.on("event1", (data: string) => {
      // 触发事件，完成相应的业务操作
    });
    hilog.info(DOMAIN_NUMBER, TAG, "%{public}s", "Ability onCreate");
  }

  // ... 函数形式
  eventFunc(argOne: Context, argTwo: Context): void {
    hilog.info(DOMAIN_NUMBER, TAG, "1. " + `${argOne}, ${argTwo}`);
    return;
  }
}

• (2) 在 UI 中通过 eventHub.emit()方法触发该事件，在触发事件的同时，根据需要传入参数信息。

import { common } from '@kit.AbilityKit';
import { promptAction } from '@kit.ArkUI';

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

  eventHubFunc(): void {
    // 不带参数触发自定义“event1”事件
    this.context.eventHub.emit('event1');
    // 带1个参数触发自定义“event1”事件
    this.context.eventHub.emit('event1', 1);
    // 带2个参数触发自定义“event1”事件
    this.context.eventHub.emit('event1', 2, 'test');
    // 开发者可以根据实际的业务场景设计事件传递的参数
  }

  build() {
    Column() {
      // ...
      List({ initialIndex: 0 }) {
        ListItem() {
          Row() {
            // ...
          }
          .onClick(() => {
            this.eventHubFunc();
            promptAction.showToast({
              message: 'EventHubFuncA'
            });
          })
        }

        // ...
        ListItem() {
          Row() {
            // ...
          }
          .onClick(() => {
            this.context.eventHub.off('event1');
            promptAction.showToast({
              message: 'EventHubFuncB'
            });
          })
        }
        // ...
      }
      // ...
    }
    // ...
  }
}

• (3) 在 UIAbility 的注册事件回调中可以得到对应的触发事件结果，运行日志结果如下所示。

[Example].[Entry].[EntryAbility] 1. []
[Example].[Entry].[EntryAbility] 1. [1]
[Example].[Entry].[EntryAbility] 1. [2,"test"]

• 在自定义事件“event1”使用完成后，可以根据需要调用 eventHub.off()方法取消该事件的订阅。

import { UIAbility } from '@kit.AbilityKit';

export default class EntryAbility extends UIAbility {
  // ...
  onDestroy(): void {
    this.context.eventHub.off('event1');
  }
}

使用 AppStorage/LocalStorage 进行数据同步

ArkUI 提供了 AppStorage 和 LocalStorage 两种应用级别的状态管理方案，可用于实现应用级别和 UIAbility 级别的数据同步。使用这些方案可以方便地管理应用状态，提高应用性能和用户体验。其中，AppStorage 是一个全局的状态管理器，适用于多个 UIAbility 共享同一状态数据的情况；而 LocalStorage 则是一个局部的状态管理器，适用于单个 UIAbility 内部使用的状态数据。通过这两种方案，开发者可以更加灵活地控制应用状态，提高应用的可维护性和可扩展性。