【鸿蒙开发】第二十九章 Stage模型-应用上下文Context、进程、线程

目录

1 Stage模型基本概念

1.1 开发流程

 3 应用上下文Context的典型使用场景

3.1 获取应用文件路径

3.2 获取和修改加密分区

 3.3 获取本应用中其他Module的Context

3.4 订阅进程内UIAbility生命周期变化

4 进程

4.1 概述

5 线程

5.1 线程类型

5.2 使用EventHub进行线程内通信

---

1 Stage模型基本概念

图1 Stage模型概念图

• AbilityStage

  每个Entry类型或者Feature类型的HAP在运行期都有一个AbilityStage类实例，当HAP中的代码首次被加载到进程中的时候，系统会先创建AbilityStage实例。

• UIAbility组件和ExtensionAbility组件

  Stage模型提供UIAbility和ExtensionAbility两种类型的组件，这两种组件都有具体的类承载，支持面向对象的开发方式。

  • UIAbility组件是一种包含UI的应用组件，主要用于和用户交互。例如，图库类应用可以在UIAbility组件中展示图片瀑布流，在用户选择某个图片后，在新的页面中展示图片的详细内容。同时用户可以通过返回键返回到瀑布流页面。UIAbility组件的生命周期只包含创建/销毁/前台/后台等状态，与显示相关的状态通过WindowStage的事件暴露给开发者。

  • ExtensionAbility组件是一种面向特定场景的应用组件。开发者并不直接从ExtensionAbility组件派生，而是需要使用ExtensionAbility组件的派生类。目前ExtensionAbility组件有用于卡片场景的FormExtensionAbility，用于输入法场景的InputMethodExtensionAbility，用于闲时任务场景的WorkSchedulerExtensionAbility等多种派生类，这些派生类都是基于特定场景提供的。例如，用户在桌面创建应用的卡片，需要应用开发者从FormExtensionAbility派生，实现其中的回调函数，并在配置文件中配置该能力。ExtensionAbility组件的派生类实例由用户触发创建，并由系统管理生命周期。在Stage模型上，三方应用开发者不能开发自定义服务，而需要根据自身的业务场景通过ExtensionAbility组件的派生类来实现。

• WindowStage

  每个UIAbility实例都会与一个WindowStage类实例绑定，该类起到了应用进程内窗口管理器的作用。它包含一个主窗口。也就是说UIAbility实例通过WindowStage持有了一个主窗口，该主窗口为ArkUI提供了绘制区域。

• Context

  在Stage模型上，Context及其派生类向开发者提供在运行期可以调用的各种资源和能力。UIAbility组件和各种ExtensionAbility组件的派生类都有各自不同的Context类，他们都继承自基类Context，但是各自又根据所属组件，提供不同的能力。

1.1 开发流程

基于Stage模型开发应用时，在应用模型部分，涉及如下开发过程。

表1 Stage模型开发流程

任务	简介	相关指导
应用组件开发	本章节介绍了如何使用Stage模型的UIAbility组件和ExtensionAbility组件开发应用。	- 应用/组件级配置 - UIAbility组件 - ExtensionAbility组件 - AbilityStage组件容器 - 应用上下文Context - 组件启动规则
了解进程模型	本章节介绍了Stage模型的进程模型以及几种常用的进程间通信方式。	进程模型概述
了解线程模型	本章节介绍了Stage模型的线程模型以及几种常用的线程间通信方式。	线程模型概述
应用配置文件	本章节介绍Stage模型中应用配置文件的开发要求。

Context是应用中对象的上下文，其提供了应用的一些基础信息，例如resourceManager（资源管理）、applicationInfo（当前应用信息）、dir（应用文件路径）、area（文件分区）等，以及应用的一些基本方法，例如createBundleContext()、getApplicationContext()等。UIAbility组件和各种ExtensionAbility派生类组件都有各自不同的Context类。分别有基类Context、ApplicationContext、AbilityStageContext、UIAbilityContext、ExtensionContext、ServiceExtensionContext等Context。

• 各类Context的继承关系

  

