@ohos.app.ability.abilityLifecycleCallback (UIAbility生命周期回调监听器)

AbilityLifecycleCallback模块提供应用上下文ApplicationContext的生命周期发生变化时触发相应回调的能力。

说明：

本模块首批接口从API version 9 开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。

本模块接口仅可在Stage模型下使用。

导入模块

import { AbilityLifecycleCallback } from '@kit.AbilityKit';

AbilityLifecycleCallback.onAbilityCreate

onAbilityCreate(ability: UIAbility): void

注册监听应用上下文的生命周期后，在Ability创建时触发回调。

原子化服务API：从API version 11开始，该接口支持在原子化服务中使用。

系统能力：SystemCapability.Ability.AbilityRuntime.AbilityCore

参数：

示例：

参见AbilityLifecycleCallback使用。

AbilityLifecycleCallback.onWindowStageCreate

onWindowStageCreate(ability: UIAbility, windowStage: window.WindowStage): void

注册监听应用上下文的生命周期后，在WindowStage创建时触发回调。

原子化服务API：从API version 11开始，该接口支持在原子化服务中使用。

系统能力：SystemCapability.Ability.AbilityRuntime.AbilityCore

参数：

示例：

参见AbilityLifecycleCallback使用。

AbilityLifecycleCallback.onWindowStageActive

onWindowStageActive(ability: UIAbility, windowStage: window.WindowStage): void

注册监听应用上下文的生命周期后，在WindowStage获焦时触发回调。

原子化服务API：从API version 11开始，该接口支持在原子化服务中使用。

系统能力：SystemCapability.Ability.AbilityRuntime.AbilityCore

参数：

示例：

参见AbilityLifecycleCallback使用。

AbilityLifecycleCallback.onWindowStageInactive

onWindowStageInactive(ability: UIAbility, windowStage: window.WindowStage): void

注册监听应用上下文的生命周期后，在WindowStage失焦时触发回调。

原子化服务API：从API version 11开始，该接口支持在原子化服务中使用。

系统能力：SystemCapability.Ability.AbilityRuntime.AbilityCore

参数：

示例：

参见AbilityLifecycleCallback使用。

AbilityLifecycleCallback.onWindowStageDestroy

onWindowStageDestroy(ability: UIAbility, windowStage: window.WindowStage): void

注册监听应用上下文的生命周期后，在WindowStage销毁时触发回调。

原子化服务API：从API version 11开始，该接口支持在原子化服务中使用。

系统能力：SystemCapability.Ability.AbilityRuntime.AbilityCore

参数：

示例：

参见AbilityLifecycleCallback使用。

AbilityLifecycleCallback.onAbilityDestroy

onAbilityDestroy(ability: UIAbility): void

注册监听应用上下文的生命周期后，在Ability销毁时触发回调。

原子化服务API：从API version 11开始，该接口支持在原子化服务中使用。

系统能力：SystemCapability.Ability.AbilityRuntime.AbilityCore

参数：

示例：

参见AbilityLifecycleCallback使用。

AbilityLifecycleCallback.onAbilityForeground

onAbilityForeground(ability: UIAbility): void

注册监听应用上下文的生命周期后，在Ability的状态从后台转到前台时触发回调。

原子化服务API：从API version 11开始，该接口支持在原子化服务中使用。

系统能力：SystemCapability.Ability.AbilityRuntime.AbilityCore

参数：

示例：

参见AbilityLifecycleCallback使用。

AbilityLifecycleCallback.onAbilityBackground

onAbilityBackground(ability: UIAbility): void

注册监听应用上下文的生命周期后，在Ability的状态从前台转到后台时触发回调。

原子化服务API：从API version 11开始，该接口支持在原子化服务中使用。

系统能力：SystemCapability.Ability.AbilityRuntime.AbilityCore

参数：

示例：

参见AbilityLifecycleCallback使用。

AbilityLifecycleCallback.onAbilityContinue

onAbilityContinue(ability: UIAbility): void

注册监听应用上下文的生命周期后，在Ability迁移时触发回调。

原子化服务API：从API version 11开始，该接口支持在原子化服务中使用。

