什么是UIAbility

引用官网概述：UIAbility是一种包含用户界面的应用组件，主要用于和用户进行交互。UIAbility也是系统调度的单元，为应用提供窗口在其中绘制界面。 这里也可以简单类比(<strong> 不完全相等 <strong>)微信小程根目录的app.js文件的作用。

每一个UIAbility实例，都对应于一个最近任务列表中的任务。

一个应用可以有一个UIAbility，也可以有多个UIAbility
一个UIAbility可以对应于多个页面，建议将一个独立的功能模块放到一个UIAbility中，以多页面的形式呈现。例如新闻应用在浏览内容的时候，可以进行多页面的跳转使用

UIAbility内页面的跳转和数据传递

页面间的导航通过页面路由router模块来实现。

这里的路由跳转和vue、react路由添砖非常相识；但是在跳转方式上，逻辑不同。需要注意一下。

页面跳转和参数接收

首先引入我们router

import router from '@ohos.router';
1.

页面跳转的几种方式，根据需要选择一种方式跳转即可。

方式一：API9及以上，router.pushUrl()方法新增了mode参数，可以将mode参数配置为router.RouterMode.Single单实例模式和router.RouterMode.Standard多实例模式。

单实例模式下：如果目标页面的url在页面栈中已经存在同url页面，离栈顶最近同url页面会被移动到栈顶，移动后的页面为新建页，原来的页面仍然存在栈中，页面栈的元素数量不变；如果目标页面的url在页面栈中不存在同url页面，按多实例模式跳转，页面栈的元素数量会加1。

当页面栈的元素数量较大或者超过32时，可以通过调用router.clear()方法清除页面栈中的所有历史页面，仅保留当前页面作为栈顶页面。
页面跳转

router.pushUrl({
  url: 'pages/Second',
  params: {
    src: 'Index页面传来的数据',
  }
}, router.RouterMode.Single)
1.
2.
3.
4.
5.
6.

方式二：API9及以上，router.replaceUrl()方法新增了mode参数，可以将mode参数配置为router.RouterMode.Single单实例模式和router.RouterMode.Standard多实例模式。
在单实例模式下：如果目标页面的url在页面栈中已经存在同url页面，离栈顶最近同url页面会被移动到栈顶，替换当前页面，并销毁被替换的当前页面，移动后的页面为新建页，页面栈的元素数量会减1；如果目标页面的url在页面栈中不存在同url页面，按多实例模式跳转，页面栈的元素数量不变。

router.replaceUrl({
  url: 'pages/Second',
  params: {
    src: 'Index页面传来的数据',
  }
}, router.RouterMode.Single)
1.
2.
3.
4.
5.
6.

跳转后，通过调用router.getParams()方法获取页面传递过来的自定义参数。

import router from '@ohos.router';

@Entry
@Component
struct Second {
  @State src: string = (router.getParams() as Record<string, string>)['src'];
  // 页面刷新展示
  ...
}
1.
2.
3.
4.
5.
6.
7.
8.
9.

页面返回和参数接收

通过调用router.back()方法实现返回到上一个页面，或者在调用router.back()方法时增加可选的options参数（增加url参数）返回到指定页面。

• 调用router.back()返回的目标页面需要在页面栈中存在才能正常跳转。
• 例如调用router.pushUrl()方法跳转到Second页面，在Second页面可以通过调用router.back()方法返回到上一个页面。
• 例如调用router.clear()方法清空了页面栈中所有历史页面，仅保留当前页面，此时则无法通过调用router.back()方法返回到上一个页面。

• 返回上一个页面。

router.back();
1.

• 返回指定页面

router.back({ url: 'pages/Index' });
1.

发回时也可以param中带参数给返回的页面，然后通过调用router.getParams()方法，获取页面传递过来的自定义参数。

router.back({
   url: 'pages/index',
   params: {
   	src: ''Second页面传来的数据"
   }
})
1.
2.
3.
4.
5.
6.

说明：
调用router.back()方法，不会新建页面，返回的是原来的页面，在原来页面中@State声明的变量不会重复声明，以及也不会触发页面的aboutToAppear()生命周期回调，因此无法直接在变量声明以及页面的aboutToAppear()生命周期回调中接收和解析router.back()传递过来的自定义参数。

如何需要进行参数解析。可以在页面中的onPageShow()生命周期回调中进行参数的解析：

import router from '@ohos.router';
@Entry
@Component
struct Index {
  @State src: string = '';
  onPageShow() {
    this.src = (router.getParams() as Record<string, string>)['src'];
  }
}
1.
2.
3.
4.
5.
6.
7.
8.
9.

UIAbility的生命周期

当用户浏览、切换和返回到对应应用的时候，应用中的UIAbility实例会在其生命周期的不同状态之间转换。
在UIAbility的使用过程中，会有多种生命周期状态。掌握UIAbility的生命周期，对于应用的开发非常重要。