• 各类Context的持有关系

  

• 各类Context的获取方式

  • 获取UIAbilityContext。每个UIAbility中都包含了一个Context属性，提供操作应用组件、获取应用组件的配置信息等能力。

import { UIAbility, AbilityConstant, Want } from '@kit.AbilityKit';export default class EntryAbility extends UIAbility {onCreate(want: Want, launchParam: AbilityConstant.LaunchParam): void {let uiAbilityContext = this.context;//...}
}

•          获取特定场景ExtensionContext。以ServiceExtensionContext为例，表示后台服务的上下文环境，继承自ExtensionContext，提供后台服务相关的接口能力。

import { ServiceExtensionAbility, Want } from '@kit.AbilityKit';export default class ServiceExtAbility extends ServiceExtensionAbility {onCreate(want: Want) {let serviceExtensionContext = this.context;//...}
}

•          获取AbilityStageContext（Module级别的Context）。和基类Context相比，额外提供HapModuleInfo、Configuration等信息。

import { AbilityStage } from '@kit.AbilityKit';export default class MyAbilityStage extends AbilityStage {onCreate(): void {let abilityStageContext = this.context;//...}
}

•          获取ApplicationContext（应用级别的Context）。ApplicationContext在基类Context的基础上提供了订阅应用内应用组件的生命周期的变化、订阅系统内存变化、订阅应用内系统环境变化、设置应用语言、设置应用颜色模式、清除应用自身数据的同时撤销应用向用户申请的权限等能力，在UIAbility、ExtensionAbility、AbilityStage中均可以获取。

import { UIAbility, AbilityConstant, Want } from '@kit.AbilityKit';export default class EntryAbility extends UIAbility {onCreate(want: Want, launchParam: AbilityConstant.LaunchParam): void {let applicationContext = this.context.getApplicationContext();//...}
}

 3 应用上下文Context的典型使用场景

本章节通过如下典型场景来介绍Context的用法：

• 获取应用文件路径
• 获取和修改加密分区
• 获取本应用中其他module的context
• 订阅进程内UIAbility生命周期变化

3.1 获取应用文件路径

基类Context提供了获取应用文件路径的能力，ApplicationContext、AbilityStageContext、UIAbilityContext和ExtensionContext均继承该能力。不同类型的Context获取的路径可能存在差异。

• 通过ApplicationContext可以获取应用级的文件路径。该路径用于存放应用全局信息，路径下的文件会跟随应用的卸载而删除。

• 通过AbilityStageContext、UIAbilityContext、ExtensionContext，可以获取Module级的文件路径。该路径用于存放Module相关信息，路径下的文件会跟随HAP/HSP的卸载而删除。HAP/HSP的卸载不会影响应用级路径下的文件，除非该应用的HAP/HSP已全部卸载。

  • UIAbilityContext：可以获取UIAbility所在Module的文件路径。
  • ExtensionContext：可以获取ExtensionAbility所在Module的文件路径。
  • AbilityStageContext：由于AbilityStageContext创建时机早于UIAbilityContext和ExtensionContext，通常用于在AbilityStage中获取文件路径。

说明

应用文件路径属于应用沙箱路径，具体请参见应用沙箱目录。

表1 不同级别Context获取的应用文件路径说明

属性	说明	ApplicationContext获取的路径	AbilityStageContext、UIAbilityContext、ExtensionContext获取的路径
bundleCodeDir	安装包目录。	<路径前缀>/el1/bundle	<路径前缀>/el1/bundle
cacheDir	缓存目录。	<路径前缀>/<加密等级>/base/cache	<路径前缀>/<加密等级>/base/haps/<module-name>/cache
filesDir	文件目录。	<路径前缀>/<加密等级>/base/files	<路径前缀>/<加密等级>/base/haps/<module-name>/files
preferencesDir	preferences目录。	<路径前缀>/<加密等级>/base/preferences	<路径前缀>/<加密等级>/base/haps/<module-name>/preferences
tempDir	临时目录。	<路径前缀>/<加密等级>/base/temp	<路径前缀>/<加密等级>/base/haps/<module-name>/temp
databaseDir	数据库目录。	<路径前缀>/<加密等级>/database	<路径前缀>/<加密等级>/database/<module-name>
distributedFilesDir	分布式文件目录。	<路径前缀>/el2/distributedFiles	<路径前缀>/el2/distributedFiles/
resourceDir11+	资源目录。 说明： 需要开发者手动在\<module-name>\resource路径下创建resfile目录。	不涉及	<路径前缀>/el1/bundle/<module-name>/resources/resfile
cloudFileDir12+	云文件目录。	<路径前缀>/el2/cloud	<路径前缀>/el2/cloud/

本节以使用ApplicationContext获取filesDir为例，介绍如何获取应用文件路径，并在对应文件路径下新建文件和读写文件。示例代码如下：

import { common } from '@kit.AbilityKit';
import { buffer } from '@kit.ArkTS';
import { fileIo, ReadOptions } from '@kit.CoreFileKit';
import { hilog } from '@kit.PerformanceAnalysisKit';const TAG: string = '[Page_Context]';
const DOMAIN_NUMBER: number = 0xFF00;@Entry
@Component
struct Index {@State message: string = 'Hello World';private context = getContext(this) as common.UIAbilityContext;build() {Row() {Column() {Text(this.message)// ...Button() {Text('create file')// ....onClick(() => {let applicationContext = this.context.getApplicationContext();// 获取应用文件路径let filesDir = applicationContext.filesDir;hilog.info(DOMAIN_NUMBER, TAG, `filePath: ${filesDir}`);// 文件不存在时创建并打开文件，文件存在时打开文件let file = fileIo.openSync(filesDir + '/test.txt', fileIo.OpenMode.READ_WRITE | fileIo.OpenMode.CREATE);// 写入一段内容至文件let writeLen = fileIo.writeSync(file.fd, "Try to write str.");hilog.info(DOMAIN_NUMBER, TAG, `The length of str is: ${writeLen}`);// 创建一个大小为1024字节的ArrayBuffer对象，用于存储从文件中读取的数据let arrayBuffer = new ArrayBuffer(1024);// 设置读取的偏移量和长度let readOptions: ReadOptions = {offset: 0,length: arrayBuffer.byteLength};// 读取文件内容到ArrayBuffer对象中，并返回实际读取的字节数let readLen = fileIo.readSync(file.fd, arrayBuffer, readOptions);// 将ArrayBuffer对象转换为Buffer对象，并转换为字符串输出let buf = buffer.from(arrayBuffer, 0, readLen);hilog.info(DOMAIN_NUMBER, TAG, `the content of file: ${buf.toString()}`);// 关闭文件fileIo.closeSync(file);})}// ...}// ...}// ...}
}

3.2 获取和修改加密分区

应用文件加密是一种保护数据安全的方法，可以使得文件在未经授权访问的情况下得到保护。在不同的场景下，应用需要不同程度的文件保护。

在实际应用中，开发者需要根据不同场景的需求选择合适的加密分区，从而保护应用数据的安全。通过合理使用不同级别的加密分区，可以有效提高应用数据的安全性。关于不同分区的权限说明，详见ContextConstant的AreaMode。

• EL1：对于私有文件，如闹铃、壁纸等，应用可以将这些文件放到设备级加密分区（EL1）中，以保证在用户输入密码前就可以被访问。
• EL2：对于更敏感的文件，如个人隐私信息等，应用可以将这些文件放到更高级别的加密分区（EL2）中，以保证更高的安全性。
• EL3：对于应用中的记录步数、文件下载、音乐播放，需要在锁屏时读写和创建新文件，放在（EL3）的加密分区比较合适。
• EL4：对于用户安全信息相关的文件，锁屏时不需要读写文件、也不能创建文件，放在（EL4）的加密分区更合适。
• EL5：对于用户隐私敏感数据文件，锁屏后默认不可读写，如果锁屏后需要读写文件，则锁屏前可以调用Access接口申请继续读写文件，或者锁屏后也需要创建新文件且可读写，放在（EL5）的应用级加密分区更合适。

要实现获取和设置当前加密分区，可以通过读写Context的area属性来实现。

// EntryAbility.ets
import { UIAbility, contextConstant, AbilityConstant, Want } from '@kit.AbilityKit';export default class EntryAbility extends UIAbility {onCreate(want: Want, launchParam: AbilityConstant.LaunchParam) {// 存储普通信息前，切换到EL1设备级加密this.context.area = contextConstant.AreaMode.EL1; // 切换area// 存储普通信息// 存储敏感信息前，切换到EL2用户级加密this.context.area = contextConstant.AreaMode.EL2; // 切换area// 存储敏感信息// 存储敏感信息前，切换到EL3用户级加密this.context.area = contextConstant.AreaMode.EL3; // 切换area// 存储敏感信息// 存储敏感信息前，切换到EL4用户级加密this.context.area = contextConstant.AreaMode.EL4; // 切换area// 存储敏感信息// 存储敏感信息前，切换到EL5应用级加密this.context.area = contextConstant.AreaMode.EL5; // 切换area// 存储敏感信息}
}

// Index.ets
import { contextConstant, common } from '@kit.AbilityKit';
import { promptAction } from '@kit.ArkUI';@Entry
@Component
struct Page_Context {private context = getContext(this) as common.UIAbilityContext;build() {Column() {//...List({ initialIndex: 0 }) {//...ListItem() {Row() {//...}.onClick(() => {// 存储普通信息前，切换到EL1设备级加密if (this.context.area === contextConstant.AreaMode.EL2) { // 获取areathis.context.area = contextConstant.AreaMode.EL1; // 修改areapromptAction.showToast({message: 'SwitchToEL1'});}// 存储普通信息})}//...ListItem() {Row() {//...}.onClick(() => {// 存储敏感信息前，切换到EL2用户级加密if (this.context.area === contextConstant.AreaMode.EL1) { // 获取areathis.context.area = contextConstant.AreaMode.EL2; // 修改areapromptAction.showToast({message: 'SwitchToEL2'});}// 存储敏感信息})}//...}//...}//...}
}

 3.3 获取本应用中其他Module的Context

调用createModuleContext(context: Context, moduleName: string)方法，获取本应用中其他Module的Context。获取到其他Module的Context之后，即可获取到相应Module的资源信息。

import { common, application } from '@kit.AbilityKit';
import { promptAction } from '@kit.ArkUI';
import { BusinessError } from '@kit.BasicServicesKit';let storageEventCall = new LocalStorage();@Entry(storageEventCall)
@Component
struct Page_Context {private context = getContext(this) as common.UIAbilityContext;build() {Column() {//...List({ initialIndex: 0 }) {ListItem() {Row() {//...}.onClick(() => {let moduleName2: string = 'entry';application.createModuleContext(this.context, moduleName2).then((data: common.Context) => {console.info(`CreateModuleContext success, data: ${JSON.stringify(data)}`);if (data !== null) {promptAction.showToast({message: ('成功获取Context')});}}).catch((err: BusinessError) => {console.error(`CeateMudleContext failed, err code:${err.code}, err msg: ${err.message}`);});})}//...}//...}//...}
}

3.4 订阅进程内UIAbility生命周期变化

在应用内的DFX统计场景中，如需要统计对应页面停留时间和访问频率等信息，可以使用订阅进程内UIAbility生命周期变化功能。

通过ApplicationContext提供的能力，可以订阅进程内UIAbility生命周期变化。当进程内的UIAbility生命周期变化时，如创建、可见/不可见、获焦/失焦、销毁等，会触发相应的回调函数。每次注册回调函数时，都会返回一个监听生命周期的ID，此ID会自增+1。当超过监听上限数量2^63-1时，会返回-1。以UIAbilityContext中的使用为例进行说明。

import { AbilityConstant, AbilityLifecycleCallback, UIAbility, Want } from '@kit.AbilityKit';
import { hilog } from '@kit.PerformanceAnalysisKit';
import { window } from '@kit.ArkUI';
import  { BusinessError } from '@kit.BasicServicesKit';const TAG: string = '[LifecycleAbility]';
const DOMAIN_NUMBER: number = 0xFF00;export default class LifecycleAbility extends UIAbility {// 定义生命周期IDlifecycleId: number = -1;onCreate(want: Want, launchParam: AbilityConstant.LaunchParam): void {// 定义生命周期回调对象let abilityLifecycleCallback: AbilityLifecycleCallback = {// 当UIAbility创建时被调用onAbilityCreate(uiAbility) {hilog.info(DOMAIN_NUMBER, TAG, `onAbilityCreate uiAbility.launchWant: ${JSON.stringify(uiAbility.launchWant)}`);},// 当窗口创建时被调用onWindowStageCreate(uiAbility, windowStage: window.WindowStage) {hilog.info(DOMAIN_NUMBER, TAG, `onWindowStageCreate uiAbility.launchWant: ${JSON.stringify(uiAbility.launchWant)}`);hilog.info(DOMAIN_NUMBER, TAG, `onWindowStageCreate windowStage: ${JSON.stringify(windowStage)}`);},// 当窗口处于活动状态时被调用onWindowStageActive(uiAbility, windowStage: window.WindowStage) {hilog.info(DOMAIN_NUMBER, TAG, `onWindowStageActive uiAbility.launchWant: ${JSON.stringify(uiAbility.launchWant)}`);hilog.info(DOMAIN_NUMBER, TAG, `onWindowStageActive windowStage: ${JSON.stringify(windowStage)}`);},// 当窗口处于非活动状态时被调用onWindowStageInactive(uiAbility, windowStage: window.WindowStage) {hilog.info(DOMAIN_NUMBER, TAG, `onWindowStageInactive uiAbility.launchWant: ${JSON.stringify(uiAbility.launchWant)}`);hilog.info(DOMAIN_NUMBER, TAG, `onWindowStageInactive windowStage: ${JSON.stringify(windowStage)}`);},// 当窗口被销毁时被调用onWindowStageDestroy(uiAbility, windowStage: window.WindowStage) {hilog.info(DOMAIN_NUMBER, TAG, `onWindowStageDestroy uiAbility.launchWant: ${JSON.stringify(uiAbility.launchWant)}`);hilog.info(DOMAIN_NUMBER, TAG, `onWindowStageDestroy windowStage: ${JSON.stringify(windowStage)}`);},// 当UIAbility被销毁时被调用onAbilityDestroy(uiAbility) {hilog.info(DOMAIN_NUMBER, TAG, `onAbilityDestroy uiAbility.launchWant: ${JSON.stringify(uiAbility.launchWant)}`);},// 当UIAbility从后台转到前台时触发回调onAbilityForeground(uiAbility) {hilog.info(DOMAIN_NUMBER, TAG, `onAbilityForeground uiAbility.launchWant: ${JSON.stringify(uiAbility.launchWant)}`);},// 当UIAbility从前台转到后台时触发回调onAbilityBackground(uiAbility) {hilog.info(DOMAIN_NUMBER, TAG, `onAbilityBackground uiAbility.launchWant: ${JSON.stringify(uiAbility.launchWant)}`);},// 当UIAbility迁移时被调用onAbilityContinue(uiAbility) {hilog.info(DOMAIN_NUMBER, TAG, `onAbilityContinue uiAbility.launchWant: ${JSON.stringify(uiAbility.launchWant)}`);}};// 获取应用上下文let applicationContext = this.context.getApplicationContext();try {// 注册应用内生命周期回调this.lifecycleId = applicationContext.on('abilityLifecycle', abilityLifecycleCallback);} catch (err) {let code = (err as BusinessError).code;let message = (err as BusinessError).message;hilog.error(DOMAIN_NUMBER, TAG, `Failed to register applicationContext. Code is ${code}, message is ${message}`);}hilog.info(DOMAIN_NUMBER, TAG, `register callback number: ${this.lifecycleId}`);}//...onDestroy(): void {// 获取应用上下文let applicationContext = this.context.getApplicationContext();try {// 取消应用内生命周期回调applicationContext.off('abilityLifecycle', this.lifecycleId);} catch (err) {let code = (err as BusinessError).code;let message = (err as BusinessError).message;hilog.error(DOMAIN_NUMBER, TAG, `Failed to unregister applicationContext. Code is ${code}, message is ${message}`);}}
}

4 进程

4.1 概述

进程是系统进行资源分配的基本单位，是操作系统结构的基础。系统的进程模型如下图所示。

• 通常情况下，应用中（同一Bundle名称）的所有UIAbility均是运行在同一个独立进程（主进程）中，如下图中绿色部分的“Main Process”。
• 应用中（同一Bundle名称）的所有同一类型ExtensionAbility均是运行在一个独立进程中，如下图中蓝色部分的“FormExtensionAbility Process”、“InputMethodExtensionAbility Process”、其他ExtensionAbility Process。
• WebView拥有独立的渲染进程，如下图中黄色部分的“Render Process”。

说明

仅2in1设备支持将HAP和UIAbility设置为独立进程，设置方法如下：

• 如果需要指定某个HAP运行在独立进程中，可以在module.json5文件中将isolationMode字段配置为isolationOnly（只在独立进程中运行）或者isolationFirst（优先在独立进程中运行）。
• 如果需要指定某个UIAbility运行在独立进程中，可以在module.json5文件中将isolationProcess字段配置为true，同时需要在onNewProcessRequest回调中返回一个唯一的进程标识符。

图1 进程模型示意图

说明：

• 仅系统应用支持构建ServiceExtensionAbility和DataShareExtensionAbility。
• 执行hdc shell命令，进入设备的shell命令行。在shell命令行中，执行ps -ef命令，可以查看所有正在运行的进程信息。

在上述模型基础上，对于系统应用可以通过申请多进程权限（如下图所示），为指定HAP配置一个自定义进程名，该HAP中的UIAbility就会运行在自定义进程中。不同的HAP可以通过配置module.json5中的process属性，使HAP运行在不同进程中。

图2 多进程示意图

基于当前的进程模型，针对应用间和应用内存在多个进程的情况，系统提供了如下进程间通信机制：

公共事件机制：多用于一对多的通信场景，公共事件发布者可能存在多个订阅者同时接收事件。

5 线程

线程是操作系统进行运算调度的基本单位，是进程中的执行流，共享进程的资源。一个进程可以包含多个线程。

5.1 线程类型

Stage模型下的线程主要有如下三类：

• 主线程

  • 执行UI绘制。
  • 管理主线程的ArkTS引擎实例，使多个UIAbility组件能够运行在其之上。
  • 管理其他线程的ArkTS引擎实例，例如使用TaskPool（任务池）创建任务或取消任务、启动和终止Worker线程。
  • 分发交互事件。
  • 处理应用代码的回调，包括事件处理和生命周期管理。
  • 接收TaskPool以及Worker线程发送的消息。

• TaskPool Worker线程
  • 用于执行耗时操作，支持设置调度优先级、负载均衡等功能，推荐使用。
• Worker线程

  • 用于执行耗时操作，支持线程间通信。

    TaskPool与Worker的运作机制、通信手段和使用方法可以参考TaskPool和Worker的对比。

    

说明

• TaskPool自行管理线程数量，其生命周期由TaskPool统一管理。Worker线程的生命周期由开发者自行维护。
• 同一线程中存在多个组件，例如UIAbility组件和UI组件都存在于主线程中。在Stage模型中目前主要使用EventHub进行数据通信。
• 执行hdc shell命令，进入设备的shell命令行。在shell命令行中，执行ps -p <pid> -T命令，可以查看指定应用进程的线程信息。其中，<pid>为需要指定的应用进程的进程ID。

5.2 使用EventHub进行线程内通信

EventHub提供了线程内发送和处理事件的能力，包括对事件订阅、取消订阅、触发事件等。以UIAbility组件与UI之间的数据同步为例，具体使用方法可以参考UIAbility组件与UI的数据同步。