harmony 鸿蒙卡片生命周期管理

2025-06-12
浏览 (4)

卡片生命周期管理

创建ArkTS卡片，需实现FormExtensionAbility生命周期接口。

在EntryFormAbility.ets中，导入相关模块。

import { formBindingData, FormExtensionAbility, formInfo, formProvider } from '@kit.FormKit';
import { Configuration, Want } from '@kit.AbilityKit';
import { BusinessError } from '@kit.BasicServicesKit';
import { hilog } from '@kit.PerformanceAnalysisKit';

在EntryFormAbility.ets中，实现FormExtensionAbility生命周期接口，其中在onAddForm的入参want中可以通过FormParam取出卡片的相关信息。

  const TAG: string = 'EntryFormAbility';
  const DOMAIN_NUMBER: number = 0xFF00;


  export default class EntryFormAbility extends FormExtensionAbility {
    onAddForm(want: Want): formBindingData.FormBindingData {
      hilog.info(DOMAIN_NUMBER, TAG, '[EntryFormAbility] onAddForm');
      hilog.info(DOMAIN_NUMBER, TAG, want.parameters?.[formInfo.FormParam.NAME_KEY] as string);


      // ...
      // 卡片使用方创建卡片时触发，提供方需要返回卡片数据绑定类
      let obj: Record<string, string> = {
        'title': 'titleOnAddForm',
        'detail': 'detailOnAddForm'
      };
      let formData: formBindingData.FormBindingData = formBindingData.createFormBindingData(obj);
      return formData;
    }


    onCastToNormalForm(formId: string): void {
      // 卡片使用方将临时卡片转换为常态卡片触发，提供方需要做相应的处理。
      // 1、临时卡、常态卡是卡片使用方的概念。
      // 2、临时卡是短期存在的，在特定事件或用户行为后显示，完成后自动消失。
      // 3、常态卡是持久存在的，在用户未进行清除或更改的情况下，会一直存在，平时开发的功能卡片属于常态卡。
      // 4、目前手机上没有地方会使用临时卡。
      hilog.info(DOMAIN_NUMBER, TAG, '[EntryFormAbility] onCastToNormalForm');
    }


    onUpdateForm(formId: string): void {
      // 若卡片支持定时更新/定点更新/卡片使用方主动请求更新功能，则提供方需要重写该方法以支持数据更新
      hilog.info(DOMAIN_NUMBER, TAG, '[EntryFormAbility] onUpdateForm');
      let obj: Record<string, string> = {
        'title': 'titleOnUpdateForm',
        'detail': 'detailOnUpdateForm'
      };
      let formData: formBindingData.FormBindingData = formBindingData.createFormBindingData(obj);
      formProvider.updateForm(formId, formData).catch((error: BusinessError) => {
        hilog.info(DOMAIN_NUMBER, TAG, '[EntryFormAbility] updateForm, error:' + JSON.stringify(error));
      });
    }


    onChangeFormVisibility(newStatus: Record<string, number>): void {
      // 卡片使用方发起可见或者不可见通知触发，提供方需要做相应的处理，仅系统应用生效
      hilog.info(DOMAIN_NUMBER, TAG, '[EntryFormAbility] onChangeFormVisibility');
    }


    onFormEvent(formId: string, message: string): void {
      // 若卡片支持触发事件，则需要重写该方法并实现对事件的触发
      hilog.info(DOMAIN_NUMBER, TAG, '[EntryFormAbility] onFormEvent');
      // ...
    }


    onRemoveForm(formId: string): void {
      // 删除卡片实例数据
      hilog.info(DOMAIN_NUMBER, TAG, '[EntryFormAbility] onRemoveForm');
      // 删除之前持久化的卡片实例数据
      // 此接口请根据实际情况实现，具体请参考：FormExtAbility Stage模型卡片实例
    }


    onConfigurationUpdate(config: Configuration) {
      // 当前formExtensionAbility存活时更新系统配置信息时触发的回调。
      // 需注意：formExtensionAbility创建后10秒内无操作将会被清理。
      hilog.info(DOMAIN_NUMBER, TAG, '[EntryFormAbility] onConfigurationUpdate:' + JSON.stringify(config));
    }


    onAcquireFormState(want: Want) {
      // 卡片提供方接收查询卡片状态通知接口，默认返回卡片初始状态。
      return formInfo.FormState.READY;
    }
  }

说明：

FormExtensionAbility进程不能常驻后台，即在卡片生命周期回调函数中无法处理长时间的任务，在生命周期调度完成后会继续存在10秒，如10秒内没有新的生命周期回调触发则进程自动退出。针对可能需要10秒以上才能完成的业务逻辑，建议拉起主应用进行处理，处理完成后使用updateForm通知卡片进行刷新。