为了实现多设备形态上的裁剪和多窗口的可扩展性，系统对组件管理和窗口管理进行了解耦。UIAbility的生命周期包括Create、Foreground、Background、Destroy四个状态，WindowStageCreate和WindowStageDestroy为窗口管理器（WindowStage）在UIAbility中管理UI界面功能的两个生命周期回调，从而实现UIAbility与窗口之间的弱耦合。如下图。

• Create状态，在UIAbiliy实例创建时触发，系统会调用onCreate回调。在onCreate回调中进行初始化操作。

import UIAbility from '@ohos.app.ability.UIAbility';
import window from '@ohos.window';

export default class EntryAbility extends UIAbility {
    onCreate(want: Want, launchParam: AbilityConstant.LaunchParam) {
        // 应用初始化
        ...
    }
    ...
}
1.
2.
3.
4.
5.
6.
7.
8.
9.
10.

• UIAbility实例创建完成之后，在进入Foreground之前，系统会创建一个WindowStage。每一个UIAbility实例都对应持有一个WindowStage实例。WindowStage为本地窗口管理器，用于管理窗口相关的内容，例如与界面相关的获焦/失焦、见/不可见。
  可以在onWindowStageCreate回调中,设置UI页面的加载，设置WindowStage的事件订阅。在onWindowStageCreate(windowStage)中通过loadContent接口设置应用要加载的页面。

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) => {
            ...
        });
    }
    ...
}
1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.
12.
13.
14.

• Foreground和Background状态，分别是UIAbiliy切换至前台或后台时触发。分别对应onForeground回调和onBackground回调。
  onForeground回调在UIAbility的UI可见之前和切换至前天时触发。可以在回调里申请系统需要的资源或者重新申请在onBackground中释放的资源。
  onBackground回调，在UIAbility的UI页面完全不可见之后，即切换至后台时触发。可以在回调中释放UI页面不可见时无用的资源，或回调执行中较为耗时的操作，比如状态保存等等。

import UIAbility from '@ohos.app.ability.UIAbility';
import hilog from '@ohos.hilog';
import window from '@ohos.window';

export default class EntryAbility extends UIAbility {
  onForeground() {
    // 申请系统需要的资源，或者重新申请在onBackground中释放的资源
    hilog.info(0x0000, 'testTag', '%{public}s', 'Ability onForeground');
  }

  onBackground() {
    // 释放UI页面不可见时无用的资源，或者在此回调中执行较为耗时的操作
    // 例如状态保存等
    hilog.info(0x0000, 'testTag', '%{public}s', 'Ability onBackground');
  }
}
1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.
12.
13.
14.
15.
16.

如地图授权，在onForeground获取定位权限。在onBackground中调用停止定位功能，已节省系统的资源消耗；

• 在UIAbility实例销毁之前，则会先进入onWindowStageDestroy回调
  可以在回到中释放UI页面资源，例如在onWindowStageCreate中设置的获焦/失焦等WindowStage订阅事件。

import UIAbility from '@ohos.app.ability.UIAbility';
import hilog from '@ohos.hilog';
import window from '@ohos.window';

export default class EntryAbility extends UIAbility {

  onWindowStageDestroy() {
    // 释放UI页面资源
    hilog.info(0x0000, 'testTag', '%{public}s', 'Ability onWindowStageDestroy');
  }
}
1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.

• Destroy状态，在UIAbilty销毁时触发。在回调中进行系统资源的释放、数据的保存等操作。

export default class EntryAbility extends UIAbility {
  // 系统资源的释放、数据的保存等
  onDestroy() {
    hilog.info(0x0000, 'testTag', '%{public}s', 'Ability onDestroy');
  }
}
1.
2.
3.
4.
5.
6.

例如用户使用应用的程序退出功能，会调用UIAbilityContext的terminalSelf()方法，从而完成UIAbility销毁。或者用户使用最近任务列表关闭该UIAbility实例时，也会完成UIAbility的销毁。

UIAbility的启动模式

1. 对于浏览器或则新闻应用，拥护在打开该应用，并浏览访问相关内容后，回调桌面，再次打开该应用，显示的仍然是用户当前访问的界面。
2. 对于应用的分屏操作，拥护希望使用两个不同应用（例如备忘录和图库应用）之间进行分屏，也希望能使用同一个（例如备忘录）进行分屏。
3. 对于文档应用，用户从文档引用中打一个文档内容，回到文档应用，继续打开同一个文档，希望打开的还是同一个文档内容。

基于以上场景考虑，UIAbility当前支持singleton(单实例模式)、multition（多实例模式）和specified（指定实例模式）3种启动模式。

• singleton（单实例模式）
  当用户打开浏览器或新闻等应用，并浏览器访问相关内容后，回到桌面，再次打开该应用，显示的仍然是用户当前访问的界面。
  这种情况下可以将UIAbilty配置为singleton（单实例模式）。每次调用startAbility()方法时，如果应用进程中类型的UIAbility实例已经存在，则复用系统中的UIAbility实例，系统中只存在唯一一个该UIAbility实例。
  即在最近任务列表中只存在一个该类型的UIAbility实例。

