openharmony-ability-kit

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

OpenHarmony Ability Kit 快速参考

OpenHarmony Ability Kit 快速参考

概述

概述

Ability Kit 是 OpenHarmony Stage 模型中管理应用组件的核心框架。它提供:
  • UIAbility: 带生命周期的 UI 应用组件
  • AbilityStage: 模块级组件管理器,用于初始化
  • Want: 组件间通信的数据载体
  • Context: 应用/组件上下文,用于资源访问和操作
  • ExtensionAbility: 扩展能力(Form、Service 等)
  • BundleManager: 包和应用信息查询
官方文档:
docs-OpenHarmony-v6.0-Release/zh-cn/application-dev/reference/apis-ability-kit/
Ability Kit 是 OpenHarmony Stage 模型中管理应用组件的核心框架,主要提供以下能力:
  • UIAbility:具备生命周期的UI应用组件
  • AbilityStage:模块级组件管理器,用于初始化操作
  • Want:组件间通信的数据载体
  • Context:应用/组件上下文,用于资源访问与操作
  • ExtensionAbility:扩展能力(如Form、Service等)
  • BundleManager:包与应用信息查询工具
官方文档:
docs-OpenHarmony-v6.0-Release/zh-cn/application-dev/reference/apis-ability-kit/

决策流程

决策流程

dot
digraph ability_decision {
  "需要?" [shape=diamond];
  "创建 UI 应用" [shape=box];
  "后台任务" [shape=box];
  "跨应用通信" [shape=box];
  "查询应用信息" [shape=box];

  "使用 UIAbility" [shape=ellipse];
  "使用 ExtensionAbility" [shape=ellipse];
  "使用 Want + Context" [shape=ellipse];
  "使用 BundleManager" [shape=ellipse];

  "需要?" -> "创建 UI 应用" [label="UI"];
  "需要?" -> "后台任务" [label="后台"];
  "需要?" -> "跨应用通信" [label="通信"];
  "需要?" -> "查询应用信息" [label="信息"];

  "创建 UI 应用" -> "使用 UIAbility";
  "后台任务" -> "使用 ExtensionAbility";
  "跨应用通信" -> "使用 Want + Context";
  "查询应用信息" -> "使用 BundleManager";
}
dot
digraph ability_decision {
  "需要?" [shape=diamond];
  "创建 UI 应用" [shape=box];
  "后台任务" [shape=box];
  "跨应用通信" [shape=box];
  "查询应用信息" [shape=box];

  "使用 UIAbility" [shape=ellipse];
  "使用 ExtensionAbility" [shape=ellipse];
  "使用 Want + Context" [shape=ellipse];
  "使用 BundleManager" [shape=ellipse];

  "需要?" -> "创建 UI 应用" [label="UI"];
  "需要?" -> "后台任务" [label="后台"];
  "需要?" -> "跨应用通信" [label="通信"];
  "需要?" -> "查询应用信息" [label="信息"];

  "创建 UI 应用" -> "使用 UIAbility";
  "后台任务" -> "使用 ExtensionAbility";
  "跨应用通信" -> "使用 Want + Context";
  "查询应用信息" -> "使用 BundleManager";
}

快速参考表

快速参考表

模块API 版本用途导入语句
UIAbility9+UI 应用组件
import { UIAbility } from '@kit.AbilityKit'
AbilityStage9+模块级管理器
import { AbilityStage } from '@kit.AbilityKit'
Want9+组件通信
import { Want } from '@kit.AbilityKit'
common (Context)9+Context API
import { common } from '@kit.AbilityKit'
bundleManager9+包查询
import { bundleManager } from '@kit.AbilityKit'
wantAgent9+Want 封装
import { wantAgent } from '@kit.AbilityKit'
appManager9+应用生命周期管理
import { appManager } from '@kit.AbilityKit'
AbilityConstant9+Ability 常量
import { AbilityConstant } from '@kit.AbilityKit'
Configuration9+系统配置
import { Configuration } from '@kit.AbilityKit'
模块API 版本用途导入语句
UIAbility9+UI 应用组件
import { UIAbility } from '@kit.AbilityKit'
AbilityStage9+模块级管理器
import { AbilityStage } from '@kit.AbilityKit'
Want9+组件通信
import { Want } from '@kit.AbilityKit'
common (Context)9+Context API
import { common } from '@kit.AbilityKit'
bundleManager9+包查询
import { bundleManager } from '@kit.AbilityKit'
wantAgent9+Want 封装
import { wantAgent } from '@kit.AbilityKit'
appManager9+应用生命周期管理
import { appManager } from '@kit.AbilityKit'
AbilityConstant9+Ability 常量
import { AbilityConstant } from '@kit.AbilityKit'
Configuration9+系统配置
import { Configuration } from '@kit.AbilityKit'

UIAbility 生命周期

UIAbility 生命周期

生命周期状态

生命周期状态

Create -> WindowStageCreate -> Foreground <-> Background -> WindowStageDestroy -> Destroy
Create -> WindowStageCreate -> Foreground <-> Background -> WindowStageDestroy -> Destroy

