一、UIAbility组件概述
UIAbility组件是HarmonyOS中一种包含UI界面的应用组件,主要用于与用户进行交互。每个UIAbility组件实例对应最近任务列表中的一个任务,可以包含多个页面来实现不同功能模块。简单明了的说,UIAbility类似于Android的Activity,类似于iOS的ViewCcontroller。
声明配置
为了使用UIAbility,首先需要在module.json5配置文件的abilities标签中声明UIAbility的相关信息,abilities标签描述UIAbility组件的配置信息,标签值为数组类型,该标签下的配置包括组件的名称、入口、描述、图标、组件启动页面图标资源文件的索引、组件启动页面背景颜色资源文件的索引等。
{
"module": {
// ...
"abilities": [
{
"name": "EntryAbility", // UIAbility组件的名称
"srcEntrance": "./ets/entryability/EntryAbility.ts", // UIAbility组件的代码路径
"description": "$string:EntryAbility_desc", // UIAbility组件的描述信息
"icon": "$media:icon", // UIAbility组件的图标
"label": "$string:EntryAbility_label", // UIAbility组件的标签
"startWindowIcon": "$media:icon", // UIAbility组件启动页面图标资源文件的索引
"startWindowBackground": "$color:start_window_background", // UIAbility组件启动页面背景颜色资源文件的索引
"exported": true, "skills": [ { "entities": [ "entity.system.home" ], "actions": [ "action.system.home" ]
// ...
}
]
}
}
其中,skills 是一个字符串数组,定义了这个能力所具备的技能。actions 是一个字符串数组,定义了这个能力对应的动作。exported 标签在 abilities 下的 service 标签内部使用,用来指示当前服务是否允许其他应用导入。
二、UIAbility组件生命周期
UIAbility的生命周期包括Create、Foreground、Background、Destroy四个状态,如下图所示。
Create状态
Create状态表示UIAbility实例创建完成时触发,系统调用onCreate()回调。在该回调中可以进行应用初始化操作,如变量定义、资源加载等,为后续的UI界面展示做准备。
import UIAbility from '@ohos.app.ability.UIAbility';
export default class EntryAbility extends UIAbility {
onCreate(want, launchParam) {
// 应用初始化
}
// ...
}
WindowStageCreate和WindowStageDestroy状态
在UIAbility实例创建完成后,在进入Foreground之前,系统会创建一个WindowStage。WindowStage创建完成后会触发onWindowStageCreate()回调,可以在该回调中设置UI界面加载和订阅WindowStage的事件。
import UIAbility from '@ohos.app.ability.UIAbility';
import Window from '@ohos.window';
export default class EntryAbility extends UIAbility {
onWindowStageCreate(windowStage: Window.WindowStage) {
// 设置WindowStage的事件订阅(获焦/失焦、可见/不可见)
// 设置UI界面加载
windowStage.loadContent('pages/Index', (err, data) => {
// ...
});
}
// ...
}
// 对应onWindowStageCreate回调,在UIAbility实例销毁之前,会先进入onWindowStageDestroy回调,可以在该回调中释放UI界面资源。
export default class EntryAbility extends UIAbility {
// ...
onWindowStageDestroy() {
// 释放UI界面资源
}
}
Foreground和Background状态
Foreground和Background状态分别在UIAbility实例切换至前台和切换至后台时触发,对应于onForeground()和onBackground()回调。在onForeground()中可以申请系统需要的资源,而在onBackground()中可以释放UI界面不可见时无用的资源。
import UIAbility from '@ohos.app.ability.UIAbility';
export default class EntryAbility extends UIAbility {
onForeground() {
// 申请系统需要的资源,或者重新申请在onBackground中释放的资源
}
onBackground() {
// 释放UI界面不可见时无用的资源,或者在此回调中执行较为耗时的操作,例如状态保存等
}
}
Destroy状态
Destroy状态在UIAbility实例销毁时触发,可以在onDestroy()回调中进行系统资源的释放、数据的保存等操作。
import UIAbility from '@ohos.app.ability.UIAbility';
export default class EntryAbility extends UIAbility {
onDestroy() {
// 系统资源的释放、数据的保存等
}
}
三、UIAbility组件启动模式
UIAbility的启动模式有三种:singleton(单实例模式)、standard(标准实例模式)、specified(指定实例模式)。
Singleton启动模式
Singleton启动模式为单实例模式,是默认的启动模式。每次调用startAbility()方法时,如果应用进程中该类型的UIAbility实例已经存在,则复用该实例。系统中只存在唯一一个该UIAbility实例。
{
"module": {
// ...
"abilities": [
{
"launchType": "singleton",
// ...
}
]
}
}
Standard启动模式
Standard启动模式为标准实例模式,每次调用startAbility()方法时,都会在应用进程中创建一个新的该类型UIAbility实例。在最近任务列表中可以看到多个该类型的UIAbility实例。
{
"module": {
// ...
"abilities": [
{
"launchType": "standard",
// ...
}
]
}
}
Specified启动模式
Specified启动模式为指定实例模式,允许为UIAbility实例创建一个唯一的Key,后续每次调用startAbility()方法时,都会询问应用使用哪个Key对应的UIAbility实例来响应请求。
{
"module": {
// ...
"abilities": [
{
"launchType": "specified",
// ...
}
]
}
}
在指定实例模式下,需要在启动UIAbility时传入自定义参数,如"instanceKey",用于区分UIAbility实例。
let want = {
deviceId: '', // deviceId为空表示本设备
bundleName: 'com.example.myapplication',
abilityName: 'FuncAbility',
moduleName: 'module1', // moduleName非必选
parameters: { // 自定义信息
instanceKey: getInstance(),
},
};
// context
为调用方UIAbility的AbilityContext
this.context.startAbility(want).then(() => {
// ...
}).catch((err) => {
// ...
});
在被调用方UIAbility的AbilityStage中,通过onAcceptWant()生命周期回调返回一个字符串Key标识,用于匹配已创建的UIAbility实例。
import AbilityStage from '@ohos.app.ability.AbilityStage';
export default class MyAbilityStage extends AbilityStage {
onAcceptWant(want): string {
// 在被调用方的AbilityStage中,针对启动模式为specified的UIAbility返回一个UIAbility实例对应的一个Key值
// 当前示例指的是module1 Module的FuncAbility
if (want.abilityName === 'FuncAbility') {
// 返回的字符串Key标识为自定义拼接的字符串内容
return `ControlModule_EntryAbilityInstance_${want.parameters.instanceKey}`;
}
return '';
}
}