• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# 应用上下文Context
2
3<!--Kit: Ability Kit-->
4<!--Subsystem: Ability-->
5<!--Owner: @li-weifeng2; @xuzhihao666-->
6<!--Designer: @li-weifeng2-->
7<!--Tester: @lixueqing513-->
8<!--Adviser: @huipeizi-->
9
10## 概述
11
12[Context](../reference/apis-ability-kit/js-apis-inner-application-context.md)是应用中对象的上下文,其提供了应用的一些基础信息,例如[resourceManager](../reference/apis-localization-kit/js-apis-resource-manager.md)(资源管理)、[applicationInfo](../reference/apis-ability-kit/js-apis-bundleManager-applicationInfo.md)(当前应用信息)、[area](../reference/apis-ability-kit/js-apis-app-ability-contextConstant.md#areamode)(文件分区)等。
13
14## 不同类型Context的对比
15
16[UIAbility](../reference/apis-ability-kit/js-apis-app-ability-uiAbility.md)组件和各种[ExtensionAbility](../reference/apis-ability-kit/js-apis-app-ability-extensionAbility.md)派生类组件都有各自不同的Context类。分别有基类Context、[ApplicationContext](../reference/apis-ability-kit/js-apis-inner-application-applicationContext.md)、[AbilityStageContext](../reference/apis-ability-kit/js-apis-inner-application-abilityStageContext.md)、[UIAbilityContext](../reference/apis-ability-kit/js-apis-inner-application-uiAbilityContext.md)、[ExtensionContext](../reference/apis-ability-kit/js-apis-inner-application-extensionContext.md)<!--Del-->、[ServiceExtensionContext](../reference/apis-ability-kit/js-apis-inner-application-serviceExtensionContext-sys.md)<!--DelEnd-->等Context。各类Context的继承和持有关系详见[不同类型Context的继承和持有关系](../reference/apis-ability-kit/js-apis-inner-application-context.md#不同类型context的继承和持有关系)。
17
18不同类型Context的获取方式与使用场景说明,如下表所示。
19
20> **说明:**
21>
22> 不同类型的Context具有不同的能力,不可相互替代或强行转换。例如,[ApplicationContext](../reference/apis-ability-kit/js-apis-inner-application-applicationContext.md)绑定了[setFontSizeScale](../reference/apis-ability-kit/js-apis-inner-application-applicationContext.md#applicationcontextsetfontsizescale13)方法,但[UIAbilityContext](../reference/apis-ability-kit/js-apis-inner-application-uiAbilityContext.md)中没有此方法。因此,即使将UIAbilityContext强行转换为ApplicationContext,也无法调用setFontSizeScale方法。
23
24   **表1** 不同类型Context的说明
25
26  | Context类型 | 说明 | 获取方式 | 使用场景 |
27  | -------- | -------- | -------- | -------- |
28  | [ApplicationContext](../reference/apis-ability-kit/js-apis-inner-application-applicationContext.md) | 应用的全局上下文,提供应用级别的信息和能力。| - 从API version 14开始,可以直接使用[getApplicationContext](../reference/apis-ability-kit/js-apis-app-ability-application.md#applicationgetapplicationcontext14)获取。<br>- API version 14以前版本,只能使用其他Context实例的[getApplicationContext](../reference/apis-ability-kit/js-apis-inner-application-context.md#getapplicationcontext)方法获取。 | - [获取当前应用的基本信息](#获取基本信息)。<br>- [获取应用级别的文件路径](#获取应用文件路径)。<br>- [获取和修改加密分区](#获取和修改加密分区)。<br>- [注册应用前后台变化监听](#监听应用前后台变化)。 |
29  | [AbilityStageContext](../reference/apis-ability-kit/js-apis-inner-application-abilityStageContext.md) | 模块级别的上下文,提供模块级别的信息和能力。| - 如果需要获取当前AbilityStage的Context,可以直接通过AbilityStage实例获取[context](../reference/apis-ability-kit/js-apis-app-ability-abilityStage.md#属性)属性。<br> - 如果需要获取同一应用中其他Module的Context,可以通过[createModuleContext](../reference/apis-ability-kit/js-apis-app-ability-application.md#applicationcreatemodulecontext12)方法。 | - 获取当前模块的基本信息。<br>- [获取模块的文件路径](#获取应用文件路径)。|
30   | [UIAbilityContext](../reference/apis-ability-kit/js-apis-inner-application-uiAbilityContext.md) | UIAbility组件对应的上下文,提供UIAbility对外的信息和能力。| - 通过UIAbility实例直接获取[context](../reference/apis-ability-kit/js-apis-app-ability-uiAbility.md#属性)属性。<br>- 在UIAbility的窗口中加载的UI组件实例,需要使用@ohos.arkui.UIContext提供的[getHostContext](../reference/apis-arkui/arkts-apis-uicontext-uicontext.md#gethostcontext12)方法。 | - 获取当前UIAbility基本信息。<br>- 启动其他应用或原子化服务、连接/断连系统应用创建的ServiceExtensionAbility等。<br>- 销毁自身的UIAbility。 |
31  | [ExtensionContext](../reference/apis-ability-kit/js-apis-inner-application-extensionContext.md) | ExtensionAbility组件对应的上下文,每种类型的ExtensionContext提供不同的信息和能力。| 通过ExtensionAbility实例直接获取Context属性。 | 不同类型的ExtensionAbility对应的Context提供的能力不同。以输入法上下文[InputMethodExtensionContext](../reference/apis-ime-kit/js-apis-inputmethod-extension-context.md)为例,主要提供如下能力:<br>- 获取InputMethodExtensionAbility的基本信息。<br>- 销毁当前输入法。|
32| [UIContext](../reference/apis-arkui/arkts-apis-uicontext-uicontext.md) | ArkUI的UI实例上下文,提供UI操作相关的能力。与上述其他类型的Context无直接关系。 | - 在UI组件内获取UIContext,直接使用组件内置的[getUIContext](../reference/apis-arkui/arkui-ts/ts-custom-component-api.md#getuicontext)方法。<br>- 在存在Window实例的情况下,使用@ohos.window提供的[getUIContext](../reference/apis-arkui/arkts-apis-window-Window.md#getuicontext10)方法。 | 主要用于UI实例中UI相关操作,例如:<br>- 获取当前UI实例的字体。<br>- 显示不同类型的弹框。<br>- 设置软键盘弹出时UI避让模式。 |
33
34## Context的获取方式
35
36开发者如果需要通过Context获取应用资源、应用路径等信息,或者使用Context提供的方法来实现应用跳转、设置环境变量、清理数据、获取权限等操作,需要先获取对应的Context。本节分别介绍不同类型Context的获取方式与使用场景。
37
38### 获取ApplicationContext(应用的全局上下文)
39
40[ApplicationContext](../reference/apis-ability-kit/js-apis-inner-application-applicationContext.md)在基类Context的基础上提供了监听应用内应用组件的生命周期的变化、监听系统内存变化、监听应用内系统环境变化、设置应用语言、设置应用颜色模式、清除应用自身数据的同时撤销应用向用户申请的权限等能力,在[UIAbility](../reference/apis-ability-kit/js-apis-app-ability-uiAbility.md)、[ExtensionAbility](../reference/apis-ability-kit/js-apis-app-ability-extensionAbility.md)、[AbilityStage](../reference/apis-ability-kit/js-apis-app-ability-abilityStage.md)中均可以获取。
41
42  ```ts
43  import { UIAbility, AbilityConstant, Want } from '@kit.AbilityKit';
44
45  export default class EntryAbility extends UIAbility {
46    onCreate(want: Want, launchParam: AbilityConstant.LaunchParam): void {
47      let applicationContext = this.context.getApplicationContext();
48      //...
49    }
50  }
51  ```
52
53### 获取AbilityStageContext(模块级别的上下文)
54
55[AbilityStageContext](../reference/apis-ability-kit/js-apis-inner-application-abilityStageContext.md)和基类Context相比,额外提供[HapModuleInfo](../reference/apis-ability-kit/js-apis-bundleManager-hapModuleInfo.md)、[Configuration](../reference/apis-ability-kit/js-apis-app-ability-configuration.md)等信息。
56
57  ```ts
58  import { AbilityStage } from '@kit.AbilityKit';
59
60  export default class MyAbilityStage extends AbilityStage {
61    onCreate(): void {
62      let abilityStageContext = this.context;
63      //...
64    }
65  }
66  ```
67
68### 获取本应用中其他Module的Context(模块级别的上下文)
69
70调用[createModuleContext](../reference/apis-ability-kit/js-apis-app-ability-application.md#applicationcreatemodulecontext12)方法,获取本应用中其他Module的Context。获取到其他Module的Context之后,即可获取到相应Module的资源信息。
71
72  ```ts
73  import { common, application } from '@kit.AbilityKit';
74  import { BusinessError } from '@kit.BasicServicesKit';
75
76  let storageEventCall = new LocalStorage();
77
78  @Entry(storageEventCall)
79  @Component
80  struct Page_Context {
81    private context = this.getUIContext().getHostContext() as common.UIAbilityContext;
82
83    build() {
84      Column() {
85        //...
86        List({ initialIndex: 0 }) {
87          ListItem() {
88            Row() {
89              //...
90            }
91            .onClick(() => {
92              let moduleName2: string = 'entry';
93              application.createModuleContext(this.context, moduleName2)
94                .then((data: common.Context) => {
95                  console.info(`CreateModuleContext success, data: ${JSON.stringify(data)}`);
96                  if (data !== null) {
97                    this.getUIContext().getPromptAction().showToast({
98                      message: ('成功获取Context')
99                    });
100                  }
101                })
102                .catch((err: BusinessError) => {
103                  console.error(`CreateModuleContext failed, err code:${err.code}, err msg: ${err.message}`);
104                });
105            })
106          }
107          //...
108        }
109        //...
110      }
111      //...
112    }
113  }
114  ```
115
116### 获取UIAbilityContext(UIAbility组件对应的上下文)
117
118[UIAbility](../reference/apis-ability-kit/js-apis-app-ability-uiAbility.md)类拥有自身的上下文信息,该信息为[UIAbilityContext](../reference/apis-ability-kit/js-apis-inner-application-uiAbilityContext.md)类的实例,[UIAbilityContext](../reference/apis-ability-kit/js-apis-inner-application-uiAbilityContext.md)类拥有abilityInfo、currentHapModuleInfo等属性。通过UIAbilityContext可以获取UIAbility的相关配置信息,如包代码路径、Bundle名称、Ability名称和应用程序需要的环境状态等属性信息,以及可以获取操作UIAbility实例的方法(如[startAbility()](../reference/apis-ability-kit/js-apis-inner-application-uiAbilityContext.md#startability)、[connectServiceExtensionAbility()](../reference/apis-ability-kit/js-apis-inner-application-uiAbilityContext.md#connectserviceextensionability)、[terminateSelf()](../reference/apis-ability-kit/js-apis-inner-application-uiAbilityContext.md#terminateself)等)。
119如果需要在页面中获得当前Ability的Context,可使用[UIContext](../reference/apis-arkui/arkts-apis-uicontext-uicontext.md)中的[getHostContext](../reference/apis-arkui/arkts-apis-uicontext-uicontext.md#gethostcontext12)接口获取当前页面关联的UIAbilityContext或[ExtensionContext](../reference/apis-ability-kit/js-apis-inner-application-extensionContext.md)。
120
121- 在UIAbility中可以通过`this.context`获取UIAbility实例的上下文信息。
122
123  ```ts
124  import { UIAbility, AbilityConstant, Want } from '@kit.AbilityKit';
125
126  export default class EntryAbility extends UIAbility {
127    onCreate(want: Want, launchParam: AbilityConstant.LaunchParam): void {
128      // 获取UIAbility实例的上下文
129      let context = this.context;
130      // ...
131    }
132  }
133  ```
134
135- 在页面中获取UIAbility实例的上下文信息,包括导入依赖资源context模块和在组件中定义一个context变量两个部分。
136
137  ```ts
138  import { common, Want } from '@kit.AbilityKit';
139
140  @Entry
141  @Component
142  struct Page_EventHub {
143    private context = this.getUIContext().getHostContext() as common.UIAbilityContext;
144
145    startAbilityTest(): void {
146      let want: Want = {
147        // Want参数信息
148      };
149      this.context.startAbility(want);
150    }
151
152    // 页面展示
153    build() {
154      // ...
155    }
156  }
157  ```
158
159  也可以在导入依赖资源context模块后,在具体使用[UIAbilityContext](../reference/apis-ability-kit/js-apis-inner-application-uiAbilityContext.md)前进行变量定义。
160
161
162  ```ts
163  import { common, Want } from '@kit.AbilityKit';
164
165  @Entry
166  @Component
167  struct Page_UIAbilityComponentsBasicUsage {
168    startAbilityTest(): void {
169      let context = this.getUIContext().getHostContext() as common.UIAbilityContext;
170      let want: Want = {
171        // Want参数信息
172      };
173      context.startAbility(want);
174    }
175
176    // 页面展示
177    build() {
178      // ...
179    }
180  }
181  ```
182
183- 当业务完成后,开发者如果想要终止当前[UIAbility](../reference/apis-ability-kit/js-apis-app-ability-uiAbility.md)实例,可以通过调用[terminateSelf()](../reference/apis-ability-kit/js-apis-inner-application-uiAbilityContext.md#terminateself)方法实现。
184
185  ```ts
186  import { common } from '@kit.AbilityKit';
187  import { BusinessError } from '@kit.BasicServicesKit';
188
189  @Entry
190  @Component
191  struct Page_UIAbilityComponentsBasicUsage {
192    // 页面展示
193    build() {
194      Column() {
195        //...
196        Button('FuncAbilityB')
197          .onClick(() => {
198            let context = this.getUIContext().getHostContext() as common.UIAbilityContext;
199            try {
200              context.terminateSelf((err: BusinessError) => {
201                if (err.code) {
202                  // 处理业务逻辑错误
203                  console.error(`terminateSelf failed, code is ${err.code}, message is ${err.message}.`);
204                  return;
205                }
206                // 执行正常业务
207                console.info(`terminateSelf succeed.`);
208              });
209            } catch (err) {
210              // 捕获同步的参数错误
211              let code = (err as BusinessError).code;
212              let message = (err as BusinessError).message;
213              console.error(`terminateSelf failed, code is ${code}, message is ${message}.`);
214            }
215          })
216      }
217    }
218  }
219  ```
220
221### 获取ExtensionAbilityContext (组件级的Context)
222
223获取特定场景[ExtensionContext](../reference/apis-ability-kit/js-apis-inner-application-extensionContext.md)。以FormExtensionContext为例,表示卡片服务的上下文环境,继承自ExtensionContext,提供卡片服务相关的接口能力。
224
225```ts
226import { FormExtensionAbility, formBindingData } from '@kit.FormKit';
227import { Want } from '@kit.AbilityKit';
228
229export default class MyFormExtensionAbility extends FormExtensionAbility {
230  onAddForm(want: Want) {
231    let formExtensionContext = this.context;
232    // ...
233    let dataObj1: Record<string, string> = {
234      'temperature': '11c',
235      'time': '11:00'
236    };
237    let obj1: formBindingData.FormBindingData = formBindingData.createFormBindingData(dataObj1);
238    return obj1;
239  }
240}
241```
242
243
244## Context的典型使用场景
245
246
247本章节通过以下具体场景来介绍Context的用法:
248
249- [获取基本信息](#获取基本信息)
250- [获取应用文件路径](#获取应用文件路径)
251- [获取和修改加密分区](#获取和修改加密分区)
252- [监听应用前后台变化](#监听应用前后台变化)
253- [监听UIAbility生命周期变化](#监听uiability生命周期变化)
254
255### 获取基本信息
256
257继承自[Context](../reference/apis-ability-kit/js-apis-inner-application-context.md)的不同类型Context,默认会继承父类的方法和属性,还会拥有自己独立的方法与属性。
258
259通过Context属性可以获取当前应用、模块、UIAbility或ExtensionAbility的基本信息(例如资源管理对象、应用程序信息等),下面以UIAbility的信息获取为例:
260
261如果需要跨包获取资源对象,可以参考[资源访问](../quick-start/resource-categories-and-access.md#资源访问)。
262
263  ```ts
264  import { UIAbility, AbilityConstant, Want } from '@kit.AbilityKit';
265
266  export default class EntryAbility extends UIAbility {
267    onCreate(want: Want, launchParam: AbilityConstant.LaunchParam): void {
268      // 获取ResourceManager(资源管理)
269      let resourceManager = this.context.getApplicationContext().resourceManager;
270      // 获取applicationInfo(当前应用信息)
271      let applicationInfo = this.context.getApplicationContext().applicationInfo;
272      //...
273    }
274  }
275  ```
276
277### 获取应用文件路径
278
279[基类Context](../reference/apis-ability-kit/js-apis-inner-application-context.md)提供了获取应用文件路径的能力,[ApplicationContext](../reference/apis-ability-kit/js-apis-inner-application-applicationContext.md)、[AbilityStageContext](../reference/apis-ability-kit/js-apis-inner-application-abilityStageContext.md)、[UIAbilityContext](../reference/apis-ability-kit/js-apis-inner-application-uiAbilityContext.md)和[ExtensionContext](../reference/apis-ability-kit/js-apis-inner-application-extensionContext.md)均继承该能力。不同类型的Context获取的路径可能存在差异。
280
281- 通过[ApplicationContext](../reference/apis-ability-kit/js-apis-inner-application-applicationContext.md)可以获取应用级的文件路径。该路径用于存放应用全局信息,路径下的文件会跟随应用的卸载而删除。
282- 通过[AbilityStageContext](../reference/apis-ability-kit/js-apis-inner-application-abilityStageContext.md)、[UIAbilityContext](../reference/apis-ability-kit/js-apis-inner-application-uiAbilityContext.md)、[ExtensionContext](../reference/apis-ability-kit/js-apis-inner-application-extensionContext.md),可以获取[Module](../quick-start/application-package-overview.md)级的文件路径。该路径用于存放Module相关信息,路径下的文件会跟随[HAP](../quick-start/hap-package.md)/[HSP](../quick-start/in-app-hsp.md)的卸载而删除。HAP/HSP的卸载不会影响应用级路径下的文件,除非该应用的HAP/HSP已全部卸载。
283
284  - UIAbilityContext:可以获取UIAbility所在Module的文件路径。
285  - ExtensionContext:可以获取ExtensionAbility所在Module的文件路径。
286  - AbilityStageContext:由于AbilityStageContext创建时机早于UIAbilityContext和ExtensionContext,通常用于在AbilityStage中获取文件路径。
287
288>**说明:**
289>
290> 应用文件路径属于应用沙箱路径,具体请参见[应用沙箱目录](../file-management/app-sandbox-directory.md)。
291
292  **表1** 不同级别Context获取的应用文件路径说明
293  | 属性 | 说明 | ApplicationContext获取的路径 | AbilityStageContext、UIAbilityContext、ExtensionContext获取的路径 |
294  | -------- | -------- | -------- | -------- |
295  | bundleCodeDir | 安装包目录。 | <路径前缀>/el1/bundle | <路径前缀>/el1/bundle |
296  | cacheDir | 缓存目录。 | <路径前缀>/<加密等级>/base/cache | <路径前缀>/<加密等级>/base/**haps/\<module-name>**/cache |
297  | filesDir | 文件目录。 | <路径前缀>/<加密等级>/base/files | <路径前缀>/<加密等级>/base/**haps/\<module-name>**/files |
298  | preferencesDir | preferences目录。 | <路径前缀>/<加密等级>/base/preferences | <路径前缀>/<加密等级>/base/**haps/\<module-name>**/preferences |
299  | tempDir | 临时目录。 | <路径前缀>/<加密等级>/base/temp | <路径前缀>/<加密等级>/base/**haps/\<module-name>**/temp |
300  | databaseDir | 数据库目录。 | <路径前缀>/<加密等级>/database | <路径前缀>/<加密等级>/database/**\<module-name>** |
301  | distributedFilesDir | 分布式文件目录。 | <路径前缀>/el2/distributedFiles | <路径前缀>/el2/distributedFiles/ |
302  | resourceDir<sup>11+<sup> | 资源目录。<br/>**说明:**<br/> 需要开发者手动在`\<module-name>\resource`路径下创建`resfile`目录。 | 不涉及 | <路径前缀>/el1/bundle/**\<module-name>**/resources/resfile |
303  | cloudFileDir<sup>12+</sup> | 云文件目录。 | <路径前缀>/el2/cloud | <路径前缀>/el2/cloud/ |
304
305本节以使用ApplicationContext获取cacheDir和filesDir为例,分别介绍如何获取应用缓存目录,以及如何获取应用文件目录,并用于新建文件和读写文件。
306
307- **获取应用缓存目录**
308
309  ```ts
310  import { common } from '@kit.AbilityKit';
311
312  const TAG: string = '[Page_Context]';
313  const DOMAIN_NUMBER: number = 0xFF00;
314
315  @Entry
316  @Component
317  struct Index {
318    @State message: string = 'Hello World';
319    private context = this.getUIContext().getHostContext() as common.UIAbilityContext;
320
321    build() {
322      Row() {
323        Column() {
324          Text(this.message)
325          // ...
326          Button() {
327            Text('create file')
328              // ...
329              .onClick(() => {
330                let applicationContext = this.context.getApplicationContext();
331                // 获取应用缓存路径
332                let cacheDir = applicationContext.cacheDir;
333              })
334          }
335          // ...
336        }
337        // ...
338      }
339      // ...
340    }
341  }
342  ```
343
344- **获取应用文件目录**
345
346  ```ts
347  import { common } from '@kit.AbilityKit';
348  import { buffer } from '@kit.ArkTS';
349  import { fileIo, ReadOptions } from '@kit.CoreFileKit';
350  import { hilog } from '@kit.PerformanceAnalysisKit';
351
352  const TAG: string = '[Page_Context]';
353  const DOMAIN_NUMBER: number = 0xFF00;
354
355  @Entry
356  @Component
357  struct Index {
358    @State message: string = 'Hello World';
359    private context = this.getUIContext().getHostContext() as common.UIAbilityContext;
360
361    build() {
362      Row() {
363        Column() {
364          Text(this.message)
365          // ...
366          Button() {
367            Text('create file')
368              // ...
369              .onClick(() => {
370                let applicationContext = this.context.getApplicationContext();
371                // 获取应用文件路径
372                let filesDir = applicationContext.filesDir;
373                hilog.info(DOMAIN_NUMBER, TAG, `filePath: ${filesDir}`);
374                // 文件不存在时创建并打开文件,文件存在时打开文件
375                let file = fileIo.openSync(filesDir + '/test.txt', fileIo.OpenMode.READ_WRITE | fileIo.OpenMode.CREATE);
376                // 写入一段内容至文件
377                let writeLen = fileIo.writeSync(file.fd, "Try to write str.");
378                hilog.info(DOMAIN_NUMBER, TAG, `The length of str is: ${writeLen}`);
379                // 创建一个大小为1024字节的ArrayBuffer对象,用于存储从文件中读取的数据
380                let arrayBuffer = new ArrayBuffer(1024);
381                // 设置读取的偏移量和长度
382                let readOptions: ReadOptions = {
383                  offset: 0,
384                  length: arrayBuffer.byteLength
385                };
386                // 读取文件内容到ArrayBuffer对象中,并返回实际读取的字节数
387                let readLen = fileIo.readSync(file.fd, arrayBuffer, readOptions);
388                // 将ArrayBuffer对象转换为Buffer对象,并转换为字符串输出
389                let buf = buffer.from(arrayBuffer, 0, readLen);
390                hilog.info(DOMAIN_NUMBER, TAG, `the content of file: ${buf.toString()}`);
391                // 关闭文件
392                fileIo.closeSync(file);
393              })
394          }
395          // ...
396        }
397        // ...
398      }
399      // ...
400    }
401  }
402  ```
403
404### 获取和修改加密分区
405
406应用文件加密是一种保护数据安全的方法,可以使得文件在未经授权访问的情况下得到保护。在不同的场景下,应用需要不同程度的文件保护。
407
408在实际应用中,开发者需要根据不同场景的需求选择合适的加密分区,从而保护应用数据的安全。通过合理使用不同级别的加密分区,可以有效提升应用数据的安全性。关于不同分区的权限说明,详见[ContextConstant](../reference/apis-ability-kit/js-apis-app-ability-contextConstant.md)的[AreaMode](../reference/apis-ability-kit/js-apis-app-ability-contextConstant.md#areamode)。
409
410- EL1:对于私有文件,如闹铃、壁纸等,应用可以将这些文件放到设备级加密分区(EL1)中,以保证在用户输入密码前就可以被访问。
411- EL2:对于更敏感的文件,如个人隐私信息等,应用可以将这些文件放到更高级别的加密分区(EL2)中,以保证更高的安全性。
412- EL3:对于应用中的记录步数、文件下载、音乐播放,需要在锁屏时读写和创建新文件,放在(EL3)的加密分区比较合适。
413- EL4:对于用户安全信息相关的文件,锁屏时不需要读写文件、也不能创建文件,放在(EL4)的加密分区更合适。
414- EL5:对于用户隐私敏感数据文件,锁屏后默认不可读写,如果锁屏后需要读写文件,则锁屏前可以调用[acquireAccess](../reference/apis-ability-kit/js-apis-screenLockFileManager.md#screenlockfilemanageracquireaccess)接口申请继续读写文件,或者锁屏后也需要创建新文件且可读写,放在(EL5)的应用级加密分区更合适。
415
416要实现获取和设置当前加密分区,可以通过读写[Context](../reference/apis-ability-kit/js-apis-inner-application-context.md)的`area`属性来实现。
417
418```ts
419// EntryAbility.ets
420import { UIAbility, contextConstant, AbilityConstant, Want } from '@kit.AbilityKit';
421
422export default class EntryAbility extends UIAbility {
423  onCreate(want: Want, launchParam: AbilityConstant.LaunchParam) {
424    // 存储普通信息前,切换到EL1设备级加密
425    this.context.area = contextConstant.AreaMode.EL1; // 切换area
426    // 存储普通信息
427
428    // 存储敏感信息前,切换到EL2用户级加密
429    this.context.area = contextConstant.AreaMode.EL2; // 切换area
430    // 存储敏感信息
431
432    // 存储敏感信息前,切换到EL3用户级加密
433    this.context.area = contextConstant.AreaMode.EL3; // 切换area
434    // 存储敏感信息
435
436    // 存储敏感信息前,切换到EL4用户级加密
437    this.context.area = contextConstant.AreaMode.EL4; // 切换area
438    // 存储敏感信息
439
440    // 存储敏感信息前,切换到EL5应用级加密
441    this.context.area = contextConstant.AreaMode.EL5; // 切换area
442    // 存储敏感信息
443  }
444}
445```
446```ts
447// Index.ets
448import { contextConstant, common } from '@kit.AbilityKit';
449
450@Entry
451@Component
452struct Page_Context {
453  private context = this.getUIContext().getHostContext() as common.UIAbilityContext;
454
455  build() {
456    Column() {
457      //...
458      List({ initialIndex: 0 }) {
459        //...
460        ListItem() {
461          Row() {
462            //...
463          }
464          .onClick(() => {
465            // 存储普通信息前,切换到EL1设备级加密
466            if (this.context.area === contextConstant.AreaMode.EL2) { // 获取area
467              this.context.area = contextConstant.AreaMode.EL1; // 修改area
468              this.getUIContext().getPromptAction().showToast({
469                message: 'SwitchToEL1'
470              });
471            }
472            // 存储普通信息
473          })
474        }
475        //...
476        ListItem() {
477          Row() {
478            //...
479          }
480          .onClick(() => {
481            // 存储敏感信息前,切换到EL2用户级加密
482            if (this.context.area === contextConstant.AreaMode.EL1) { // 获取area
483              this.context.area = contextConstant.AreaMode.EL2; // 修改area
484              this.getUIContext().getPromptAction().showToast({
485                message: 'SwitchToEL2'
486              });
487            }
488            // 存储敏感信息
489          })
490        }
491        //...
492      }
493      //...
494    }
495    //...
496  }
497}
498```
499
500### 监听应用前后台变化
501
502开发者可以使用[ApplicationContext](../reference/apis-ability-kit/js-apis-inner-application-applicationContext.md)的相关能力,监听应用的前后台变化。当应用前后台切换时,可以收到相应回调函数的通知,从而执行一些依赖前后台的方法,或者进行应用前后台切换频率等数据统计。
503
504以[UIAbilityContext](../reference/apis-ability-kit/js-apis-inner-application-uiAbilityContext.md)中的使用为例进行说明。
505
506```ts
507import { UIAbility, ApplicationStateChangeCallback } from '@kit.AbilityKit';
508import { BusinessError } from '@kit.BasicServicesKit';
509
510export default class LifecycleAbility extends UIAbility {
511  onCreate() {
512    let applicationStateChangeCallback: ApplicationStateChangeCallback = {
513      onApplicationForeground() {
514        console.info('applicationStateChangeCallback onApplicationForeground');
515      },
516      onApplicationBackground() {
517        console.info('applicationStateChangeCallback onApplicationBackground');
518      }
519    }
520
521    // 1.获取applicationContext
522    let applicationContext = this.context.getApplicationContext();
523    try {
524      // 2.通过applicationContext注册应用前后台状态监听
525      applicationContext.on('applicationStateChange', applicationStateChangeCallback);
526    } catch (paramError) {
527      console.error(`error: ${(paramError as BusinessError).code}, ${(paramError as BusinessError).message}`);
528    }
529    console.log('Register applicationStateChangeCallback');
530  }
531}
532```
533
534### 监听UIAbility生命周期变化
535
536开发者可以通过[ApplicationContext](../reference/apis-ability-kit/js-apis-inner-application-applicationContext.md)监听UIAbility生命周期变化。当[UIAbility](../reference/apis-ability-kit/js-apis-app-ability-uiAbility.md)生命周期变化时,如UIAbility创建、切换至前台、切换至后台、销毁等情况,UIAbility会收到相应回调函数的通知,从而执行依赖UIAbility生命周期的方法,也可以统计指定页面停留时间和访问频率等信息。
537
538每次注册回调函数时,都会返回一个监听生命周期的ID,此ID会自增1。当超过监听上限数量2^63-1时,会返回-1。以[UIAbilityContext](../reference/apis-ability-kit/js-apis-inner-application-uiAbilityContext.md)中的使用为例进行说明。
539
540```ts
541import { AbilityConstant, AbilityLifecycleCallback, UIAbility, Want } from '@kit.AbilityKit';
542import { hilog } from '@kit.PerformanceAnalysisKit';
543import { window } from '@kit.ArkUI';
544import  { BusinessError } from '@kit.BasicServicesKit';
545
546const TAG: string = '[LifecycleAbility]';
547const DOMAIN_NUMBER: number = 0xFF00;
548
549export default class LifecycleAbility extends UIAbility {
550  // 定义生命周期ID
551  lifecycleId: number = -1;
552
553  onCreate(want: Want, launchParam: AbilityConstant.LaunchParam): void {
554    // 定义生命周期回调对象
555    let abilityLifecycleCallback: AbilityLifecycleCallback = {
556      // 当UIAbility创建时被调用
557      onAbilityCreate(uiAbility) {
558        hilog.info(DOMAIN_NUMBER, TAG, `onAbilityCreate uiAbility.launchWant: ${JSON.stringify(uiAbility.launchWant)}`);
559      },
560      // 当窗口创建时被调用
561      onWindowStageCreate(uiAbility, windowStage: window.WindowStage) {
562        hilog.info(DOMAIN_NUMBER, TAG, `onWindowStageCreate uiAbility.launchWant: ${JSON.stringify(uiAbility.launchWant)}`);
563        hilog.info(DOMAIN_NUMBER, TAG, `onWindowStageCreate windowStage: ${JSON.stringify(windowStage)}`);
564      },
565      // 当窗口处于活动状态时被调用
566      onWindowStageActive(uiAbility, windowStage: window.WindowStage) {
567        hilog.info(DOMAIN_NUMBER, TAG, `onWindowStageActive uiAbility.launchWant: ${JSON.stringify(uiAbility.launchWant)}`);
568        hilog.info(DOMAIN_NUMBER, TAG, `onWindowStageActive windowStage: ${JSON.stringify(windowStage)}`);
569      },
570      // 当窗口处于非活动状态时被调用
571      onWindowStageInactive(uiAbility, windowStage: window.WindowStage) {
572        hilog.info(DOMAIN_NUMBER, TAG, `onWindowStageInactive uiAbility.launchWant: ${JSON.stringify(uiAbility.launchWant)}`);
573        hilog.info(DOMAIN_NUMBER, TAG, `onWindowStageInactive windowStage: ${JSON.stringify(windowStage)}`);
574      },
575      // 当窗口被销毁时被调用
576      onWindowStageDestroy(uiAbility, windowStage: window.WindowStage) {
577        hilog.info(DOMAIN_NUMBER, TAG, `onWindowStageDestroy uiAbility.launchWant: ${JSON.stringify(uiAbility.launchWant)}`);
578        hilog.info(DOMAIN_NUMBER, TAG, `onWindowStageDestroy windowStage: ${JSON.stringify(windowStage)}`);
579      },
580      // 当UIAbility被销毁时被调用
581      onAbilityDestroy(uiAbility) {
582        hilog.info(DOMAIN_NUMBER, TAG, `onAbilityDestroy uiAbility.launchWant: ${JSON.stringify(uiAbility.launchWant)}`);
583      },
584      // 当UIAbility从后台转到前台时触发回调
585      onAbilityForeground(uiAbility) {
586        hilog.info(DOMAIN_NUMBER, TAG, `onAbilityForeground uiAbility.launchWant: ${JSON.stringify(uiAbility.launchWant)}`);
587      },
588      // 当UIAbility从前台转到后台时触发回调
589      onAbilityBackground(uiAbility) {
590        hilog.info(DOMAIN_NUMBER, TAG, `onAbilityBackground uiAbility.launchWant: ${JSON.stringify(uiAbility.launchWant)}`);
591      },
592      // 当UIAbility迁移时被调用
593      onAbilityContinue(uiAbility) {
594        hilog.info(DOMAIN_NUMBER, TAG, `onAbilityContinue uiAbility.launchWant: ${JSON.stringify(uiAbility.launchWant)}`);
595      }
596    };
597    // 获取应用上下文
598    let applicationContext = this.context.getApplicationContext();
599    try {
600      // 注册应用内生命周期回调
601      this.lifecycleId = applicationContext.on('abilityLifecycle', abilityLifecycleCallback);
602    } catch (err) {
603      let code = (err as BusinessError).code;
604      let message = (err as BusinessError).message;
605      hilog.error(DOMAIN_NUMBER, TAG, `Failed to register applicationContext. Code is ${code}, message is ${message}`);
606    }
607
608    hilog.info(DOMAIN_NUMBER, TAG, `register callback number: ${this.lifecycleId}`);
609  }
610  //...
611  onDestroy(): void {
612    // 获取应用上下文
613    let applicationContext = this.context.getApplicationContext();
614    try {
615      // 取消应用内生命周期回调
616      applicationContext.off('abilityLifecycle', this.lifecycleId);
617    } catch (err) {
618      let code = (err as BusinessError).code;
619      let message = (err as BusinessError).message;
620      hilog.error(DOMAIN_NUMBER, TAG, `Failed to unregister applicationContext. Code is ${code}, message is ${message}`);
621    }
622  }
623}
624```