• multition（多实例模式）
  用户在使用分屏功能时，希望使用两个不同应用（例如备忘录应用和图库应用）之间进行分屏，也希望使用同一个应用（例如备忘录应用自身）进行分屏。
  这种情况可以将UIAbility配置为multition（多实例模式）。每次调用startAbility，都会在应用进程中创建一个该类型的UIAbility实例。

  即在最近任务列表中可以看到有多个该类型的UIAbility实例。

• specified（指定实例模式）
  用户打开文档应用，从文档应用中打开一个文档内容，回到文档引用，继续打开同一个文档，希望打开的还是同一个文档；以及在文档应用中新建一个新的文档，每次新建文档，希望每次打开的都是一个新的空白文档内容。
  在当前实例模式下。在UIAbility实例新创建之前，允许创建一个字符串key，新创建的UIAbility实例绑定Key之后，后续每次调用startAbility方法时，都会询问应用使用那个key对应UIAbility实例来响应startAbility请求。如果匹配有该UIAbility实例key,则直接拉起与之前绑定的UIAbility实例，否则创建一个新的UIAbility实例。运行时由UIAbility内部业务决定是否创建多实例。

singleton启动模式

它是默认启动模式，每次调用startAbility()启动UIAbility时，如果进程已存在UIAbility实例，则复用实例，系统中只存在唯一该UIAbility实例。
在module.json5文件中的“launchType”字段配置“singleton”即可

{
   "module": {
     ...
     "abilities": [
       {
         "launchType": "singleton",
         ...
       }
     ]
  }
}
1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.

multiton启动模式

每次调用startAbility()方法时，都会在应用进程中创建一个该类型的UIAbility实例。
在module.json5文件中的“launchType”字段配置“multiton”即可

{
   "module": {
     ...
     "abilities": [
       {
         "launchType": "multiton",
         ...
       }
     ]
  }
}
1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.

specified启动模式

根据业务需要创建一个新的UIAbility实例。在UIAbility实例创建之前，会先进入AbilityStage的onAcceptWant回调，在onAcceptWant回调中为每一个UIAbility实例创建一个key，后续每次调用startAbility()方法创建该类型的UIAbility实例都会询问使用哪个Key对应的UIAbility实例来响应startAbility()请求。

使用开发步骤：

1. 在module.json5文件中的“launchType”字段配置“specified”。

{
   "module": {
     ...
     "abilities": [
       {
         "launchType": "specified",
         ...
       }
     ]
  }
}
1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.

2. 在调用startAbility()方法的want参数中，增加一个自定义参数来区别UIAbility实例，例如增加一个“instarceKey”自定义参数

// 在启动指定实例模式的UIAbility时，给每一个UIAbility实例配置一个独立的Key标识
function getInstance() {
    ...
}
let context:common.UIAbilityContext = ...; // context为调用方UIAbility的UIAbilityContext
let want: Want = {
    deviceId: '', // deviceId为空表示本设备
    bundleName: 'com.example.myapplication',
    abilityName: 'SpecifiedAbility',
    moduleName: 'specified', // moduleName非必选
    parameters: { // 自定义信息
        instanceKey: getInstance(),
    },
}
context.startAbility(want).then(() => {
    ...
}).catch((err: BusinessError) => {
    ...
})
1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.
12.
13.
14.
15.
16.
17.
18.
19.

3. 在被拉起放UIAbility对应的AbilityStage的onAcceptWant生命周期回调中，解析传入的want参数，获取“instancekey”自定义参数。根据业务需要返回一个该UIAbility实例的字符串key标识。如果之前启动过此key标识的UIAbility,则会将之前的UIAbility拉回前台并获焦，而不创建新的实例，否则创建新的实例并启动。

onAcceptWant(want: want): string {
    // 在被启动方的AbilityStage中，针对启动模式为specified的UIAbility返回一个UIAbility实例对应的一个Key值
    // 当前示例指的是device Module的EntryAbility
   if (want.abilityName === 'MainAbility') {
        return `DeviceModule_MainAbilityInstance_${want.parameters.instanceKey}`;
    }
    return '';
}
1.
2.
3.
4.
5.
6.
7.
8.

例如上面应用中，可以对不同的文档实例内容绑定不同key值。当每次新建文档的时候，可以传入不同的新key值（如可以将文件的路径作为一个Key标识），此时AbilityStage中启动UIAbility时都会创建一个新的UIAbility实例；当新建的文档保存之后，回到桌面，或者新开一个已保存的文档，回到桌面，此时再次打开该已保存的文档，此时AbilityStage中再次启动该UIAbility时，打开的仍然是之前原来已保存的文档界面。

指定实例模式文档应用对应的UIAbility实例举例：

参考

华为开发者联盟官网开发者基础课程