系统能力：SystemCapability.Ability.AbilityRuntime.AbilityCore

参数：

示例：

参见AbilityLifecycleCallback使用。

AbilityLifecycleCallback.onAbilityWillCreate¹²⁺

onAbilityWillCreate?(ability: UIAbility): void

注册监听应用上下文的生命周期后，在UIAbility的onCreate触发前回调。

原子化服务API：从API version 12开始，该接口支持在原子化服务中使用。

系统能力：SystemCapability.Ability.AbilityRuntime.AbilityCore

参数：

示例：

参见AbilityLifecycleCallback使用。

AbilityLifecycleCallback.onWindowStageWillCreate¹²⁺

onWindowStageWillCreate?(ability: UIAbility, windowStage: window.WindowStage): void

注册监听应用上下文的生命周期后，在UIAbility的onWindowStageCreate触发前回调。

原子化服务API：从API version 12开始，该接口支持在原子化服务中使用。

系统能力：SystemCapability.Ability.AbilityRuntime.AbilityCore

参数：

示例：

参见AbilityLifecycleCallback使用。

AbilityLifecycleCallback.onWindowStageWillDestroy¹²⁺

onWindowStageWillDestroy?(ability: UIAbility, windowStage: window.WindowStage): void

注册监听应用上下文的生命周期后，在UIAbility的onWindowStageDestroy触发前回调。

原子化服务API：从API version 12开始，该接口支持在原子化服务中使用。

系统能力：SystemCapability.Ability.AbilityRuntime.AbilityCore

参数：

示例：

参见AbilityLifecycleCallback使用。

AbilityLifecycleCallback.onAbilityWillForeground¹²⁺

onAbilityWillForeground?(ability: UIAbility): void

注册监听应用上下文的生命周期后，在UIAbility的onForeground触发前回调。

原子化服务API：从API version 12开始，该接口支持在原子化服务中使用。

系统能力：SystemCapability.Ability.AbilityRuntime.AbilityCore

参数：

示例：

参见AbilityLifecycleCallback使用。

AbilityLifecycleCallback.onAbilityWillDestroy¹²⁺

onAbilityWillDestroy?(ability: UIAbility): void

注册监听应用上下文的生命周期后，在UIAbility的onDestroy触发前回调。

原子化服务API：从API version 12开始，该接口支持在原子化服务中使用。

系统能力：SystemCapability.Ability.AbilityRuntime.AbilityCore

参数：

示例：

参见AbilityLifecycleCallback使用。

AbilityLifecycleCallback.onAbilityWillBackground¹²⁺

onAbilityWillBackground?(ability: UIAbility): void

注册监听应用上下文的生命周期后，在UIAbility的onBackground触发前回调。

原子化服务API：从API version 12开始，该接口支持在原子化服务中使用。

系统能力：SystemCapability.Ability.AbilityRuntime.AbilityCore

参数：

示例：

参见AbilityLifecycleCallback使用。

AbilityLifecycleCallback.onWillNewWant¹²⁺

onWillNewWant?(ability: UIAbility): void

注册监听应用上下文的生命周期后，在UIAbility的onNewWant触发前回调。

原子化服务API：从API version 12开始，该接口支持在原子化服务中使用。

系统能力：SystemCapability.Ability.AbilityRuntime.AbilityCore

参数：

示例：

参见AbilityLifecycleCallback使用。

AbilityLifecycleCallback.onNewWant¹²⁺

onNewWant?(ability: UIAbility): void

注册监听应用上下文的生命周期后，在UIAbility的onNewWant触发后回调。

原子化服务API：从API version 12开始，该接口支持在原子化服务中使用。

系统能力：SystemCapability.Ability.AbilityRuntime.AbilityCore

参数：

示例：

参见AbilityLifecycleCallback使用。

AbilityLifecycleCallback.onAbilityWillContinue¹²⁺

onAbilityWillContinue?(ability: UIAbility): void

注册监听应用上下文的生命周期后，在UIAbility的onContinue触发前回调。

原子化服务API：从API version 12开始，该接口支持在原子化服务中使用。

