• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# 管理ArkTS卡片生命周期
2<!--Kit: Form Kit-->
3<!--Subsystem: Ability-->
4<!--Owner: @cx983299475-->
5<!--Designer: @xueyulong-->
6<!--Tester: @chenmingze-->
7<!--Adviser: @Brilliantry_Rui-->
8
9创建ArkTS卡片，需实现[FormExtensionAbility](../reference/apis-form-kit/js-apis-app-form-formExtensionAbility.md)生命周期接口。
10
111. 在EntryFormAbility.ets中，导入相关模块。
12    ```ts
13    import { formBindingData, FormExtensionAbility, formInfo, formProvider } from '@kit.FormKit';
14    import { Configuration, Want } from '@kit.AbilityKit';
15    import { BusinessError } from '@kit.BasicServicesKit';
16    import { hilog } from '@kit.PerformanceAnalysisKit';
17    ```
18
192. 在EntryFormAbility.ets中，实现[FormExtensionAbility](../reference/apis-form-kit/js-apis-app-form-formExtensionAbility.md)生命周期接口，其中在onAddForm的入参[want](../reference/apis-ability-kit/js-apis-app-ability-want.md)中可以通过[FormParam](../reference/apis-form-kit/js-apis-app-form-formInfo.md#formparam)取出卡片的相关信息。
20      ```ts
21      const TAG: string = 'EntryFormAbility';
22      const DOMAIN_NUMBER: number = 0xFF00;
23
24      export default class EntryFormAbility extends FormExtensionAbility {
25        onAddForm(want: Want): formBindingData.FormBindingData {
26          hilog.info(DOMAIN_NUMBER, TAG, '[EntryFormAbility] onAddForm');
27          hilog.info(DOMAIN_NUMBER, TAG, want.parameters?.[formInfo.FormParam.NAME_KEY] as string);
28
29          // ...
30          // 卡片使用方创建卡片时触发，提供方需要返回卡片数据绑定类
31          let obj: Record<string, string> = {
32            'title': 'titleOnAddForm',
33            'detail': 'detailOnAddForm'
34          };
35          let formData: formBindingData.FormBindingData = formBindingData.createFormBindingData(obj);
36          return formData;
37        }
38
39        onCastToNormalForm(formId: string): void {
40          // 当前卡片使用方不会涉及该场景，无需实现该回调函数
41          hilog.info(DOMAIN_NUMBER, TAG, '[EntryFormAbility] onCastToNormalForm');
42        }
43
44        onUpdateForm(formId: string): void {
45          // 若卡片支持定时更新/定点更新/卡片使用方主动请求更新功能，则提供方需要重写该方法以支持数据更新
46          hilog.info(DOMAIN_NUMBER, TAG, '[EntryFormAbility] onUpdateForm');
47          let obj: Record<string, string> = {
48            'title': 'titleOnUpdateForm',
49            'detail': 'detailOnUpdateForm'
50          };
51          let formData: formBindingData.FormBindingData = formBindingData.createFormBindingData(obj);
52          formProvider.updateForm(formId, formData).catch((error: BusinessError) => {
53            hilog.info(DOMAIN_NUMBER, TAG, '[EntryFormAbility] updateForm, error:' + JSON.stringify(error));
54          });
55        }
56
57        onChangeFormVisibility(newStatus: Record<string, number>): void {
58          // 卡片使用方发起可见或者不可见通知触发，提供方需要做相应的处理，仅系统应用生效
59          hilog.info(DOMAIN_NUMBER, TAG, '[EntryFormAbility] onChangeFormVisibility');
60        }
61
62        onFormEvent(formId: string, message: string): void {
63          // 若卡片支持触发事件，则需要重写该方法并实现对事件的触发
64          hilog.info(DOMAIN_NUMBER, TAG, '[EntryFormAbility] onFormEvent');
65          // ...
66        }
67
68        onRemoveForm(formId: string): void {
69          // 删除卡片实例数据
70          hilog.info(DOMAIN_NUMBER, TAG, '[EntryFormAbility] onRemoveForm');
71          // 删除之前持久化的卡片实例数据
72          // 此接口请根据实际情况实现，具体请参考：FormExtAbility Stage模型卡片实例
73        }
74
75        onConfigurationUpdate(config: Configuration) {
76          // 当前formExtensionAbility存活时更新系统配置信息时触发的回调。
77          // 需注意：formExtensionAbility创建后10秒内无操作将会被清理。
78          hilog.info(DOMAIN_NUMBER, TAG, '[EntryFormAbility] onConfigurationUpdate:' + JSON.stringify(config));
79        }
80
81        onAcquireFormState(want: Want) {
82          // 卡片提供方接收查询卡片状态通知接口，默认返回卡片初始状态。
83          return formInfo.FormState.READY;
84        }
85      }
86      ```
87
88> **说明：**
89>
90> FormExtensionAbility进程不能常驻后台，即在卡片生命周期回调函数中无法处理长时间的任务，在生命周期调度完成后会继续存在10秒，如10秒内没有新的生命周期回调触发则进程自动退出。针对可能需要10秒以上才能完成的业务逻辑，建议[拉起主应用](arkts-ui-widget-event-overview.md)进行处理，处理完成后使用[updateForm](../reference/apis-form-kit/js-apis-app-form-formProvider.md#formproviderupdateform)通知卡片进行刷新。
91