关键回调

关键回调

回调调用时机使用场景
onCreate(want, launchParam)
Ability 创建时初始化非 UI 资源
onWindowStageCreate(windowStage)
窗口就绪时加载 UI 内容,设置窗口属性
onForeground()
进入前台时恢复操作,刷新数据
onBackground()
进入后台时保存状态,释放资源
onWindowStageDestroy()
窗口销毁时清理窗口资源
onDestroy()
Ability 销毁时最终清理
onNewWant(want, launchParam)
重新激活(单例模式)处理新的意图
回调调用时机使用场景
onCreate(want, launchParam)
Ability 创建时初始化非UI资源
onWindowStageCreate(windowStage)
窗口就绪时加载UI内容,设置窗口属性
onForeground()
进入前台时恢复操作,刷新数据
onBackground()
进入后台时保存状态,释放资源
onWindowStageDestroy()
窗口销毁时清理窗口资源
onDestroy()
Ability 销毁时最终清理操作
onNewWant(want, launchParam)
重新激活(单例模式)处理新的意图请求

基础 UIAbility 模板

基础 UIAbility 模板

typescript
import { UIAbility, AbilityConstant, Want } from '@kit.AbilityKit';
import { window } from '@kit.ArkUI';
import { hilog } from '@kit.PerformanceAnalysisKit';

export default class EntryAbility extends UIAbility {
  onCreate(want: Want, launchParam: AbilityConstant.LaunchParam): void {
    hilog.info(0x0000, 'testTag', 'Ability onCreate');
    // 初始化非 UI 资源
  }

  onWindowStageCreate(windowStage: window.WindowStage): void {
    hilog.info(0x0000, 'testTag', 'Ability onWindowStageCreate');

    // 加载主页面
    windowStage.loadContent('pages/Index', (err, data) => {
      if (err.code) {
        hilog.error(0x0000, 'testTag', 'Failed to load content: %{public}s', JSON.stringify(err));
        return;
      }
      hilog.info(0x0000, 'testTag', 'Succeeded in loading content');
    });
  }

  onForeground(): void {
    hilog.info(0x0000, 'testTag', 'Ability onForeground');
  }

  onBackground(): void {
    hilog.info(0x0000, 'testTag', 'Ability onBackground');
  }

  onDestroy(): void {
    hilog.info(0x0000, 'testTag', 'Ability onDestroy');
  }
}
typescript
import { UIAbility, AbilityConstant, Want } from '@kit.AbilityKit';
import { window } from '@kit.ArkUI';
import { hilog } from '@kit.PerformanceAnalysisKit';

export default class EntryAbility extends UIAbility {
  onCreate(want: Want, launchParam: AbilityConstant.LaunchParam): void {
    hilog.info(0x0000, 'testTag', 'Ability onCreate');
    // 初始化非 UI 资源
  }

  onWindowStageCreate(windowStage: window.WindowStage): void {
    hilog.info(0x0000, 'testTag', 'Ability onWindowStageCreate');

    // 加载主页面
    windowStage.loadContent('pages/Index', (err, data) => {
      if (err.code) {
        hilog.error(0x0000, 'testTag', 'Failed to load content: %{public}s', JSON.stringify(err));
        return;
      }
      hilog.info(0x0000, 'testTag', 'Succeeded in loading content');
    });
  }

  onForeground(): void {
    hilog.info(0x0000, 'testTag', 'Ability onForeground');
  }

  onBackground(): void {
    hilog.info(0x0000, 'testTag', 'Ability onBackground');
  }

  onDestroy(): void {
    hilog.info(0x0000, 'testTag', 'Ability onDestroy');
  }
}

启动类型

启动类型

类型说明使用场景
SINGLETON
0单实例主入口、设置页
MULTITON
1多实例文档编辑器
SPECIFIED
2开发者控制自定义实例管理
module.json5
中配置:
json
{
  "abilities": [{
    "name": "EntryAbility",
    "launchType": "singleton"
  }]
}
类型说明使用场景
SINGLETON
0单实例主入口、设置页
MULTITON
1多实例文档编辑器
SPECIFIED
2开发者控制自定义实例管理
module.json5
中配置:
json
{
  "abilities": [{
    "name": "EntryAbility",
    "launchType": "singleton"
  }]
}

AbilityStage

AbilityStage

模块级组件管理器,在模块中的任何 Ability 之前创建。
模块级组件管理器,会在模块内所有Ability创建之前初始化。

关键回调

关键回调

回调调用时机使用场景
onCreate()
模块首次加载时资源预加载、线程创建
onDestroy()
最后一个 ability 退出时 (API 12+)模块清理
onAcceptWant(want)
指定启动模式返回唯一 ability 键
onConfigurationUpdate(config)
系统配置变化时处理语言/主题变化
onMemoryLevel(level)
内存压力时释放非必要资源
回调调用时机使用场景
onCreate()
模块首次加载时资源预加载、线程创建
onDestroy()
最后一个Ability退出时(API 12+)模块清理操作
onAcceptWant(want)
指定启动模式下返回唯一Ability标识键
onConfigurationUpdate(config)
系统配置变化时处理语言/主题变更
onMemoryLevel(level)
内存压力触发时释放非必要资源

