1# 应用上下文Context 2 3 4## 概述 5 6[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)（当前应用信息）、[dir](../reference/apis-ability-kit/js-apis-inner-application-context.md#属性)（应用文件路径）、[area](../reference/apis-ability-kit/js-apis-app-ability-contextConstant.md#areamode)（文件分区）等，以及应用的一些基本方法，例如createBundleContext()、[getApplicationContext()](../reference/apis-ability-kit/js-apis-inner-application-context.md#contextgetapplicationcontext)等。[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)、ServiceExtensionContext等Context。 7 8- 各类Context的继承关系 9  10 11- 各类Context的持有关系 12  13 14- 各类Context的获取方式 15 - 获取[UIAbilityContext](../reference/apis-ability-kit/js-apis-inner-application-uiAbilityContext.md)。每个[UIAbility](../reference/apis-ability-kit/js-apis-app-ability-uiAbility.md)中都包含了一个Context属性，提供操作应用组件、获取应用组件的配置信息等能力。 16 17 ```ts 18 import { UIAbility, AbilityConstant, Want } from '@kit.AbilityKit'; 19 20 export default class EntryAbility extends UIAbility { 21 onCreate(want: Want, launchParam: AbilityConstant.LaunchParam): void { 22 let uiAbilityContext = this.context; 23 //... 24 } 25 } 26 ``` 27 28 > **说明：** 29 > 30 > 页面中获取UIAbility实例的上下文信息请参见[获取UIAbility的上下文信息](uiability-usage.md#获取uiability的上下文信息)。 31 - 获取特定场景[ExtensionContext](../reference/apis-ability-kit/js-apis-inner-application-extensionContext.md)。以ServiceExtensionContext为例，表示后台服务的上下文环境，继承自ExtensionContext，提供后台服务相关的接口能力。 32 33 ```ts 34 import { ServiceExtensionAbility, Want } from '@kit.AbilityKit'; 35 36 export default class ServiceExtAbility extends ServiceExtensionAbility { 37 onCreate(want: Want) { 38 let serviceExtensionContext = this.context; 39 //... 40 } 41 } 42 ``` 43 - 获取[AbilityStageContext](../reference/apis-ability-kit/js-apis-inner-application-abilityStageContext.md)（Module级别的Context）。和基类Context相比，额外提供[HapModuleInfo](../reference/apis-ability-kit/js-apis-inner-application-abilityStageContext.md#属性)、[Configuration](../reference/apis-ability-kit/js-apis-inner-application-abilityStageContext.md#属性)等信息。 44 45 ```ts 46 import { AbilityStage } from '@kit.AbilityKit'; 47 48 export default class MyAbilityStage extends AbilityStage { 49 onCreate(): void { 50 let abilityStageContext = this.context; 51 //... 52 } 53 } 54 ``` 55 - 获取[ApplicationContext](../reference/apis-ability-kit/js-apis-inner-application-applicationContext.md)（应用级别的Context）。ApplicationContext在基类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)中均可以获取。 56 57 ```ts 58 import { UIAbility, AbilityConstant, Want } from '@kit.AbilityKit'; 59 60 export default class EntryAbility extends UIAbility { 61 onCreate(want: Want, launchParam: AbilityConstant.LaunchParam): void { 62 let applicationContext = this.context.getApplicationContext(); 63 //... 64 } 65 } 66 ``` 67 68 69## Context的典型使用场景 70 71 72本章节通过如下典型场景来介绍Context的用法： 73 74- [获取应用文件路径](#获取应用文件路径) 75- [获取和修改加密分区](#获取和修改加密分区) 76- [获取本应用中其他module的context](#获取本应用中其他module的context) 77- [订阅进程内UIAbility生命周期变化](#订阅进程内uiability生命周期变化) 78 79 80### 获取应用文件路径 81 82[基类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)均继承该能力。应用文件路径属于应用沙箱路径，具体请参见[应用沙箱目录](../file-management/app-sandbox-directory.md)。 83 84上述各类Context获取的应用文件路径有所不同。 85 86- 通过[ApplicationContext](../reference/apis-ability-kit/js-apis-inner-application-applicationContext.md)获取应用级别的应用文件路径，此路径是应用全局信息推荐的存放路径，这些文件会跟随应用的卸载而删除。 87 88 | 属性 | 路径 | 89 | -------- | -------- | 90 | bundleCodeDir | <路径前缀>/el1/bundle | 91 | cacheDir | <路径前缀>/<加密等级>/base/cache | 92 | filesDir | <路径前缀>/<加密等级>/base/files | 93 | preferencesDir | <路径前缀>/<加密等级>/base/preferences | 94 | tempDir | <路径前缀>/<加密等级>/base/temp | 95 | databaseDir | <路径前缀>/<加密等级>/database | 96 | distributedFilesDir | <路径前缀>/el2/distributedFiles | 97 | cloudFileDir<sup>12+</sup> | <路径前缀>/el2/cloud | 98 99 示例代码如下所示。 100 101 ```ts 102 import { common } from '@kit.AbilityKit'; 103 import { hilog } from '@kit.PerformanceAnalysisKit'; 104 import { promptAction } from '@kit.ArkUI'; 105 106 const TAG: string = '[Page_Context]'; 107 const DOMAIN_NUMBER: number = 0xFF00; 108 109 @Entry 110 @Component 111 struct Page_Context { 112 private context = getContext(this) as common.UIAbilityContext; 113 114 build() { 115 Column() { 116 //... 117 List({ initialIndex: 0 }) { 118 ListItem() { 119 Row() { 120 //... 121 } 122 .onClick(() => { 123 let applicationContext = this.context.getApplicationContext(); 124 let cacheDir = applicationContext.cacheDir; 125 let tempDir = applicationContext.tempDir; 126 let filesDir = applicationContext.filesDir; 127 let databaseDir = applicationContext.databaseDir; 128 let bundleCodeDir = applicationContext.bundleCodeDir; 129 let distributedFilesDir = applicationContext.distributedFilesDir; 130 let preferencesDir = applicationContext.preferencesDir; 131 let cloudFileDir = applicationContext.cloudFileDir; 132 // 获取应用文件路径 133 let filePath = tempDir + 'test.txt'; 134 hilog.info(DOMAIN_NUMBER, TAG, `filePath: ${filePath}`); 135 if (filePath !== null) { 136 promptAction.showToast({ 137 message: filePath 138 }); 139 } 140 }) 141 } 142 //... 143 } 144 //... 145 } 146 //... 147 } 148 } 149 ``` 150 151- 通过[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)获取[HAP](../quick-start/hap-package.md)级别的应用文件路径。此路径是HAP相关信息推荐的存放路径，这些文件会跟随HAP的卸载而删除，但不会影响应用级别路径的文件，除非该应用的HAP已全部卸载。 152 153 | 属性 | 路径 | 154 | -------- | -------- | 155 | bundleCodeDir | <路径前缀>/el1/bundle | 156 | cacheDir | <路径前缀>/<加密等级>/base/**haps/\<module-name>**/cache | 157 | filesDir | <路径前缀>/<加密等级>/base/**haps/\<module-name>**/files | 158 | preferencesDir | <路径前缀>/<加密等级>/base/**haps/\<module-name>**/preferences | 159 | tempDir | <路径前缀>/<加密等级>/base/**haps/\<module-name>**/temp | 160 | databaseDir | <路径前缀>/<加密等级>/database/**\<module-name>** | 161 | distributedFilesDir | <路径前缀>/el2/distributedFiles/**\<module-name>** | 162 | cloudFileDir<sup>12+</sup> | <路径前缀>/el2/cloud/**\<module-name>** | 163 164 示例代码如下所示。 165 166 ```ts 167 import { common } from '@kit.AbilityKit'; 168 import { hilog } from '@kit.PerformanceAnalysisKit'; 169 import { promptAction } from '@kit.ArkUI'; 170 171 const TAG: string = '[Page_Context]'; 172 const DOMAIN_NUMBER: number = 0xFF00; 173 174 @Entry 175 @Component 176 struct Page_Context { 177 private context = getContext(this) as common.UIAbilityContext; 178 179 build() { 180 Column() { 181 //... 182 List({ initialIndex: 0 }) { 183 ListItem() { 184 Row() { 185 //... 186 } 187 .onClick(() => { 188 let cacheDir = this.context.cacheDir; 189 let tempDir = this.context.tempDir; 190 let filesDir = this.context.filesDir; 191 let databaseDir = this.context.databaseDir; 192 let bundleCodeDir = this.context.bundleCodeDir; 193 let distributedFilesDir = this.context.distributedFilesDir; 194 let preferencesDir = this.context.preferencesDir; 195 let cloudFileDir = applicationContext.cloudFileDir; 196 // 获取应用文件路径 197 let filePath = tempDir + 'test.txt'; 198 hilog.info(DOMAIN_NUMBER, TAG, `filePath: ${filePath}`); 199 if (filePath !== null) { 200 promptAction.showToast({ 201 message: filePath 202 }); 203 } 204 }) 205 } 206 //... 207 } 208 //... 209 } 210 //... 211 } 212 } 213 ``` 214 215 216### 获取和修改加密分区 217 218应用文件加密是一种保护数据安全的方法，可以使得文件在未经授权访问的情况下得到保护。在不同的场景下，应用需要不同程度的文件保护。 219 220在实际应用中，开发者需要根据不同场景的需求选择合适的加密分区，从而保护应用数据的安全。通过合理使用不同级别的加密分区，可以有效提高应用数据的安全性。关于不同分区的权限说明，详见[ContextConstant](../reference/apis-ability-kit/js-apis-app-ability-contextConstant.md)的[AreaMode](../reference/apis-ability-kit/js-apis-app-ability-contextConstant.md#areamode)。 221 222- EL1：对于私有文件，如闹铃、壁纸等，应用可以将这些文件放到设备级加密分区（EL1）中，以保证在用户输入密码前就可以被访问。 223- EL2：对于更敏感的文件，如个人隐私信息等，应用可以将这些文件放到更高级别的加密分区（EL2）中，以保证更高的安全性。 224- EL3：对于应用中的记录步数、文件下载、音乐播放，需要在锁屏时读写和创建新文件，放在（EL3）的加密分区比较合适。 225- EL4：对于用户安全信息相关的文件，锁屏时不需要读写文件、也不能创建文件，放在（EL4）的加密分区更合适。 226- EL5：对于用户隐私敏感数据文件，锁屏后默认不可读写，如果锁屏后需要读写文件，则锁屏前可以调用[Access](../reference/apis-ability-kit/js-apis-screenLockFileManager.md#screenlockfilemanageracquireaccess)接口申请继续读写文件，或者锁屏后也需要创建新文件且可读写，放在（EL5）的应用级加密分区更合适。 227 228要实现获取和设置当前加密分区，可以通过读写[Context](../reference/apis-ability-kit/js-apis-inner-application-context.md)的`area`属性来实现。 229```ts 230import { UIAbility, contextConstant, AbilityConstant, Want } from '@kit.AbilityKit'; 231 232export default class EntryAbility extends UIAbility { 233 onCreate(want: Want, launchParam: AbilityConstant.LaunchParam) { 234 // 存储普通信息前，切换到EL1设备级加密 235 this.context.area = contextConstant.AreaMode.EL1; // 切换area 236 // 存储普通信息 237 238 // 存储敏感信息前，切换到EL2用户级加密 239 this.context.area = contextConstant.AreaMode.EL2; // 切换area 240 // 存储敏感信息 241 242 // 存储敏感信息前，切换到EL3用户级加密 243 this.context.area = contextConstant.AreaMode.EL3; // 切换area 244 // 存储敏感信息 245 246 // 存储敏感信息前，切换到EL4用户级加密 247 this.context.area = contextConstant.AreaMode.EL4; // 切换area 248 // 存储敏感信息 249 250 // 存储敏感信息前，切换到EL5应用级加密 251 this.context.area = contextConstant.AreaMode.EL5; // 切换area 252 // 存储敏感信息 253 } 254} 255``` 256```ts 257import { contextConstant, common } from '@kit.AbilityKit'; 258import { promptAction } from '@kit.ArkUI'; 259 260@Entry 261@Component 262struct Page_Context { 263 private context = getContext(this) as common.UIAbilityContext; 264 265 build() { 266 Column() { 267 //... 268 List({ initialIndex: 0 }) { 269 //... 270 ListItem() { 271 Row() { 272 //... 273 } 274 .onClick(() => { 275 // 存储普通信息前，切换到EL1设备级加密 276 if (this.context.area === contextConstant.AreaMode.EL2) { // 获取area 277 this.context.area = contextConstant.AreaMode.EL1; // 修改area 278 promptAction.showToast({ 279 message: 'SwitchToEL1' 280 }); 281 } 282 // 存储普通信息 283 }) 284 } 285 //... 286 ListItem() { 287 Row() { 288 //... 289 } 290 .onClick(() => { 291 // 存储敏感信息前，切换到EL2用户级加密 292 if (this.context.area === contextConstant.AreaMode.EL1) { // 获取area 293 this.context.area = contextConstant.AreaMode.EL2; // 修改area 294 promptAction.showToast({ 295 message: 'SwitchToEL2' 296 }); 297 } 298 // 存储敏感信息 299 }) 300 } 301 //... 302 } 303 //... 304 } 305 //... 306 } 307} 308``` 309 310 311### 获取本应用中其他Module的Context 312 313调用[createModuleContext(context: Context, moduleName: string)](../reference/apis-ability-kit/js-apis-app-ability-application.md#applicationcreatemodulecontext12)方法，获取本应用中其他Module的Context。获取到其他Module的Context之后，即可获取到相应Module的资源信息。 314 315 ```ts 316 import { common, application } from '@kit.AbilityKit'; 317 import { promptAction } from '@kit.ArkUI'; 318 import { BusinessError } from '@kit.BasicServicesKit'; 319 320 let storageEventCall = new LocalStorage(); 321 322 @Entry(storageEventCall) 323 @Component 324 struct Page_Context { 325 private context = getContext(this) as common.UIAbilityContext; 326 327 build() { 328 Column() { 329 //... 330 List({ initialIndex: 0 }) { 331 ListItem() { 332 Row() { 333 //... 334 } 335 .onClick(() => { 336 let moduleName2: string = 'entry'; 337 application.createModuleContext(this.context, moduleName2) 338 .then((data: common.Context) => { 339 console.info(`CreateModuleContext success, data: ${JSON.stringify(data)}`); 340 if (data !== null) { 341 promptAction.showToast({ 342 message: ('成功获取Context') 343 }); 344 } 345 }) 346 .catch((err: BusinessError) => { 347 console.error(`CeateMudleContext failed, err code:${err.code}, err msg: ${err.message}`); 348 }); 349 }) 350 } 351 //... 352 } 353 //... 354 } 355 //... 356 } 357 } 358 ``` 359 360 361### 订阅进程内UIAbility生命周期变化 362 363在应用内的DFX统计场景中，如需要统计对应页面停留时间和访问频率等信息，可以使用订阅进程内[UIAbility](../reference/apis-ability-kit/js-apis-app-ability-uiAbility.md)生命周期变化功能。 364 365通过[ApplicationContext](../reference/apis-ability-kit/js-apis-inner-application-applicationContext.md)提供的能力，可以订阅进程内UIAbility生命周期变化。当进程内的UIAbility生命周期变化时，如创建、可见/不可见、获焦/失焦、销毁等，会触发相应的回调函数。每次注册回调函数时，都会返回一个监听生命周期的ID，此ID会自增+1。当超过监听上限数量2^63-1时，会返回-1。以[UIAbilityContext](../reference/apis-ability-kit/js-apis-inner-application-uiAbilityContext.md)中的使用为例进行说明。 366 367 368```ts 369import { AbilityConstant, AbilityLifecycleCallback, UIAbility, Want } from '@kit.AbilityKit'; 370import { hilog } from '@kit.PerformanceAnalysisKit'; 371import { window } from '@kit.ArkUI'; 372import { BusinessError } from '@kit.BasicServicesKit'; 373 374const TAG: string = '[LifecycleAbility]'; 375const DOMAIN_NUMBER: number = 0xFF00; 376 377export default class LifecycleAbility extends UIAbility { 378 // 定义生命周期ID 379 lifecycleId: number = -1; 380 381 onCreate(want: Want, launchParam: AbilityConstant.LaunchParam): void { 382 // 定义生命周期回调对象 383 let abilityLifecycleCallback: AbilityLifecycleCallback = { 384 // 当UIAbility创建时被调用 385 onAbilityCreate(uiAbility) { 386 hilog.info(DOMAIN_NUMBER, TAG, `onAbilityCreate uiAbility.launchWant: ${JSON.stringify(uiAbility.launchWant)}`); 387 }, 388 // 当窗口创建时被调用 389 onWindowStageCreate(uiAbility, windowStage: window.WindowStage) { 390 hilog.info(DOMAIN_NUMBER, TAG, `onWindowStageCreate uiAbility.launchWant: ${JSON.stringify(uiAbility.launchWant)}`); 391 hilog.info(DOMAIN_NUMBER, TAG, `onWindowStageCreate windowStage: ${JSON.stringify(windowStage)}`); 392 }, 393 // 当窗口处于活动状态时被调用 394 onWindowStageActive(uiAbility, windowStage: window.WindowStage) { 395 hilog.info(DOMAIN_NUMBER, TAG, `onWindowStageActive uiAbility.launchWant: ${JSON.stringify(uiAbility.launchWant)}`); 396 hilog.info(DOMAIN_NUMBER, TAG, `onWindowStageActive windowStage: ${JSON.stringify(windowStage)}`); 397 }, 398 // 当窗口处于非活动状态时被调用 399 onWindowStageInactive(uiAbility, windowStage: window.WindowStage) { 400 hilog.info(DOMAIN_NUMBER, TAG, `onWindowStageInactive uiAbility.launchWant: ${JSON.stringify(uiAbility.launchWant)}`); 401 hilog.info(DOMAIN_NUMBER, TAG, `onWindowStageInactive windowStage: ${JSON.stringify(windowStage)}`); 402 }, 403 // 当窗口被销毁时被调用 404 onWindowStageDestroy(uiAbility, windowStage: window.WindowStage) { 405 hilog.info(DOMAIN_NUMBER, TAG, `onWindowStageDestroy uiAbility.launchWant: ${JSON.stringify(uiAbility.launchWant)}`); 406 hilog.info(DOMAIN_NUMBER, TAG, `onWindowStageDestroy windowStage: ${JSON.stringify(windowStage)}`); 407 }, 408 // 当UIAbility被销毁时被调用 409 onAbilityDestroy(uiAbility) { 410 hilog.info(DOMAIN_NUMBER, TAG, `onAbilityDestroy uiAbility.launchWant: ${JSON.stringify(uiAbility.launchWant)}`); 411 }, 412 // 当UIAbility从后台转到前台时触发回调 413 onAbilityForeground(uiAbility) { 414 hilog.info(DOMAIN_NUMBER, TAG, `onAbilityForeground uiAbility.launchWant: ${JSON.stringify(uiAbility.launchWant)}`); 415 }, 416 // 当UIAbility从前台转到后台时触发回调 417 onAbilityBackground(uiAbility) { 418 hilog.info(DOMAIN_NUMBER, TAG, `onAbilityBackground uiAbility.launchWant: ${JSON.stringify(uiAbility.launchWant)}`); 419 }, 420 // 当UIAbility迁移时被调用 421 onAbilityContinue(uiAbility) { 422 hilog.info(DOMAIN_NUMBER, TAG, `onAbilityContinue uiAbility.launchWant: ${JSON.stringify(uiAbility.launchWant)}`); 423 } 424 }; 425 // 获取应用上下文 426 let applicationContext = this.context.getApplicationContext(); 427 try { 428 // 注册应用内生命周期回调 429 this.lifecycleId = applicationContext.on('abilityLifecycle', abilityLifecycleCallback); 430 } catch (err) { 431 let code = (err as BusinessError).code; 432 let message = (err as BusinessError).message; 433 hilog.error(DOMAIN_NUMBER, TAG, `Failed to register applicationContext. Code is ${code}, message is ${message}`); 434 } 435 436 hilog.info(DOMAIN_NUMBER, TAG, `register callback number: ${this.lifecycleId}`); 437 } 438 //... 439 onDestroy(): void { 440 // 获取应用上下文 441 let applicationContext = this.context.getApplicationContext(); 442 try { 443 // 取消应用内生命周期回调 444 applicationContext.off('abilityLifecycle', this.lifecycleId); 445 } catch (err) { 446 let code = (err as BusinessError).code; 447 let message = (err as BusinessError).message; 448 hilog.error(DOMAIN_NUMBER, TAG, `Failed to unregister applicationContext. Code is ${code}, message is ${message}`); 449 } 450 } 451} 452``` 453