系统能力：SystemCapability.Ability.AbilityRuntime.AbilityCore

参数：

示例：

参见AbilityLifecycleCallback使用。

AbilityLifecycleCallback.onWindowStageWillRestore¹²⁺

onWindowStageWillRestore?(ability: UIAbility, windowStage: window.WindowStage): void

注册监听应用上下文的生命周期后，在UIAbility的onWindowStageRestore触发前回调。

原子化服务API：从API version 12开始，该接口支持在原子化服务中使用。

系统能力：SystemCapability.Ability.AbilityRuntime.AbilityCore

参数：

示例：

参见AbilityLifecycleCallback使用。

AbilityLifecycleCallback.onWindowStageRestore¹²⁺

onWindowStageRestore?(ability: UIAbility, windowStage: window.WindowStage): void

注册监听应用上下文的生命周期后，在UIAbility的onWindowStageRestore触发后回调。

原子化服务API：从API version 12开始，该接口支持在原子化服务中使用。

系统能力：SystemCapability.Ability.AbilityRuntime.AbilityCore

参数：

示例：

参见AbilityLifecycleCallback使用。

AbilityLifecycleCallback.onAbilityWillSaveState¹²⁺

onAbilityWillSaveState?(ability: UIAbility): void

注册监听应用上下文的生命周期后，在UIAbility的onSaveState触发前回调。

原子化服务API：从API version 12开始，该接口支持在原子化服务中使用。

系统能力：SystemCapability.Ability.AbilityRuntime.AbilityCore

参数：

示例：

参见AbilityLifecycleCallback使用。

AbilityLifecycleCallback.onAbilitySaveState¹²⁺

onAbilitySaveState?(ability: UIAbility): void

注册监听应用上下文的生命周期后，在UIAbility的onSaveState触发后回调。

原子化服务API：从API version 12开始，该接口支持在原子化服务中使用。

系统能力：SystemCapability.Ability.AbilityRuntime.AbilityCore

参数：

示例：

参见AbilityLifecycleCallback使用。

AbilityLifecycleCallback使用

示例： GlobalContext.ts 全局Context

// 构造单例对象
export class GlobalContext {
  private constructor() {}
  private static instance: GlobalContext;
  private _objects = new Map<string, Object>();

  public static getContext(): GlobalContext {
    if (!GlobalContext.instance) {
      GlobalContext.instance = new GlobalContext();
    }
    return GlobalContext.instance;
  }

  getObject(value: string): Object|undefined {
    return this._objects.get(value);
  }

  setObject(key: string, objectClass: Object): void {
    this._objects.set(key, objectClass);
  }
}

MyFirstAbility.ts 应用的第一个Ability

import { AbilityLifecycleCallback, UIAbility } from '@kit.AbilityKit';
import { window } from '@kit.ArkUI';

// 导入GlobalContext，以开发者自己声明的路径为准
import { GlobalContext } from '../GlobalContext';

