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