基础 AbilityStage 模板

基础 AbilityStage 模板

typescript
import { AbilityStage, Want, Configuration, AbilityConstant } from '@kit.AbilityKit';

export default class MyAbilityStage extends AbilityStage {
  onCreate(): void {
    console.log('MyAbilityStage onCreate');
    // 模块初始化
  }

  onAcceptWant(want: Want): string {
    // 对于指定启动模式,返回唯一键
    if (want.abilityName === 'DocumentAbility') {
      return want.parameters?.docId as string || 'default';
    }
    return '';
  }

  onConfigurationUpdate(config: Configuration): void {
    console.log(`Config updated: ${JSON.stringify(config)}`);
  }

  onMemoryLevel(level: AbilityConstant.MemoryLevel): void {
    console.log(`Memory level: ${level}`);
    // 内存低时释放缓存
  }
}
typescript
import { AbilityStage, Want, Configuration, AbilityConstant } from '@kit.AbilityKit';

export default class MyAbilityStage extends AbilityStage {
  onCreate(): void {
    console.log('MyAbilityStage onCreate');
    // 模块初始化
  }

  onAcceptWant(want: Want): string {
    // 对于指定启动模式,返回唯一键
    if (want.abilityName === 'DocumentAbility') {
      return want.parameters?.docId as string || 'default';
    }
    return '';
  }

  onConfigurationUpdate(config: Configuration): void {
    console.log(`Config updated: ${JSON.stringify(config)}`);
  }

  onMemoryLevel(level: AbilityConstant.MemoryLevel): void {
    console.log(`Memory level: ${level}`);
    // 内存低时释放缓存
  }
}

Want 对象

Want 对象

组件通信的数据载体。
组件间通信的数据载体。

Want 结构

Want 结构

字段类型说明
bundleName
string目标包名
abilityName
string目标 ability 名称
moduleName
string目标模块名(可选)
action
string要执行的操作
entities
string[]实体类别
uri
string数据 URI
type
stringMIME 类型
parameters
Record<string, Object>自定义参数
flags
numberWant 标志
字段类型说明
bundleName
string目标包名
abilityName
string目标Ability名称
moduleName
string目标模块名(可选)
action
string要执行的操作
entities
string[]实体类别
uri
string数据URI
type
stringMIME类型
parameters
Record<string, Object>自定义参数
flags
numberWant标志位

常用 Want 模式

常用 Want 模式

显式启动(同一应用)
typescript
let want: Want = {
  bundleName: 'com.example.myapp',
  abilityName: 'SecondAbility',
  parameters: {
    key1: 'value1',
    key2: 123
  }
};
this.context.startAbility(want);
显式启动(跨应用) - API 11+ 限制
typescript
// API 11+ 要求第三方应用使用隐式启动
// 使用 openLink 代替:
this.context.openLink('https://example.com/path');
隐式启动
typescript
let want: Want = {
  action: 'ohos.want.action.viewData',
  entities: ['entity.system.browsable'],
  uri: 'https://example.com'
};
this.context.startAbility(want);
带结果启动
typescript
let want: Want = {
  bundleName: 'com.example.myapp',
  abilityName: 'SelectAbility'
};

this.context.startAbilityForResult(want).then((result) => {
  console.log(`Result code: ${result.resultCode}`);
  console.log(`Result data: ${JSON.stringify(result.want?.parameters)}`);
});
返回结果
typescript
// 在目标 ability 中
let resultWant: Want = {
  parameters: {
    selectedItem: 'item1'
  }
};
this.context.terminateSelfWithResult({
  resultCode: 0,
  want: resultWant
});
显式启动(同一应用)
typescript
let want: Want = {
  bundleName: 'com.example.myapp',
  abilityName: 'SecondAbility',
  parameters: {
    key1: 'value1',
    key2: 123
  }
};
this.context.startAbility(want);
显式启动(跨应用)- API 11+ 限制
typescript
// API 11+ 要求第三方应用使用隐式启动
// 使用 openLink 代替:
this.context.openLink('https://example.com/path');
隐式启动
typescript
let want: Want = {
  action: 'ohos.want.action.viewData',
  entities: ['entity.system.browsable'],
  uri: 'https://example.com'
};
this.context.startAbility(want);
带结果启动
typescript
let want: Want = {
  bundleName: 'com.example.myapp',
  abilityName: 'SelectAbility'
};

this.context.startAbilityForResult(want).then((result) => {
  console.log(`Result code: ${result.resultCode}`);
  console.log(`Result data: ${JSON.stringify(result.want?.parameters)}`);
});
返回结果
typescript
// 在目标 Ability 中
let resultWant: Want = {
  parameters: {
    selectedItem: 'item1'
  }
};
this.context.terminateSelfWithResult({
  resultCode: 0,
  want: resultWant
});