// 声明ability生命周期回调，需配置所有回调后才可以在applicationContext注册
let abilityLifecycleCallback: AbilityLifecycleCallback = {
  onAbilityCreate(ability){
    console.log('AbilityLifecycleCallback onAbilityCreate.');
  },
  onWindowStageCreate(ability, windowStage){
    console.log('AbilityLifecycleCallback onWindowStageCreate.');
  },
  onWindowStageActive(ability, windowStage){
    console.log('AbilityLifecycleCallback onWindowStageActive.');
  },
  onWindowStageInactive(ability, windowStage){
    console.log('AbilityLifecycleCallback onWindowStageInactive.');
  },
  onWindowStageDestroy(ability, windowStage){
    console.log('AbilityLifecycleCallback onWindowStageDestroy.');
  },
  onAbilityDestroy(ability){
    console.log('AbilityLifecycleCallback onAbilityDestroy.');
  },
  onAbilityForeground(ability){
    console.log('AbilityLifecycleCallback onAbilityForeground.');
  },
  onAbilityBackground(ability){
    console.log('AbilityLifecycleCallback onAbilityBackground.');
  },
  onAbilityContinue(ability){
    console.log('AbilityLifecycleCallback onAbilityContinue.');
  },
  onNewWant(ability) {
    console.log('AbilityLifecycleCallback onNewWant');
  },
  onWillNewWant(ability) {
    console.log('AbilityLifecycleCallback onWillNewWant');
  },
  onAbilityWillCreate(ability) {
    console.log('AbilityLifecycleCallback onAbilityWillCreate');
  },
  onWindowStageWillCreate(ability, windowStage) {
    console.log('AbilityLifecycleCallback onWindowStageWillCreate');
  },
  onWindowStageWillDestroy(ability, windowStage) {
    console.log('AbilityLifecycleCallback onWindowStageWillDestroy');
  },
  onAbilityWillDestroy(ability) {
    console.log('AbilityLifecycleCallback onAbilityWillDestroy');
  },
  onAbilityWillForeground(ability) {
    console.log('AbilityLifecycleCallback onAbilityWillForeground');
  },
  onAbilityWillBackground(ability) {
    console.log('AbilityLifecycleCallback onAbilityWillBackground');
  },
  onAbilityWillContinue(ability: UIAbility) {
    console.log('AbilityLifecycleCallback onAbilityWillContinue.');
  },
  onWindowStageWillRestore(ability: UIAbility, windowStage: window.WindowStage) {
    console.log('AbilityLifecycleCallback onWindowStageWillRestore.');
  },
  onWindowStageRestore(ability: UIAbility, windowStage: window.WindowStage) {
    console.log('AbilityLifecycleCallback onWindowStageRestore.');
  },
  onAbilityWillSaveState(ability: UIAbility) {
    console.log('AbilityLifecycleCallback onAbilityWillSaveState.');
  },
  onAbilitySaveState(ability: UIAbility) {
    console.log('AbilityLifecycleCallback onAbilitySaveState.');
  }
};

export default class MyFirstAbility extends UIAbility {
  onCreate() {
    console.log('MyAbilityStage onCreate');
    // 1.通过context属性获取applicationContext
    let applicationContext = this.context.getApplicationContext();
    // 2.通过applicationContext注册监听应用内生命周期
    try {
      let lifecycleId = applicationContext.on('abilityLifecycle', abilityLifecycleCallback);
      GlobalContext.getContext().setObject("lifecycleId", lifecycleId);
      console.log(`registerAbilityLifecycleCallback lifecycleId: ${GlobalContext.getContext().getObject('lifecycleId')}`);
    } catch (paramError) {
      console.error(`error: ${paramError.code}, ${paramError.message}`);
    }
  }
}

MySecondAbility.ts 应用的第二个Ability

import { UIAbility } from '@kit.AbilityKit';

// 导入GlobalContext，以开发者自己声明的路径为准
import { GlobalContext } from '../GlobalContext';
import { BusinessError } from '@ohos.base';

export default class MySecondAbility extends UIAbility {
  onDestroy() {
    let applicationContext = this.context.getApplicationContext();
    let lifecycleId = GlobalContext.getContext().getObject("lifecycleId") as number;
    try {
    // 3.通过applicationContext注销监听应用内生命周期
      applicationContext.off('abilityLifecycle', lifecycleId, (error) => {
        if (error && error.code !== 0) {
          console.error(`unregisterAbilityLifecycleCallback fail, error: ${JSON.stringify(error)}`);
        } else {
          console.log('unregisterAbilityLifecycleCallback success.');
        }
      });
    } catch (paramError) {
      console.error(`error: ${(paramError as BusinessError).code}, ${(paramError as BusinessError).message}`);
    }
  }
}

你可能感兴趣的鸿蒙文章

harmony 鸿蒙Ability Kit（程序框架服务）

harmony 鸿蒙AbilityBase

harmony 鸿蒙AbilityBase_Element

harmony 鸿蒙AbilityRuntime

harmony 鸿蒙bundle

harmony 鸿蒙OH_NativeBundle_ApplicationInfo

harmony 鸿蒙OH_NativeBundle_ElementName

harmony 鸿蒙ability_base_common.h

harmony 鸿蒙ability_runtime_common.h

harmony 鸿蒙application_context.h