• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# getContext
2
3如果需要在页面中获得当前Ability的Context，可调用getContext接口获取当前页面关联的UIAbilityContext或ExtensionContext。
4
5> **说明：**
6> - 该接口从API version 9开始支持。
7> - 该接口仅限Stage模型使用。
8
9## getContext
10getContext(component?: Object):Context
11
12获取与页面上下文组件关联的Context对象。
13
14**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。
15
16**系统能力：** SystemCapability.ArkUI.ArkUI.Full
17
18**参数：**
19
20| 参数名 | 类型          | 必填 | 说明                             |
21| ------ | ----------- | ---- | ------------------------------- |
22| component  | Object | 否   | 当前自定义组件的实例。未传入component或传入的参数类型非法，则返回默认上下文。默认上下文是指通过追溯当前方法的调用链所跟踪到的Context。在异步调用的回调方法中使用该接口，或者该接口的起始调用不在当前页面，将可能导致无法跟踪到该实例的Context，则会返回undefined。             |
23
24**返回值：**
25
26| 类型 | 说明                             |
27| ------ | ------------------------------- |
28| [Context](../../application-models/application-context-stage.md#应用上下文context)  | 返回当前组件所在Ability的Context，Context的具体类型为当前Ability关联的Context对象。例如：在UIAbility窗口中的页面调用该接口，返回类型为UIAbilityContext。在ExtensionAbility窗口中的页面调用该接口，返回类型为ExtensionContext。    |
29
30**示例：**
31
32在UIAbility中通过windowStage.loadContent加载具体页面。
33
34> **说明：**
35>
36> 直接使用getContext可能导致实例不明确的问题，建议使用[getUIContext](js-apis-arkui-UIContext.md#uicontext)获取UIContext实例，并使用[getHostContext](js-apis-arkui-UIContext.md#gethostcontext12)调用绑定实例的getContext。
37
38```ts
39// EntryAbility.ets
40import { UIAbility, AbilityConstant, Want } from '@kit.AbilityKit';
41import { hilog } from '@kit.PerformanceAnalysisKit';
42import { window } from '@kit.ArkUI';
43
44export default class EntryAbility extends UIAbility {
45  onCreate(want: Want, launchParam: AbilityConstant.LaunchParam) {
46    hilog.info(0x0000, 'testTag', '%{public}s', 'Ability onCreate');
47  }
48
49  onDestroy() {
50    hilog.info(0x0000, 'testTag', '%{public}s', 'Ability onDestroy');
51  }
52
53  onWindowStageCreate(windowStage: window.WindowStage) {
54    hilog.info(0x0000, 'testTag', '%{public}s', 'Ability onWindowStageCreate');
55
56    windowStage.loadContent('pages/Index', (err, data) => {
57      if (err.code) {
58        hilog.error(0x0000, 'testTag', 'Failed to load the content. Cause: %{public}s', JSON.stringify(err) ?? '');
59        return;
60      }
61      hilog.info(0x0000, 'testTag', 'Succeeded in loading the content. Data: %{public}s', JSON.stringify(data) ?? '');
62    });
63  }
64
65  onWindowStageDestroy() {
66    hilog.info(0x0000, 'testTag', '%{public}s', 'Ability onWindowStageDestroy');
67  }
68
69  onForeground() {
70    hilog.info(0x0000, 'testTag', '%{public}s', 'Ability onForeground');
71  }
72
73  onBackground() {
74    hilog.info(0x0000, 'testTag', '%{public}s', 'Ability onBackground');
75  }
76}
77```
78在具体的Index.ets中可以通过getContext接口获取Context上下文，本示例返回的Context类型为UIAbilityContext。
79
80```ts
81//pages/Index.ets
82@Entry
83@Component
84struct Index {
85  @State message: string = 'Hello World'
86
87  build() {
88    Row() {
89      Column() {
90        Text(this.message)
91          .fontSize(50)
92          .fontWeight(FontWeight.Bold)
93          .onClick(() => {
94            // 建议使用this.getUIContext().getHostContext()
95            let context : Context = getContext(this) as Context
96            console.info("CacheDir:" + context.cacheDir)
97          })
98      }
99      .width('100%')
100    }
101    .height('100%')
102  }
103}
104```
105