Want 标志

Want 标志

标志说明
FLAG_AUTH_READ_URI_PERMISSION
0x00000001授予读取 URI 权限
FLAG_AUTH_WRITE_URI_PERMISSION
0x00000002授予写入 URI 权限
FLAG_INSTALL_ON_DEMAND
0x00000800按需安装
标志说明
FLAG_AUTH_READ_URI_PERMISSION
0x00000001授予读取URI权限
FLAG_AUTH_WRITE_URI_PERMISSION
0x00000002授予写入URI权限
FLAG_INSTALL_ON_DEMAND
0x00000800按需安装应用

Context 层级

Context 层级

Context 类型

Context 类型

Context作用域关键 API
ApplicationContext
应用级
on/off('abilityLifecycle')
,
killAllProcesses()
,
setColorMode()
UIAbilityContext
UIAbility
startAbility()
,
terminateSelf()
,
requestPermissions()
AbilityStageContext
AbilityStage模块级资源访问
ExtensionContext
ExtensionAbilityExtension 特定操作
Context作用域关键 API
ApplicationContext
应用级
on/off('abilityLifecycle')
,
killAllProcesses()
,
setColorMode()
UIAbilityContext
UIAbility级
startAbility()
,
terminateSelf()
,
requestPermissions()
AbilityStageContext
AbilityStage级模块级资源访问
ExtensionContext
ExtensionAbility级扩展能力专属操作

获取 Context

获取 Context

在 UIAbility 中:
typescript
import { UIAbility, common } from '@kit.AbilityKit';

export default class EntryAbility extends UIAbility {
  onCreate(): void {
    // UIAbilityContext
    let uiAbilityContext: common.UIAbilityContext = this.context;

    // ApplicationContext
    let appContext: common.ApplicationContext = this.context.getApplicationContext();
  }
}
在组件(页面)中:
typescript
import { common } from '@kit.AbilityKit';

@Entry
@Component
struct Index {
  build() {
    Button('Start')
      .onClick(() => {
        let context = getContext(this) as common.UIAbilityContext;
        context.startAbility({ /* want */ });
      })
  }
}
在 UIAbility 中:
typescript
import { UIAbility, common } from '@kit.AbilityKit';

export default class EntryAbility extends UIAbility {
  onCreate(): void {
    // UIAbilityContext
    let uiAbilityContext: common.UIAbilityContext = this.context;

    // ApplicationContext
    let appContext: common.ApplicationContext = this.context.getApplicationContext();
  }
}
在组件(页面)中:
typescript
import { common } from '@kit.AbilityKit';

@Entry
@Component
struct Index {
  build() {
    Button('Start')
      .onClick(() => {
        let context = getContext(this) as common.UIAbilityContext;
        context.startAbility({ /* want */ });
      })
  }
}

UIAbilityContext 关键 API

UIAbilityContext 关键 API

API说明
startAbility(want)
启动另一个 ability
startAbilityForResult(want)
启动并获取结果
terminateSelf()
关闭当前 ability
terminateSelfWithResult(result)
带结果关闭
connectServiceExtensionAbility(want, options)
连接到服务
disconnectServiceExtensionAbility(connection)
断开服务连接
requestPermissionsFromUser(permissions)
请求权限
setMissionLabel(label)
设置最近任务标签
setMissionIcon(icon)
设置最近任务图标
API说明
startAbility(want)
启动另一个Ability
startAbilityForResult(want)
启动Ability并获取返回结果
terminateSelf()
关闭当前Ability
terminateSelfWithResult(result)
携带结果关闭当前Ability
connectServiceExtensionAbility(want, options)
连接到服务扩展
disconnectServiceExtensionAbility(connection)
断开服务扩展连接
requestPermissionsFromUser(permissions)
向用户申请权限
setMissionLabel(label)
设置最近任务标签
setMissionIcon(icon)
设置最近任务图标

ApplicationContext 关键 API

ApplicationContext 关键 API

API说明
on('abilityLifecycle', callback)
监听 ability 生命周期
on('environment', callback)
监听环境变化
on('applicationStateChange', callback)
监听应用状态
getRunningProcessInformation()
获取进程信息
killAllProcesses()
强制退出所有进程
setColorMode(mode)
设置深色/浅色模式
setLanguage(language)
设置应用语言
restartApp(want)
重启应用 (API 12+)
API说明
on('abilityLifecycle', callback)
监听Ability生命周期
on('environment', callback)
监听系统环境变化
on('applicationStateChange', callback)
监听应用状态变更
getRunningProcessInformation()
获取进程信息
killAllProcesses()
强制退出所有进程
setColorMode(mode)
设置深色/浅色模式
setLanguage(language)
设置应用语言
restartApp(want)
重启应用(API 12+)

生命周期监听示例

生命周期监听示例

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

export default class EntryAbility extends UIAbility {
  private lifecycleId: number = -1;

