文档管理中心
您当前正在浏览HarmonyOS最新文档,覆盖已发布的所有API版本,可在API参考中筛选您使用的API版本。详细的版本配套关系请参考版本说明

ErrorObserver

定义异常监听,可以作为errorManager.on('error')的入参监听当前应用发生的异常。通过异常监听,开发者可以及时捕获和处理应用运行时的未捕获异常及JS层上报的异常,提升应用的稳定性和用户体验。

说明

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

导入模块

PhonePC/2in1TabletTVWearable
import { errorManager } from '@kit.AbilityKit';

ErrorObserver.onUnhandledException

PhonePC/2in1TabletTVWearable

onUnhandledException(errMsg: string): void

应用产生未捕获的异常时的回调。当应用代码发生未捕获的异常时,系统会自动调用此方法,将异常信息传递给开发者进行处理。

ErrorObserver.onException的差异在于:onUnhandledException仅捕获未处理的异常,参数仅包含错误消息字符串;而onException会捕获所有上报到JS层的异常,参数为完整的Error对象,包含name、message、stack等更多信息。建议在需要完整错误信息时使用onException,仅需简单错误消息时使用onUnhandledException。二者可组合使用。

元服务API:从API version 11开始,该接口支持在元服务中使用。

系统能力:SystemCapability.Ability.AbilityRuntime.Core

参数:

展开
参数名 类型 必填 说明
errMsg string 有关异常的消息和错误堆栈跟踪。

示例:

import { errorManager } from '@kit.AbilityKit';
import { BusinessError } from '@kit.BasicServicesKit';

let observer: errorManager.ErrorObserver = {
  onUnhandledException(errorMsg) {
    console.error('onUnhandledException, errorMsg: ', errorMsg);
  }
};

try {
  errorManager.on('error', observer);
} catch (error) {
  console.error(`registerErrorObserver failed, error.code: ${(error as BusinessError).code}, error.message: ${(error as BusinessError).message}`);
}

ErrorObserver.onException10+

PhonePC/2in1TabletTVWearable

onException?(errObject: Error): void

应用产生异常,上报js层时的回调。此回调为可选方法,若未实现,将使用系统默认异常处理逻辑。

可与ErrorObserver.onUnhandledException的配合使用,通过errorManager.on('error')注册ErrorObserver对象来实现异常监听。

建议同时实现两个回调方法,用于获取完整的异常信息。

元服务API:从API version 11开始,该接口支持在元服务中使用。

系统能力:SystemCapability.Ability.AbilityRuntime.Core

参数:

展开
参数名 类型 必填 说明
errObject Error 有关异常事件名字、消息和错误堆栈信息的对象。

示例:

import { errorManager } from '@kit.AbilityKit';
import { BusinessError } from '@kit.BasicServicesKit';

let observer: errorManager.ErrorObserver = {
  onUnhandledException(errorMsg) {
    console.error('onUnhandledException, errorMsg: ', errorMsg);
  },
  onException(errorObj) {
    console.error('onException, name: ', errorObj.name);
    console.error('onException, message: ', errorObj.message);
    if (typeof (errorObj.stack) === 'string') {
      console.error('onException, stack: ', errorObj.stack);
    }
  }
};

try {
  errorManager.on('error', observer);
} catch (error) {
  console.error(`registerErrorObserver failed, error.code: ${(error as BusinessError).code}, error.message: ${(error as BusinessError).message}`);
}
在 API参考 中进行搜索
请输入您想要搜索的关键词