• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# ExtensionContext
2
3ExtensionContext是Extension的上下文环境,继承自Context。
4
5ExtensionContext模块提供访问特定Extension的资源的能力,对于拓展的Extension,可直接将ExtensionContext作为上下文环境,或者定义一个继承自ExtensionContext的类型作为上下文环境。如:ServiceExtension提供了ServiceExtensionContext,它在ExtensionContext的基础上扩展了启动、停止、绑定、解绑Ability的能力,详见[ServiceExtensionContext](js-apis-inner-application-serviceExtensionContext.md)。
6
7> **说明:**
8>
9>  - 本模块首批接口从API version 9开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
10>  - 本模块接口仅可在Stage模型下使用。
11
12## 导入模块
13
14```ts
15import common from '@ohos.app.ability.common';
16```
17
18## 属性
19
20**系统能力**:SystemCapability.Ability.AbilityRuntime.Core
21
22| 名称 | 类型 | 可读 | 可写 | 说明 |
23| -------- | -------- | -------- | -------- | -------- |
24| currentHapModuleInfo | [HapModuleInfo](js-apis-bundle-HapModuleInfo.md) | 是 | 否 | 所属Hap包的信息。<br>(详见SDK目录下的 `api\bundle\hapModuleInfo.d.ts`)  |
25| config   | [Configuration](js-apis-app-ability-configuration.md) | 是 | 否 | 所属Module的配置信息。<br>(详见SDK目录下的 `api\@ohos.app.ability.Configuration.d.ts`) |
26| extensionAbilityInfo | [ExtensionAbilityInfo](js-apis-bundleManager-extensionAbilityInfo.md) | 是 | 否 | 所属Extension的信息。<br>(详见SDK目录下的 `api\bundle\extensionAbilityInfo.d.ts`) |
27
28## 使用场景
29ExtensionContext主要用于查询所属Extension的信息、Module的配置信息以及Hap包的信息,开发者可根据自身业务需求使用对应的信息。此处以ServiceExtension为例,展示ExtensionContext的一种使用场景。
30
31**场景说明:**
32一个应用为了适配不同性能的设备,提供了highPerformance、midPerformance、lowPerformance三个Module,这三个Module均提供了一个ServiceExtension给entry使用。安装应用时,应用市场会根据设备的性能,选择对应Module的Hap包与entry的Hap包进行打包安装,实际运行应用时,entry将解析ServiceExtensionContext.HapModuleInfo获取Hap包信息,根据不同的Hap包执行不同的业务逻辑。
33
34![Example](figures/zh_cn_image_ExtensionContext_Example.png)
35
36**示例:**
37
38三个Module内都定义一个相同名称的ServiceExtension:
39```ts
40import ServiceExtension from '@ohos.app.ability.ServiceExtensionAbility';
41import Want from '@ohos.application.Want';
42export default class TheServiceExtension extends ServiceExtension {
43    onCreate(want:Want) {
44        console.log('ServiceAbility onCreate, want: ' + want.abilityName);
45        // 通过globalThis传递ExtensionContext给entry
46        globalThis.ExtensionContext = this.context;
47    }
48
49    onRequest(want, startId) {
50        console.log('ServiceAbility onRequest, want: ' + want.abilityName + ', startId: ' + startId);
51    }
52
53    onConnect(want) {
54        console.log('ServiceAbility onConnect, want:' + want.abilityName);
55        return null;
56    }
57
58    onDisconnect(want) {
59        console.log('ServiceAbility onDisconnect, want:' + want.abilityName);
60    }
61
62    onDestroy() {
63        console.log('ServiceAbility onDestroy');
64    }
65};
66```
67
68在entry的MainAbility的onCreate回调内启动ServiceExtension
69```ts
70import Ability from '@ohos.app.ability.Ability';
71export default class MainAbility extends Ability {
72    onCreate(want, launchParam) {
73        console.log('[Demo] MainAbility onCreate');
74        let wantExt = {
75            deviceId: '',
76            bundleName: 'com.example.TheServiceExtension',
77            abilityName: 'TheServiceExtension',
78        };
79        this.context.startServiceExtensionAbility(wantExt);
80    }
81};
82```
83
84在entry内新建一个ServiceModule.ts,专用于执行业务逻辑
85```ts
86export default class ServiceModel {
87    moduleName: string;
88
89    constructor() {}
90
91    executeTask() {
92        if (globalThis.ExtensionContext === undefined) {
93            console.log('ERROR, ServiceExtension does not exist');
94            return;
95        }
96
97        let moduleInfo = globalThis.ExtensionContext.currentHapModuleInfo;
98        this.moduleName = moduleInfo.name;
99        // 根据moduleName执行不同的业务逻辑,实现对不同性能设备的区分
100        switch (this.moduleName) {
101            case 'highPerformance':
102                console.log('This is high performance device.');
103                // 执行对应业务逻辑
104                break;
105            case 'midPerformance':
106                console.log('This is mid performance device.');
107                // 执行对应业务逻辑
108                break;
109            case 'lowPerformance':
110                console.log('This is low performance device.');
111                // 执行对应业务逻辑
112                break;
113            default:
114                console.log('ERROR, invalid moduleName.');
115                break;
116        }
117    }
118};
119```