  onCreate(): void {
    let callback: AbilityLifecycleCallback = {
      onAbilityCreate(ability) {
        console.log(`Ability created: ${ability.context.abilityInfo.name}`);
      },
      onAbilityForeground(ability) {
        console.log(`Ability foreground: ${ability.context.abilityInfo.name}`);
      },
      onAbilityBackground(ability) {
        console.log(`Ability background: ${ability.context.abilityInfo.name}`);
      },
      onAbilityDestroy(ability) {
        console.log(`Ability destroyed: ${ability.context.abilityInfo.name}`);
      },
      onWindowStageCreate(ability, windowStage) {},
      onWindowStageActive(ability, windowStage) {},
      onWindowStageInactive(ability, windowStage) {},
      onWindowStageDestroy(ability, windowStage) {},
      onAbilityContinue(ability) {}
    };

    let appContext = this.context.getApplicationContext();
    this.lifecycleId = appContext.on('abilityLifecycle', callback);
  }

  onDestroy(): void {
    let appContext = this.context.getApplicationContext();
    appContext.off('abilityLifecycle', this.lifecycleId);
  }
}
typescript
import { UIAbility, AbilityLifecycleCallback } from '@kit.AbilityKit';

export default class EntryAbility extends UIAbility {
  private lifecycleId: number = -1;

  onCreate(): void {
    let callback: AbilityLifecycleCallback = {
      onAbilityCreate(ability) {
        console.log(`Ability created: ${ability.context.abilityInfo.name}`);
      },
      onAbilityForeground(ability) {
        console.log(`Ability foreground: ${ability.context.abilityInfo.name}`);
      },
      onAbilityBackground(ability) {
        console.log(`Ability background: ${ability.context.abilityInfo.name}`);
      },
      onAbilityDestroy(ability) {
        console.log(`Ability destroyed: ${ability.context.abilityInfo.name}`);
      },
      onWindowStageCreate(ability, windowStage) {},
      onWindowStageActive(ability, windowStage) {},
      onWindowStageInactive(ability, windowStage) {},
      onWindowStageDestroy(ability, windowStage) {},
      onAbilityContinue(ability) {}
    };

    let appContext = this.context.getApplicationContext();
    this.lifecycleId = appContext.on('abilityLifecycle', callback);
  }

  onDestroy(): void {
    let appContext = this.context.getApplicationContext();
    appContext.off('abilityLifecycle', this.lifecycleId);
  }
}

ExtensionAbility 类型

ExtensionAbility 类型

类型说明使用场景
FORM
0FormExtensionAbility卡片开发
WORK_SCHEDULER
1WorkSchedulerExtensionAbility后台任务
INPUT_METHOD
2InputMethodExtensionAbility输入法
ACCESSIBILITY
4AccessibilityExtensionAbility辅助功能服务
BACKUP
9BackupExtensionAbility数据备份/恢复
ENTERPRISE_ADMIN
11EnterpriseAdminExtensionAbility企业设备管理
SHARE
16ShareExtensionAbility分享功能
DRIVER
18DriverExtensionAbility设备驱动
ACTION
19ActionExtensionAbility自定义操作
EMBEDDED_UI
21EmbeddedUIExtensionAbility跨进程 UI 嵌入
类型说明使用场景
FORM
0FormExtensionAbility卡片开发
WORK_SCHEDULER
1WorkSchedulerExtensionAbility后台任务
INPUT_METHOD
2InputMethodExtensionAbility输入法
ACCESSIBILITY
4AccessibilityExtensionAbility辅助功能服务
BACKUP
9BackupExtensionAbility数据备份/恢复
ENTERPRISE_ADMIN
11EnterpriseAdminExtensionAbility企业设备管理
SHARE
16ShareExtensionAbility分享功能
DRIVER
18DriverExtensionAbility设备驱动
ACTION
19ActionExtensionAbility自定义操作
EMBEDDED_UI
21EmbeddedUIExtensionAbility跨进程UI嵌入

BundleManager

BundleManager

查询应用和包信息。
查询应用与包信息的工具。

BundleFlags

BundleFlags

标志说明
GET_BUNDLE_INFO_DEFAULT
0x00000000仅默认信息
GET_BUNDLE_INFO_WITH_APPLICATION
0x00000001包含 applicationInfo
GET_BUNDLE_INFO_WITH_HAP_MODULE
0x00000002包含 hapModuleInfo
GET_BUNDLE_INFO_WITH_ABILITY
0x00000004包含 ability 信息(需 HAP_MODULE)
GET_BUNDLE_INFO_WITH_EXTENSION_ABILITY
0x00000008包含 extension 信息(需 HAP_MODULE)
GET_BUNDLE_INFO_WITH_REQUESTED_PERMISSION
0x00000010包含权限
GET_BUNDLE_INFO_WITH_METADATA
0x00000020包含元数据
GET_BUNDLE_INFO_WITH_SIGNATURE_INFO
0x00000080包含签名信息
标志说明
GET_BUNDLE_INFO_DEFAULT
0x00000000仅获取默认信息
GET_BUNDLE_INFO_WITH_APPLICATION
0x00000001包含applicationInfo信息
GET_BUNDLE_INFO_WITH_HAP_MODULE
0x00000002包含hapModuleInfo信息
GET_BUNDLE_INFO_WITH_ABILITY
0x00000004包含Ability信息(需配合HAP_MODULE)
GET_BUNDLE_INFO_WITH_EXTENSION_ABILITY
0x00000008包含Extension信息(需配合HAP_MODULE)
GET_BUNDLE_INFO_WITH_REQUESTED_PERMISSION
0x00000010包含权限信息
GET_BUNDLE_INFO_WITH_METADATA
0x00000020包含元数据
GET_BUNDLE_INFO_WITH_SIGNATURE_INFO
0x00000080包含签名信息

