1# 订阅崩溃事件（ArkTS）
2
3## 接口说明
4
5API接口的具体使用说明（参数使用限制、具体取值范围等）请参考[应用事件打点API文档](../reference/apis-performance-analysis-kit/js-apis-hiviewdfx-hiappevent.md)。
6
7> **说明：**
8>
9> 使用ArkTS接口订阅崩溃事件，包含JsError和NativeCrash两种崩溃类型。
10
11**事件自定义参数设置接口功能介绍：**
12
13| 接口名                                              | 描述                                         |
14| --------------------------------------------------- | -------------------------------------------- |
15| setEventParam(params: Record<string, ParamType>, domain: string, name?: string): Promise<void> | 事件自定义参数设置方法。 |
16
17**订阅接口功能介绍：**
18
19| 接口名                                              | 描述                                         |
20| --------------------------------------------------- | -------------------------------------------- |
21| addWatcher(watcher: Watcher): AppEventPackageHolder | 添加应用事件观察者，以添加对应用事件的订阅。 |
22| removeWatcher(watcher: Watcher): void               | 移除应用事件观察者，以移除对应用事件的订阅。 |
23
24## 开发步骤
25
26以实现对用户点击按钮触发崩溃场景生成的崩溃事件订阅为例，说明开发步骤。
27
281. 新建一个ArkTS应用工程，编辑工程中的“entry > src > main > ets  > entryability > EntryAbility.ets”文件，导入依赖模块：
29
30   ```ts
31   import { BusinessError } from '@kit.BasicServicesKit';
32   import { hiAppEvent, hilog } from '@kit.PerformanceAnalysisKit';
33   ```
34
352. 编辑工程中的“entry > src > main > ets  > entryability > EntryAbility.ets”文件，在onCreate函数中设置事件的自定义参数，示例代码如下：
36
37   ```ts
38    // 开发者完成参数键值对赋值
39    let params: Record<string, hiAppEvent.ParamType> = {
40      "test_data": 100,
41    };
42    // 开发者可以设置崩溃事件的自定义参数
43    hiAppEvent.setEventParam(params, hiAppEvent.domain.OS, hiAppEvent.event.APP_CRASH).then(() => {
44      hilog.info(0x0000, 'testTag', `HiAppEvent success to set svent param`);
45    }).catch((err: BusinessError) => {
46      hilog.error(0x0000, 'testTag', `HiAppEvent code: ${err.code}, message: ${err.message}`);
47    });
48   ```
49
503. 编辑工程中的“entry > src > main > ets  > entryability > EntryAbility.ets”文件，在onCreate函数中添加系统事件的订阅，示例代码如下：
51
52   ```ts
53    hiAppEvent.addWatcher({
54      // 开发者可以自定义观察者名称，系统会使用名称来标识不同的观察者
55      name: "watcher",
56      // 开发者可以订阅感兴趣的系统事件，此处是订阅了崩溃事件
57      appEventFilters: [
58        {
59          domain: hiAppEvent.domain.OS,
60          names: [hiAppEvent.event.APP_CRASH]
61        }
62      ],
63      // 开发者可以自行实现订阅实时回调函数，以便对订阅获取到的事件数据进行自定义处理
64      onReceive: (domain: string, appEventGroups: Array<hiAppEvent.AppEventGroup>) => {
65        hilog.info(0x0000, 'testTag', `HiAppEvent onReceive: domain=${domain}`);
66        for (const eventGroup of appEventGroups) {
67          // 开发者可以根据事件集合中的事件名称区分不同的系统事件
68          hilog.info(0x0000, 'testTag', `HiAppEvent eventName=${eventGroup.name}`);
69          for (const eventInfo of eventGroup.appEventInfos) {
70            // 开发者可以对事件集合中的事件数据进行自定义处理，此处是将事件数据打印在日志中
71            hilog.info(0x0000, 'testTag', `HiAppEvent eventInfo.domain=${eventInfo.domain}`);
72            hilog.info(0x0000, 'testTag', `HiAppEvent eventInfo.name=${eventInfo.name}`);
73            hilog.info(0x0000, 'testTag', `HiAppEvent eventInfo.eventType=${eventInfo.eventType}`);
74            // 开发者可以获取到崩溃事件发生的时间戳
75            hilog.info(0x0000, 'testTag', `HiAppEvent eventInfo.params.time=${eventInfo.params['time']}`);
76            // 开发者可以获取到崩溃事件发生的崩溃类型
77            hilog.info(0x0000, 'testTag', `HiAppEvent eventInfo.params.crash_type=${eventInfo.params['crash_type']}`);
78            // 开发者可以获取到崩溃应用的前后台状态
79            hilog.info(0x0000, 'testTag', `HiAppEvent eventInfo.params.foreground=${eventInfo.params['foreground']}`);
80            // 开发者可以获取到崩溃应用的版本信息
81            hilog.info(0x0000, 'testTag', `HiAppEvent eventInfo.params.bundle_version=${eventInfo.params['bundle_version']}`);
82            // 开发者可以获取到崩溃应用的包名
83            hilog.info(0x0000, 'testTag', `HiAppEvent eventInfo.params.bundle_name=${eventInfo.params['bundle_name']}`);
84            // 开发者可以获取到崩溃应用的进程id
85            hilog.info(0x0000, 'testTag', `HiAppEvent eventInfo.params.pid=${eventInfo.params['pid']}`);
86            hilog.info(0x0000, 'testTag', `HiAppEvent eventInfo.params.uid=${eventInfo.params['uid']}`);
87            hilog.info(0x0000, 'testTag', `HiAppEvent eventInfo.params.uuid=${eventInfo.params['uuid']}`);
88            // 开发者可以获取到崩溃事件发生的异常类型、异常原因和异常调用栈
89            hilog.info(0x0000, 'testTag', `HiAppEvent eventInfo.params.exception=${JSON.stringify(eventInfo.params['exception'])}`);
90            // 开发者可以获取到崩溃事件发生时日志信息
91            hilog.info(0x0000, 'testTag', `HiAppEvent eventInfo.params.hilog.size=${eventInfo.params['hilog'].length}`);
92            // 开发者可以获取到崩溃事件发生时的故障日志文件
93            hilog.info(0x0000, 'testTag', `HiAppEvent eventInfo.params.external_log=${JSON.stringify(eventInfo.params['external_log'])}`);
94            hilog.info(0x0000, 'testTag', `HiAppEvent eventInfo.params.log_over_limit=${eventInfo.params['log_over_limit']}`);
95            // 开发者可以获取到崩溃事件的自定义数据test_data
96            hilog.info(0x0000, 'testTag', `HiAppEvent eventInfo.params.test_data=${eventInfo.params['test_data']}`);
97          }
98        }
99      }
100    });
101   ```
102
1034. 编辑工程中的“entry > src > main > ets  > pages > Index.ets”文件，添加按钮并在其onClick函数构造崩溃场景，以触发崩溃事件，示例代码如下：
104
105   ```ts
106    Button("appCrash").onClick(()=>{
107      // 在按钮点击函数中构造一个crash场景，触发应用崩溃事件
108      let result: object = JSON.parse("");
109    })
110   ```
111
1125. 点击DevEco Studio界面中的运行按钮，运行应用工程，然后在应用界面中点击按钮“appCrash”，触发一次崩溃事件。崩溃事件发生后，系统会根据崩溃类型（JsError或NativeCrash）采用不同的栈回溯方式生成崩溃日志，然后再进行回调。其中NativeCrash栈回溯耗时约2秒，实际耗时与业务线程数量、进程间通信耗时有关。JsError触发进程内栈回溯，NativeCrash触发进程外栈回溯，因此NativeCrash栈回溯会比JsError栈回溯更耗时。用户可以订阅崩溃事件，栈回溯完成后会异步上报，不会阻塞当前业务。
113
1146. 下次应用启动后，HiAppEvent将崩溃事件上报给应用已注册的监听，完成回调。并可以在Log窗口看到对系统事件数据的处理日志：
115
116   ```text
117   HiAppEvent onReceive: domain=OS
118   HiAppEvent eventName=APP_CRASH
119   HiAppEvent eventInfo.domain=OS
120   HiAppEvent eventInfo.name=APP_CRASH
121   HiAppEvent eventInfo.eventType=1
122   HiAppEvent eventInfo.params.time=1711440614001
123   HiAppEvent eventInfo.params.crash_type=JsError
124   HiAppEvent eventInfo.params.foreground=true
125   HiAppEvent eventInfo.params.bundle_version=1.0.0
126   HiAppEvent eventInfo.params.bundle_name=com.example.myapplication
127   HiAppEvent eventInfo.params.pid=2043
128   HiAppEvent eventInfo.params.uid=20010043
129   HiAppEvent eventInfo.params.uuid=b1e953ba0022c112e4502e28e8b3ad6d95cf3c87bae74068038f03b38ce7f66a
130   HiAppEvent eventInfo.params.exception={"message":"Unexpected Text in JSON","name":"SyntaxError","stack":"at anonymous (entry/src/main/ets/pages/Index.ets:55:34)"}
131   HiAppEvent eventInfo.params.hilog.size=90
132   HiAppEvent eventInfo.params.external_log=["/data/storage/el2/log/hiappevent/APP_CRASH_1711440614112_2043.log"]
133   HiAppEvent eventInfo.params.log_over_limit=false
134   HiAppEvent eventInfo.params.test_data=100
135   ```
136
137<!--RP1-->
138<!--RP1End-->