订阅系统事件（崩溃事件）

HiAppEvent提供接口用于订阅系统崩溃事件。

接口说明

API接口的具体使用说明（参数使用限制、具体取值范围等）请参考应用事件打点API文档。

接口名 描述
addWatcher(watcher: Watcher): AppEventPackageHolder 添加应用事件观察者，以添加对应用事件的订阅。
removeWatcher(watcher: Watcher): void 移除应用事件观察者，以移除对应用事件的订阅。

崩溃事件信息中params属性的详细描述如下：

params属性：

名称 类型 说明
time number 事件触发时间，单位为毫秒。
crash_type string 崩溃类型。支持JsError和NativeCrash两种崩溃类型。
foreground boolean 应用是否处于前台状态。
bundle_version string 应用版本。
bundle_name string 应用名称。
pid number 应用的进程id。
uid number 应用的用户id。
uuid string 故障id。
exception object 异常信息，详见exception属性。NativeCrash类型的崩溃事件详见exception属性（NativeCrash类型）。
hilog string[] 日志信息。
threads object[] 全量线程调用栈，详见thread属性。仅NativeCrash类型的崩溃事件提供。

exception属性：

名称 类型 说明
name string 异常类型。
message string 异常原因。
stack string 异常调用栈。

exception属性（NativeCrash类型）：

名称 类型 说明
message string 异常原因。
signal object 信号信息，详见signal属性。
thread_name string 线程名。
tid number 线程id。
frames object[] 线程调用栈，详见frame属性。

signal属性：

名称 类型 说明
signo number 信号值。
code number 信号错误码。

thread属性：

名称 类型 说明
thread_name string 线程名。
tid number 线程id。
frames object[] 线程调用栈，详见frame属性。

frame属性：

名称 类型 说明
symbol string 函数名称。
file string 文件名。
buildId string 文件唯一标识。
pc string pc寄存器地址。
offset number 函数偏移量。

开发步骤

以实现对用户点击按钮触发崩溃场景生成的崩溃事件订阅为例，说明开发步骤。

  1. 编辑工程中的“entry > src > main > ets > entryability > EntryAbility.ets”文件，在onCreate函数中添加系统事件的订阅，完整示例代码如下：

     hiAppEvent.addWatcher({
   // 开发者可以自定义观察者名称，系统会使用名称来标识不同的观察者
   name: "watcher2",
   // 开发者可以订阅感兴趣的系统事件，此处是订阅了崩溃事件
   appEventFilters: [
     {
       domain: hiAppEvent.domain.OS,
       names: [hiAppEvent.event.APP_CRASH]
     }
   ],
   // 开发者可以自行实现订阅实时回调函数，以便对订阅获取到的事件数据进行自定义处理
   onReceive: (domain: string, appEventGroups: Array<hiAppEvent.AppEventGroup>) => {
     hilog.info(0x0000, 'testTag', `HiAppEvent onReceive: domain=${domain}`);
     for (const eventGroup of appEventGroups) {
       // 开发者可以根据事件集合中的事件名称区分不同的系统事件
       hilog.info(0x0000, 'testTag', `HiAppEvent eventName=${eventGroup.name}`);
       for (const eventInfo of eventGroup.appEventInfos) {
         // 开发者可以对事件集合中的事件数据进行自定义处理，此处是将事件数据打印在日志中
         hilog.info(0x0000, 'testTag', `HiAppEvent eventInfo.domain=${eventInfo.domain}`);
         hilog.info(0x0000, 'testTag', `HiAppEvent eventInfo.name=${eventInfo.name}`);
         hilog.info(0x0000, 'testTag', `HiAppEvent eventInfo.eventType=${eventInfo.eventType}`);
         // 开发者可以获取到崩溃事件发生的时间戳
         hilog.info(0x0000, 'testTag', `HiAppEvent eventInfo.params.time=${eventInfo.params['time']}`);
         // 开发者可以获取到崩溃事件发生的崩溃类型
         hilog.info(0x0000, 'testTag', `HiAppEvent eventInfo.params.crash_type=${eventInfo.params['crash_type']}`);
         // 开发者可以获取到崩溃应用的前后台状态
         hilog.info(0x0000, 'testTag', `HiAppEvent eventInfo.params.foreground=${eventInfo.params['foreground']}`);
         // 开发者可以获取到崩溃应用的版本信息
         hilog.info(0x0000, 'testTag', `HiAppEvent eventInfo.params.bundle_version=${eventInfo.params['bundle_version']}`);
         // 开发者可以获取到崩溃应用的包名
         hilog.info(0x0000, 'testTag', `HiAppEvent eventInfo.params.bundle_name=${eventInfo.params['bundle_name']}`);
         // 开发者可以获取到崩溃应用的进程id
         hilog.info(0x0000, 'testTag', `HiAppEvent eventInfo.params.pid=${eventInfo.params['pid']}`);
         hilog.info(0x0000, 'testTag', `HiAppEvent eventInfo.params.uid=${eventInfo.params['uid']}`);
         hilog.info(0x0000, 'testTag', `HiAppEvent eventInfo.params.uuid=${eventInfo.params['uuid']}`);
         // 开发者可以获取到崩溃事件发生的异常类型、异常原因和异常调用栈
         hilog.info(0x0000, 'testTag', `HiAppEvent eventInfo.params.exception=${JSON.stringify(eventInfo.params['exception'])}`);
         // 开发者可以获取到崩溃事件发生时日志信息
         hilog.info(0x0000, 'testTag', `HiAppEvent eventInfo.params.hilog.size=${eventInfo.params['hilog'].length}`);
       }
     }
   }
 });

  2. 编辑工程中的“entry > src > main > ets > pages > Index.ets”文件，添加按钮并在其onClick函数构造崩溃场景，以触发崩溃事件，完整示例代码如下：

     Button("appCrash").onClick(()=>{
   // 在按钮点击函数中构造一个crash场景，触发应用崩溃事件
   let result: object = JSON.parse("");
 })

  3. 点击IDE界面中的运行按钮，运行应用工程，然后在应用界面中点击按钮“appCrash”，触发一次崩溃事件。

  4. 应用工程崩溃退出后再次运行可以在Log窗口看到对系统事件数据的处理日志：

    HiAppEvent onReceive: domain=OS
HiAppEvent eventName=APP_CRASH
HiAppEvent eventInfo.domain=OS
HiAppEvent eventInfo.name=APP_CRASH
HiAppEvent eventInfo.eventType=1
HiAppEvent eventInfo.params.time=1701836127566
HiAppEvent eventInfo.params.crash_type=JsError
HiAppEvent eventInfo.params.foreground=true
HiAppEvent eventInfo.params.bundle_version=1.0.0
HiAppEvent eventInfo.params.bundle_name=com.example.myapplication
HiAppEvent eventInfo.params.pid=2027
HiAppEvent eventInfo.params.uid=20010043
HiAppEvent eventInfo.params.uuid=...
HiAppEvent eventInfo.params.exception={"message":"Unexpected Text in JSON\\n","name":"SyntaxError\\n","stack":"\\n    at anonymous (entry/src/main/ets/pages/Index.ets:60:34)\\n"}
HiAppEvent eventInfo.params.hilog.size=100