常用操作

常用操作

获取自身包信息
typescript
import { bundleManager } from '@kit.AbilityKit';

let bundleFlags = bundleManager.BundleFlag.GET_BUNDLE_INFO_WITH_APPLICATION |
                  bundleManager.BundleFlag.GET_BUNDLE_INFO_WITH_HAP_MODULE |
                  bundleManager.BundleFlag.GET_BUNDLE_INFO_WITH_ABILITY;

try {
  let bundleInfo = bundleManager.getBundleInfoForSelfSync(bundleFlags);
  console.log(`Bundle name: ${bundleInfo.name}`);
  console.log(`Version: ${bundleInfo.versionName}`);

  // 遍历 abilities
  bundleInfo.hapModulesInfo?.forEach((hapInfo) => {
    hapInfo.abilitiesInfo?.forEach((abilityInfo) => {
      console.log(`Ability: ${abilityInfo.name}`);
    });
  });
} catch (err) {
  console.error(`Failed: ${err.message}`);
}
获取配置文件
typescript
import { bundleManager } from '@kit.AbilityKit';

let moduleName = 'entry';
let abilityName = 'EntryAbility';
let metadataName = 'ability_metadata';

try {
  let profiles = bundleManager.getProfileByAbilitySync(moduleName, abilityName, metadataName);
  console.log(`Profile: ${JSON.stringify(profiles)}`);
} catch (err) {
  console.error(`Failed: ${err.message}`);
}
获取自身包信息
typescript
import { bundleManager } from '@kit.AbilityKit';

let bundleFlags = bundleManager.BundleFlag.GET_BUNDLE_INFO_WITH_APPLICATION |
                  bundleManager.BundleFlag.GET_BUNDLE_INFO_WITH_HAP_MODULE |
                  bundleManager.BundleFlag.GET_BUNDLE_INFO_WITH_ABILITY;

try {
  let bundleInfo = bundleManager.getBundleInfoForSelfSync(bundleFlags);
  console.log(`Bundle name: ${bundleInfo.name}`);
  console.log(`Version: ${bundleInfo.versionName}`);

  // 遍历 abilities
  bundleInfo.hapModulesInfo?.forEach((hapInfo) => {
    hapInfo.abilitiesInfo?.forEach((abilityInfo) => {
      console.log(`Ability: ${abilityInfo.name}`);
    });
  });
} catch (err) {
  console.error(`Failed: ${err.message}`);
}
获取配置文件
typescript
import { bundleManager } from '@kit.AbilityKit';

let moduleName = 'entry';
let abilityName = 'EntryAbility';
let metadataName = 'ability_metadata';

try {
  let profiles = bundleManager.getProfileByAbilitySync(moduleName, abilityName, metadataName);
  console.log(`Profile: ${JSON.stringify(profiles)}`);
} catch (err) {
  console.error(`Failed: ${err.message}`);
}

Caller/Callee (后台通信)

Caller/Callee(后台通信)

用于后台 ability 间通信。
用于后台Ability之间的通信。

Callee 端(接收)

Callee端(接收方)

typescript
import { UIAbility, Caller, Callee } from '@kit.AbilityKit';
import { rpc } from '@kit.IPCKit';

const MSG_SEND_METHOD: string = 'CallSendMsg';

class MyParcelable implements rpc.Parcelable {
  num: number = 0;
  str: string = '';

  marshalling(messageSequence: rpc.MessageSequence): boolean {
    messageSequence.writeInt(this.num);
    messageSequence.writeString(this.str);
    return true;
  }

  unmarshalling(messageSequence: rpc.MessageSequence): boolean {
    this.num = messageSequence.readInt();
    this.str = messageSequence.readString();
    return true;
  }
}

function sendMsgCallback(data: rpc.MessageSequence): rpc.Parcelable {
  let receivedData = new MyParcelable();
  data.readParcelable(receivedData);
  console.log(`Received: ${receivedData.str}`);

  // 返回结果
  let reply = new MyParcelable();
  reply.num = receivedData.num + 1;
  reply.str = 'reply';
  return reply;
}

export default class CalleeAbility extends UIAbility {
  onCreate(): void {
    this.callee.on(MSG_SEND_METHOD, sendMsgCallback);
  }

