鸿蒙开发:全局异常捕获和异常信息查看

程序员一鸣
• 阅读 70

前言

代码运行环境:全部基于HarmonyOs NEXT

DevEco Studio:Build Version: 5.0.3.910

API:12

modelVersion:5.0.0

开发中的异常信息,我们很容易排查,直接可以在控制台中就可以查看,但是,提交给测试同学或者上线后的异常信息,我们如何获取呢?这里我们很容易想起,三方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.3"}

初始化

建议在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

点赞
收藏
评论区
推荐文章
Wesley13 Wesley13
3年前
初探 Objective
作者:Cyandev,iOS和MacOS开发者,目前就职于字节跳动0x00前言异常处理是许多高级语言都具有的特性,它可以直接中断当前函数并将控制权转交给能够处理异常的函数。不同语言在异常处理的实现上各不相同,本文主要来分析一下ObjectiveC和C这两个语言。为什么要把ObjectiveC和
小万哥 小万哥
1年前
C++ 异常处理机制详解:轻松掌握异常处理技巧
C异常处理C异常处理机制允许程序在运行时处理错误或意外情况。它提供了捕获和处理错误的一种结构化方式,使程序更加健壮和可靠。异常处理的基本概念:异常:程序在运行时发生的错误或意外情况。抛出异常:使用throw关键字将异常传递给调用堆栈。捕获异常:使用
融云IM即时通讯 融云IM即时通讯
7个月前
融云IM干货丨IM服务,在开发过程中,如何自动化处理SDK日志中的错误码
在开发过程中,自动化处理SDK日志中的错误码可以通过以下几个步骤实现:错误码解析:利用SDK提供的错误码对照表,将错误码映射到具体的错误信息和解决方案。例如,阿里云日志服务提供了详细的错误码对照表及对应的解决方法。异常捕获与处理:SDK通常会抛出异常来处理
飞龙AI 飞龙AI
1个月前
DevEcoStudio 中使用模拟器时如何过滤日志
DevEcoStudio中使用模拟器时如何过滤日志鸿蒙核心技术鸿蒙开发者工具DevEcoStudio在HilogSettingsFilter设置Logmessage:A03d00/JSAPP当你看到不断更新的日志时,你会不会崩溃因为Nofilters模式下
布局王 布局王
2星期前
Uniapp开发鸿蒙应用时如何运行和调试项目
经过前几天的分享,大家应该应该对uniapp开发鸿蒙应用的开发语法有了一定的了解,可以进行一些简单的应用开发,今天分享一下在使用uniapp开发鸿蒙应用时怎么运行到鸿蒙设备,并且在开发中怎么调试程序。运行Uniapp项目支持运行到鸿蒙真机和模拟器,不过在这
GeorgeGcs GeorgeGcs
2星期前
【HarmonyOS NEXT】鸿蒙应用实现手机摇一摇功能
鸿蒙开发能力HarmonyOSSDK应用服务鸿蒙金融类应用(金融理财一、前言手机摇一摇功能,是通过获取手机设备,加速度传感器接口,获取其中的数值,进行逻辑判断实现的功能。在鸿蒙中手机设备传感器@ohos.sensor(传感器)的系统API监听有以下:@oh
GeorgeGcs GeorgeGcs
2星期前
【HarmonyOS 5】鸿蒙应用代码控制横竖屏切换,自动切换横竖屏,监听横竖屏以及注意事项
鸿蒙开发能力HarmonyOSSDK应用服务鸿蒙金融类应用(金融理财一、鸿蒙应用如何进行页面横竖屏调用API手动切换1.首先要在EntryAbility中获取主窗口对象EntryAbility.etsimportAbilityConstant,UIAbil
GeorgeGcs GeorgeGcs
2星期前
【HarmonyOS 5】鸿蒙中的UIAbility详解(二)
鸿蒙开发能力HarmonyOSSDK应用服务鸿蒙金融类应用(金融理财一、前言今天我们继续深入讲解UIAbility,根据下图可知,在鸿蒙中UIAbility继承于Ability,开发者无法直接继承Ability。只能使用其两个子类:UIAbility和Ex
GeorgeGcs GeorgeGcs
2星期前
【HarmonyOS 5】鸿蒙的装饰器原理和自定义装饰器
鸿蒙开发能力HarmonyOSSDK应用服务鸿蒙金融类应用(金融理财一、鸿蒙中的装饰器是什么?在ArkTS中装饰器(Decorator)是一种特殊的声明,能够对类、方法、属性等进行标注和修改。因为ArkTS是TypeScript扩展而来的编程语言,Type
GeorgeGcs GeorgeGcs
2星期前
【HarmonyOS 5】鸿蒙用户头像编辑功能实践
鸿蒙开发能力HarmonyOSSDK应用服务鸿蒙金融类应用(金融理财一、前言1、应用背景在鸿蒙化开发过程中,我们发现最基本常见的功能用户头像的编辑,实现方式和Android与IOS有极大的不同。在实际开发和调研的过程中,我们发现并总结了鸿蒙隐私处理与业内A