鸿蒙开发：实现全局异常捕获和异常查看

前言

开发中的异常信息，我们很容易排查，直接可以在控制台中就可以查看，但是，提交给测试同学或者上线后的异常信息，我们如何获取呢？这里我们很容易想起，三方sdk，比如常见的腾讯Bugly，通过集成它，便可以收集应用的异常信息，直接在他们的后台，我们就可以排查到异常，便于我们进行针对性的解决；使用三方，很是便捷，我们也无须考虑服务器的问题，但是，需要我们付出一定的资金，即便一直免费的Bugly目前还未收费，但从官网去看，已经朝着收费的方向前进了。

收费是一方面，如何灵活的拿到错误信息后，执行我们想要的逻辑，也是自研的一个诉求，比如全局监听到异常后，重启应用，或者上传到自己的服务器，或者可以在应用内查看等等，实现一个全局异常捕获，确实有很多的有用之处。

鸿蒙中，如何实现呢？

实现起来很是简单，直接使用errorManager对象，注册监听即可，ErrorManager可以提供对错误观察器的注册和注销的能力，建议在主EntryAbility或者AbilityStage中。

异常监听功能介绍：

接口名称	说明
onUnhandledException(errMsg: string): void	系统回调接口，应用注册后，当应用产生未捕获的异常时的回调。
onException?(errObject: Error): void	系统回调接口，应用注册后，当应用产生异常上报JS层时的回调。

简单举例如下：

errorManager.on('error', {
  onUnhandledException: (errMsg) => {
    console.log('产生未捕获异常时的回调，onUnhandledException:', errMsg);
  },
  onException: (errorObj) => {
    console.log('产生异常上报JS层时的回调，onException');
  
  }
})

当有异常信息发生时，就会走以上的监听，需要注意，注册后可以捕获到应用产生的js crash，应用崩溃时进程不会退出。

除了注册之外，系统还提供了注销错误观测器，可以在onDestroy声明周期中进行。registerId就是注册时的id，可以直接赋值errorManager.on(）。

errorManager.off('error', registerId, (result) => { 
     
    }); 

以上的部分，我们只是实现了异常的监听，我们可以在上述中的方法中，进行针对的拓展，比如，异常信息存储到本地，或者上传到服务器，或者定制开发相关的异常UI查看等等，目前这些功能，我做了一层封装，希望可以帮助需要的朋友。

本文主要内容如下：

1、封装之后的catch库效果

2、catch库快速引入

3、catch库主要实现

---

一、封装之后的catch库效果

目前除了提供了全局异常捕获方法之外，还提供了异常查看UI，方便测试人员或者其他人员遇到异常之后，可以快速的分享给研发人员。

二、catch库快速引入

引入

方式一：在Terminal窗口中，执行如下命令安装三方包，DevEco Studio会自动在工程的oh-package.json5中自动添加三方包依赖。

建议：在使用的模块路径下进行执行命令。

ohpm install @abner/catch

方式二：在工程的oh-package.json5中设置三方包依赖，配置示例如下：

"dependencies": { "@abner/catch": "^1.0.0"}

初始化

建议在AbilityStage里或者主入口的UIAbility进行初始化。

onHandledException({
  context: this.context,//上下文
  onExceptionBack: (exception) => {
    //自己收集异常信息上报，比如上报到服务器或者三方
  }
})

属性介绍

属性	类型	概述
context	Context	上下文， 用于数据库和文化存储读取
isExceptionSave	boolean	异常信息是否保存到本地，默认保存
isFileSave	boolean	是否以文件形式保存，默认是数据库，true：文件，fasle：数据库
faultType	FaultLogger.FaultType	异常类型，NO\_SPECIFIC 不区分故障类型（默认既是），CPP\_CRASH C++程序故障类型，JS\_CRASH JS程序故障类型，APP\_FREEZE 应用程序卡死故障类型
isExceptionIntercept	boolean	异常信息是否拦截，默认true拦截,false不拦截，不拦截，不会走回调，也不会保存异常信息
onExceptionBack	回调函数	回调函数，返回异常信息，可以在这里进行上报

关闭全局异常

onExceptionDestroy()

查看异常信息

如果你想本地查看全局异常信息，可以在使用的地方进行调用，就会弹出异常列表页面。

点击条目：查看异常详情，左滑条目：可以删除此条异常信息，右上角点击清空：可以删除所有的异常信息

openExceptionDialog()

异常上报

如果你想自己拿到异常信息，进行上报到自己服务器或者三方，或者自行处理，可以在初始化中实现onExceptionBack回调。

三、catch库主要实现

其实catch库仅仅针对系统的全局异常做了一层封装，实现了本地异常信息的存储，实现文件形式存储和本地数据库形式存储，其它的暂无拓展。

文件存储，大家可以关注文件管理模块fs，数据库可以关注关系型数据库relationalStore。

中心仓库地址：https://ohpm.openharmony.cn/#/cn/detail/@abner%2Fcatch