  onDestroy(): void {
    this.callee.off(MSG_SEND_METHOD);
  }
}
typescript
import { UIAbility, Caller, Callee } from '@kit.AbilityKit';
import { rpc } from '@kit.IPCKit';

const MSG_SEND_METHOD: string = 'CallSendMsg';

class MyParcelable implements rpc.Parcelable {
  num: number = 0;
  str: string = '';

  marshalling(messageSequence: rpc.MessageSequence): boolean {
    messageSequence.writeInt(this.num);
    messageSequence.writeString(this.str);
    return true;
  }

  unmarshalling(messageSequence: rpc.MessageSequence): boolean {
    this.num = messageSequence.readInt();
    this.str = messageSequence.readString();
    return true;
  }
}

function sendMsgCallback(data: rpc.MessageSequence): rpc.Parcelable {
  let receivedData = new MyParcelable();
  data.readParcelable(receivedData);
  console.log(`Received: ${receivedData.str}`);

  // 返回结果
  let reply = new MyParcelable();
  reply.num = receivedData.num + 1;
  reply.str = 'reply';
  return reply;
}

export default class CalleeAbility extends UIAbility {
  onCreate(): void {
    this.callee.on(MSG_SEND_METHOD, sendMsgCallback);
  }

  onDestroy(): void {
    this.callee.off(MSG_SEND_METHOD);
  }
}

Caller 端(发送)

Caller端(发送方)

typescript
import { UIAbility, Caller, Want } from '@kit.AbilityKit';

export default class CallerAbility extends UIAbility {
  private caller: Caller | undefined;

  async callRemoteAbility(): Promise<void> {
    let want: Want = {
      bundleName: 'com.example.myapp',
      abilityName: 'CalleeAbility'
    };

    try {
      this.caller = await this.context.startAbilityByCall(want);

      let data = new MyParcelable();
      data.num = 1;
      data.str = 'hello';

      let reply = await this.caller.call('CallSendMsg', data);
      let result = new MyParcelable();
      reply.readParcelable(result);
      console.log(`Reply: ${result.str}`);
    } catch (err) {
      console.error(`Call failed: ${err.message}`);
    }
  }

  releaseCall(): void {
    if (this.caller) {
      this.caller.release();
      this.caller = undefined;
    }
  }
}
typescript
import { UIAbility, Caller, Want } from '@kit.AbilityKit';

export default class CallerAbility extends UIAbility {
  private caller: Caller | undefined;

  async callRemoteAbility(): Promise<void> {
    let want: Want = {
      bundleName: 'com.example.myapp',
      abilityName: 'CalleeAbility'
    };

    try {
      this.caller = await this.context.startAbilityByCall(want);

      let data = new MyParcelable();
      data.num = 1;
      data.str = 'hello';

      let reply = await this.caller.call('CallSendMsg', data);
      let result = new MyParcelable();
      reply.readParcelable(result);
      console.log(`Reply: ${result.str}`);
    } catch (err) {
      console.error(`Call failed: ${err.message}`);
    }
  }

  releaseCall(): void {
    if (this.caller) {
      this.caller.release();
      this.caller = undefined;
    }
  }
}

常见错误码

常见错误码

Ability 系统错误 (16000xxx)

Ability 系统错误(16000xxx)

错误码消息原因解决方案
16000001指定的 ability 不存在Ability 未找到检查 bundleName、moduleName、abilityName;确认应用已安装
16000002Ability 类型不正确API 的 ability 类型错误匹配 API 与 ability 类型
16000004无法启动不可见组件目标 exported=false设置 exported=true 或请求 START_INVISIBLE_ABILITY 权限
16000005进程权限失败权限不足检查所需权限
16000011Context 不存在Context 不可用验证 context 有效性
16000015服务超时请求超时稍后重试
16000018禁止第三方重定向API 11+ 禁止显式启动使用隐式启动或 openLink()
16000019未找到匹配的 ability隐式启动无匹配检查 action/entities/uri 配置
16000050内部错误系统错误检查日志,重试
16000053Ability 未置顶restartApp 需要焦点确保应用获得焦点
16000063重启目标无效非同一应用或非 UIAbility检查重启目标
16000064重启过于频繁重启间隔 < 3 秒至少等待 3 秒
错误码消息原因解决方案
16000001指定的Ability不存在目标Ability未找到检查bundleName、moduleName、abilityName;确认应用已安装
16000002Ability类型不正确API与目标Ability类型不匹配确保API调用与Ability类型一致
16000004无法启动不可见组件目标组件exported=false设置exported=true或申请START_INVISIBLE_ABILITY权限
16000005进程权限验证失败权限不足检查并申请所需权限
16000011Context不存在当前Context不可用验证Context的有效性
16000015服务请求超时请求响应超时稍后重试操作
16000018禁止第三方重定向API 11+ 禁止显式启动第三方应用使用隐式启动或openLink()方法
16000019未找到匹配的Ability隐式启动无对应匹配项检查action/entities/uri配置
16000050内部系统错误系统层面异常查看日志排查,重试操作
16000053Ability未处于前台restartApp需要应用处于焦点状态确保应用获得焦点后再执行
16000063重启目标无效非同一应用或非UIAbility检查重启目标的合法性
16000064重启过于频繁重启间隔小于3秒至少等待3秒后再重启

