• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# UIAbility组件生命周期
2
3
4## 概述
5
6当用户打开、切换和返回到对应应用时，应用中的UIAbility实例会在其生命周期的不同状态之间转换。UIAbility类提供了一系列回调，通过这些回调可以知道当前UIAbility实例的某个状态发生改变，会经过UIAbility实例的创建和销毁，或者UIAbility实例发生了前后台的状态切换。
7
8UIAbility的生命周期包括Create、Foreground、Background、Destroy四个状态，如下图所示。
9
10**图1** UIAbility生命周期状态
11![Ability-Life-Cycle](figures/Ability-Life-Cycle.png)
12
13
14## 生命周期状态说明
15
16
17### Create状态
18
19Create状态为在应用加载过程中，UIAbility实例创建完成时触发，系统会调用`onCreate()`回调。可以在该回调中进行应用初始化操作，例如变量定义资源加载等，用于后续的UI展示。
20
21
22```ts
23import UIAbility from '@ohos.app.ability.UIAbility';
24import AbilityConstant from '@ohos.app.ability.AbilityConstant';
25import Want from '@ohos.app.ability.Want';
26
27export default class EntryAbility extends UIAbility {
28  onCreate(want: Want, launchParam: AbilityConstant.LaunchParam) {
29    // 应用初始化
30  }
31  // ...
32}
33```
34
35> **说明**：
36>
37> [Want](../reference/apis/js-apis-app-ability-want.md)是对象间信息传递的载体，可以用于应用组件间的信息传递。Want的详细介绍请参见[信息传递载体Want](want-overview.md)。
38
39### WindowStageCreate和WindowStageDestroy状态
40
41UIAbility实例创建完成之后，在进入Foreground之前，系统会创建一个WindowStage。WindowStage创建完成后会进入`onWindowStageCreate()`回调，可以在该回调中设置UI加载、设置WindowStage的事件订阅。
42
43**图2** WindowStageCreate和WindowStageDestroy状态
44![Ability-Life-Cycle-WindowStage](figures/Ability-Life-Cycle-WindowStage.png)
45
46在onWindowStageCreate()回调中通过[`loadContent()`](../reference/apis/js-apis-window.md#loadcontent9-2)方法设置应用要加载的页面，并根据需要调用[`on('windowStageEvent')`](../reference/apis/js-apis-window.md#onwindowstageevent9)方法订阅WindowStage的[事件](../reference/apis/js-apis-window.md#windowstageeventtype9)（获焦/失焦、可见/不可见）。
47
48```ts
49import UIAbility from '@ohos.app.ability.UIAbility';
50import window from '@ohos.window';
51
52export default class EntryAbility extends UIAbility {
53  // ...
54
55  onWindowStageCreate(windowStage: window.WindowStage) {
56    // 设置WindowStage的事件订阅（获焦/失焦、可见/不可见）
57    try {
58      windowStage.on('windowStageEvent', (data) => {
59        let stageEventType: window.WindowStageEventType = data;
60        switch (stageEventType) {
61          case window.WindowStageEventType.SHOWN: // 切到前台
62            console.info('windowStage foreground.');
63            break;
64          case window.WindowStageEventType.ACTIVE: // 获焦状态
65            console.info('windowStage active.');
66            break;
67          case window.WindowStageEventType.INACTIVE: // 失焦状态
68            console.info('windowStage inactive.');
69            break;
70          case window.WindowStageEventType.HIDDEN: // 切到后台
71            console.info('windowStage background.');
72            break;
73          default:
74            break;
75        }
76      });
77    } catch (exception) {
78      console.error('Failed to enable the listener for window stage event changes. Cause:' +
79      JSON.stringify(exception));
80    }
81
82    // 设置UI加载
83    windowStage.loadContent('pages/Index', (err, data) => {
84      // ...
85    });
86  }
87}
88```
89
90> **说明：**
91>
92> WindowStage的相关使用请参见[窗口开发指导](../windowmanager/application-window-stage.md)。
93
94对应于`onWindowStageCreate()`回调。在UIAbility实例销毁之前，则会先进入`onWindowStageDestroy()`回调，可以在该回调中释放UI资源。例如在`onWindowStageDestroy()`中注销获焦/失焦等WindowStage事件。
95
96
97```ts
98import UIAbility from '@ohos.app.ability.UIAbility';
99import window from '@ohos.window';
100import { BusinessError } from '@ohos.base';
101
102export default class EntryAbility extends UIAbility {
103  windowStage: window.WindowStage | undefined = undefined;
104  // ...
105
106  onWindowStageCreate(windowStage: window.WindowStage) {
107    this.windowStage = windowStage;
108    // ...
109  }
110
111  onWindowStageDestroy() {
112    // 释放UI资源
113    // 例如在onWindowStageDestroy()中注销获焦/失焦等WindowStage事件
114    try {
115      if (this.windowStage) {
116        this.windowStage.off('windowStageEvent');
117      }
118    } catch (err) {
119      let code = (err as BusinessError).code;
120      let message = (err as BusinessError).message;
121      console.error(`Failed to disable the listener for windowStageEvent. Code is ${code}, message is ${message}`);
122    };
123  }
124}
125```
126
127
128### Foreground和Background状态
129
130Foreground和Background状态分别在UIAbility实例切换至前台和切换至后台时触发，对应于`onForeground()`回调和`onBackground()`回调。
131
132`onForeground()`回调，在UIAbility的UI可见之前，如UIAbility切换至前台时触发。可以在`onForeground()`回调中申请系统需要的资源，或者重新申请在`onBackground()`中释放的资源。
133
134`onBackground()`回调，在UIAbility的UI完全不可见之后，如UIAbility切换至后台时候触发。可以在`onBackground()`回调中释放UI不可见时无用的资源，或者在此回调中执行较为耗时的操作，例如状态保存等。
135
136例如应用在使用过程中需要使用用户定位时，假设应用已获得用户的定位权限授权。在UI显示之前，可以在`onForeground()`回调中开启定位功能，从而获取到当前的位置信息。
137
138当应用切换到后台状态，可以在`onBackground()`回调中停止定位功能，以节省系统的资源消耗。
139
140
141```ts
142import UIAbility from '@ohos.app.ability.UIAbility';
143
144export default class EntryAbility extends UIAbility {
145  // ...
146
147  onForeground() {
148    // 申请系统需要的资源，或者重新申请在onBackground()中释放的资源
149  }
150
151  onBackground() {
152    // 释放UI不可见时无用的资源，或者在此回调中执行较为耗时的操作
153    // 例如状态保存等
154  }
155}
156```
157
158
159### Destroy状态
160
161Destroy状态在UIAbility实例销毁时触发。可以在onDestroy()回调中进行系统资源的释放、数据的保存等操作。
162
163例如调用`terminateSelf()`方法停止当前UIAbility实例，从而完成UIAbility实例的销毁；或者用户使用最近任务列表关闭该UIAbility实例，完成UIAbility的销毁。
164
165```ts
166import UIAbility from '@ohos.app.ability.UIAbility';
167
168export default class EntryAbility extends UIAbility {
169  // ...
170
171  onDestroy() {
172    // 系统资源的释放、数据的保存等
173  }
174}
175```
176
177## 相关实例
178
179针对UIAbility生命周期，有以下相关实例可供参考：
180
181- [UIAbility和自定义组件生命周期（ArkTS）（API9）](https://gitee.com/openharmony/codelabs/tree/master/Ability/UIAbilityLifeCycle)