Bundle Manager 错误 (17700xxx)

Bundle Manager 错误(17700xxx)

错误码消息原因解决方案
17700001Bundle 未找到应用未安装验证安装
17700002Module 未找到Module 未安装检查 moduleName
17700003Ability 未找到Ability 不存在检查 abilityName
17700024HAP 中无配置文件缺少配置文件将配置添加到 metadata
17700026指定的 bundle 被禁用Bundle 被禁用启用该 bundle
17700029Ability 被禁用Ability 被禁用启用该 ability
错误码消息原因解决方案
17700001Bundle未找到应用未安装验证应用是否已正确安装
17700002Module未找到目标Module不存在检查moduleName是否正确
17700003Ability未找到目标Ability不存在检查abilityName是否正确
17700024HAP中无配置文件缺少指定配置文件将配置添加到metadata中
17700026指定的Bundle已被禁用Bundle处于禁用状态启用目标Bundle
17700029Ability已被禁用目标Ability处于禁用状态启用目标Ability

最佳实践

最佳实践

1. 使用正确的 Context

1. 使用正确的Context

typescript
// 对于 UI 操作 - 使用 UIAbilityContext
let uiContext = this.context; // 在 UIAbility 中

// 对于应用级操作 - 使用 ApplicationContext
let appContext = this.context.getApplicationContext();
typescript
// 对于UI操作 - 使用UIAbilityContext
let uiContext = this.context; // 在UIAbility中

// 对于应用级操作 - 使用ApplicationContext
let appContext = this.context.getApplicationContext();

2. 正确处理生命周期

2. 正确处理生命周期

typescript
onForeground(): void {
  // 恢复:刷新数据、重新启动动画
}

onBackground(): void {
  // 暂停:保存状态、释放重量级资源
  // 不要依赖此方法进行关键保存
}
typescript
onForeground(): void {
  // 恢复操作:刷新数据、重启动画
}

onBackground(): void {
  // 暂停操作:保存状态、释放重量级资源
  // 不要依赖此方法进行关键数据保存
}

3. 对跨应用使用隐式启动 (API 11+)

3. 跨应用通信使用隐式启动(API 11+)

typescript
// 不要这样做: 显式启动第三方应用
let want = { bundleName: 'com.other.app', abilityName: 'Main' };

// 应该这样做: 使用 openLink 或隐式启动
this.context.openLink('https://example.com');
// 或者
let want = { action: 'ohos.want.action.viewData', uri: 'https://...' };
typescript
// 不推荐:显式启动第三方应用
let want = { bundleName: 'com.other.app', abilityName: 'Main' };

// 推荐:使用openLink或隐式启动
this.context.openLink('https://example.com');
// 或者
let want = { action: 'ohos.want.action.viewData', uri: 'https://...' };

4. 清理资源

4. 及时清理资源

typescript
onDestroy(): void {
  // 取消注册回调
  appContext.off('abilityLifecycle', this.lifecycleId);

  // 释放连接
  if (this.caller) {
    this.caller.release();
  }
}
typescript
onDestroy(): void {
  // 取消注册回调
  appContext.off('abilityLifecycle', this.lifecycleId);

  // 释放远程连接
  if (this.caller) {
    this.caller.release();
  }
}

5. 优雅地处理错误

5. 优雅处理错误

typescript
try {
  await this.context.startAbility(want);
} catch (err) {
  if (err.code === 16000001) {
    console.error('Ability not found');
  } else if (err.code === 16000004) {
    console.error('Target is not exported');
  } else {
    console.error(`Error: ${err.code} - ${err.message}`);
  }
}
typescript
try {
  await this.context.startAbility(want);
} catch (err) {
  if (err.code === 16000001) {
    console.error('Ability未找到');
  } else if (err.code === 16000004) {
    console.error('目标组件未开放');
  } else {
    console.error(`错误:${err.code} - ${err.message}`);
  }
}

文档参考

文档参考

主题文件路径
UIAbility
js-apis-app-ability-uiAbility.md
AbilityStage
js-apis-app-ability-abilityStage.md
Want
js-apis-app-ability-want.md
UIAbilityContext
js-apis-inner-application-uiAbilityContext.md
ApplicationContext
js-apis-inner-application-applicationContext.md
bundleManager
js-apis-bundleManager.md
Ability 错误码
errorcode-ability.md
Bundle 错误码
errorcode-bundle.md
主题文件路径
UIAbility
js-apis-app-ability-uiAbility.md
AbilityStage
js-apis-app-ability-abilityStage.md
Want
js-apis-app-ability-want.md
UIAbilityContext
js-apis-inner-application-uiAbilityContext.md
ApplicationContext
js-apis-inner-application-applicationContext.md
bundleManager
js-apis-bundleManager.md
Ability错误码
errorcode-ability.md
Bundle错误码
errorcode-bundle.md