• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# 订阅应用冻屏事件（ArkTS）
2
3<!--Kit: Performance Analysis Kit-->
4<!--Subsystem: HiviewDFX-->
5<!--Owner: @rr_cn-->
6<!--Designer: @peterhuangyu-->
7<!--Tester: @gcw_KuLfPSbe-->
8<!--Adviser: @foryourself-->
9
10## 简介
11
12本文介绍如何使用HiAppEvent提供的ArkTS接口订阅应用无响应事件。接口的详细使用说明（参数限制、取值范围等）请参考[@ohos.hiviewdfx.hiAppEvent (应用事件打点)ArkTS API文档](../reference/apis-performance-analysis-kit/js-apis-hiviewdfx-hiappevent.md)。
13
14## 接口说明
15
16| 接口名 | 描述 |
17| -------- | -------- |
18| addWatcher(watcher: Watcher): AppEventPackageHolder | 添加应用事件观察者，以添加对应用事件的订阅。 |
19| removeWatcher(watcher: Watcher): void | 移除应用事件观察者，以移除对应用事件的订阅。 |
20
21## 开发步骤
22
23### 添加事件观察者
24
25以实现对用户点击按钮触发应用无响应场景生成的应用冻屏事件订阅为例，说明开发步骤。
26
271. 新建一个ArkTS应用工程，编辑工程中的“entry > src > main > ets  > entryability > EntryAbility.ets”文件，导入依赖模块，示例代码如下：
28
29   ```ts
30   import { BusinessError } from '@kit.BasicServicesKit';
31   import { hiAppEvent, hilog } from '@kit.PerformanceAnalysisKit';
32   ```
33
342. 编辑工程中的“entry > src > main > ets  > entryability > EntryAbility.ets”文件，在onCreate函数中设置事件的自定义参数，示例代码如下：
35
36   ```ts
37    // 开发者完成参数键值对赋值
38    let params: Record<string, hiAppEvent.ParamType> = {
39      "test_data": 100,
40    };
41    // 开发者可以设置应用冻屏事件的自定义参数
42    hiAppEvent.setEventParam(params, hiAppEvent.domain.OS, hiAppEvent.event.APP_FREEZE).then(() => {
43      hilog.info(0x0000, 'testTag', `HiAppEvent success to set event param`);
44    }).catch((err: BusinessError) => {
45      hilog.error(0x0000, 'testTag', `HiAppEvent code: ${err.code}, message: ${err.message}`);
46    });
47   ```
48
493. 编辑工程中的“entry > src > main > ets  > entryability > EntryAbility.ets”文件，在onCreate函数中添加系统事件的订阅，示例代码如下：
50
51   ```ts
52     hiAppEvent.addWatcher({
53      // 开发者可以自定义观察者名称，系统会使用名称来标识不同的观察者
54      name: "watcher",
55      // 开发者可以订阅感兴趣的系统事件，此处是订阅了应用冻屏事件
56      appEventFilters: [
57        {
58          domain: hiAppEvent.domain.OS,
59          names: [hiAppEvent.event.APP_FREEZE]
60        }
61      ],
62      // 开发者可以自行实现订阅实时回调函数，以便对订阅获取到的事件数据进行自定义处理
63      onReceive: (domain: string, appEventGroups: Array<hiAppEvent.AppEventGroup>) => {
64        hilog.info(0x0000, 'testTag', `HiAppEvent onReceive: domain=${domain}`);
65        for (const eventGroup of appEventGroups) {
66          // 开发者可以根据事件集合中的事件名称区分不同的系统事件
67          hilog.info(0x0000, 'testTag', `HiAppEvent eventName=${eventGroup.name}`);
68          for (const eventInfo of eventGroup.appEventInfos) {
69            // 开发者可以对事件集合中的事件数据进行自定义处理，此处是将事件数据打印在日志中
70            hilog.info(0x0000, 'testTag', `HiAppEvent eventInfo.domain=${eventInfo.domain}`);
71            hilog.info(0x0000, 'testTag', `HiAppEvent eventInfo.name=${eventInfo.name}`);
72            hilog.info(0x0000, 'testTag', `HiAppEvent eventInfo.eventType=${eventInfo.eventType}`);
73            // 开发者可以获取到应用冻屏事件发生的时间戳
74            hilog.info(0x0000, 'testTag', `HiAppEvent eventInfo.params.time=${eventInfo.params['time']}`);
75            // 开发者可以获取到应用冻屏事件发生时应用的前后台状态
76            hilog.info(0x0000, 'testTag', `HiAppEvent eventInfo.params.foreground=${eventInfo.params['foreground']}`);
77            // 开发者可以获取到应用冻屏事件发生时应用的版本信息
78            hilog.info(0x0000, 'testTag', `HiAppEvent eventInfo.params.bundle_version=${eventInfo.params['bundle_version']}`);
79            // 开发者可以获取到应用冻屏事件发生时应用的包名
80            hilog.info(0x0000, 'testTag', `HiAppEvent eventInfo.params.bundle_name=${eventInfo.params['bundle_name']}`);
81            // 开发者可以获取到应用冻屏事件发生时应用的进程名称
82            hilog.info(0x0000, 'testTag', `HiAppEvent eventInfo.params.process_name=${eventInfo.params['process_name']}`);
83            // 开发者可以获取到应用冻屏事件发生时应用的进程id
84            hilog.info(0x0000, 'testTag', `HiAppEvent eventInfo.params.pid=${eventInfo.params['pid']}`);
85            hilog.info(0x0000, 'testTag', `HiAppEvent eventInfo.params.uid=${eventInfo.params['uid']}`);
86            hilog.info(0x0000, 'testTag', `HiAppEvent eventInfo.params.uuid=${eventInfo.params['uuid']}`);
87            // 开发者可以获取到应用冻屏事件发生的异常类型、异常原因
88            hilog.info(0x0000, 'testTag', `HiAppEvent eventInfo.params.exception=${JSON.stringify(eventInfo.params['exception'])}`);
89            // 开发者可以获取到应用冻屏事件发生时日志信息
90            hilog.info(0x0000, 'testTag', `HiAppEvent eventInfo.params.hilog.size=${eventInfo.params['hilog'].length}`);
91            // 开发者可以获取到应用冻屏事件发生时主线程未处理消息
92            hilog.info(0x0000, 'testTag', `HiAppEvent eventInfo.params.event_handler.size=${eventInfo.params['event_handler'].length}`);
93            hilog.info(0x0000, 'testTag', `HiAppEvent eventInfo.params.event_handler_size_3s=${eventInfo.params['event_handler_size_3s']}`);
94            hilog.info(0x0000, 'testTag', `HiAppEvent eventInfo.params.event_handler_size_6s=${eventInfo.params['event_handler_size_6s']}`);
95            // 开发者可以获取到应用冻屏事件发生时同步binder调用信息
96            hilog.info(0x0000, 'testTag', `HiAppEvent eventInfo.params.peer_binder.size=${eventInfo.params['peer_binder'].length}`);
97            // 开发者可以获取到应用冻屏事件发生时全量线程调用栈
98            hilog.info(0x0000, 'testTag', `HiAppEvent eventInfo.params.threads.size=${eventInfo.params['threads'].length}`);
99            // 开发者可以获取到应用冻屏事件发生时内存信息
100            hilog.info(0x0000, 'testTag', `HiAppEvent eventInfo.params.memory=${JSON.stringify(eventInfo.params['memory'])}`);
101            // 开发者可以获取到应用冻屏事件发生时的故障日志文件
102            hilog.info(0x0000, 'testTag', `HiAppEvent eventInfo.params.external_log=${JSON.stringify(eventInfo.params['external_log'])}`);
103            hilog.info(0x0000, 'testTag', `HiAppEvent eventInfo.params.log_over_limit=${eventInfo.params['log_over_limit']}`);
104            // 开发者可以获取到应用冻屏事件的自定义数据test_data
105            hilog.info(0x0000, 'testTag', `HiAppEvent eventInfo.params.test_data=${eventInfo.params['test_data']}`);
106          }
107        }
108      }
109    });
110   ```
111
1124. 编辑工程中的“entry > src > main > ets  > pages > Index.ets”文件，添加按钮并在其onClick函数构造应用无响应场景，以触发应用冻屏事件，示例代码如下：
113
114   ```ts
115    Button("appFreeze").onClick(()=>{
116      // 在按钮点击函数中构造一个freeze场景，触发应用冻屏事件
117      setTimeout(() => {
118        let t = Date.now();
119        while (Date.now() - t <= 15000) {}
120      }, 5000);
121    })
122   ```
123
1245. 点击DevEco Studio界面中的运行按钮，运行应用工程，然后在应用界面中点击按钮“appFreeze”，触发一次应用冻屏事件。
125
126### 验证观察者是否订阅到应用冻屏事件
127
1281. 应用无响应退出后，重新进入应用可以在Log窗口看到对系统事件数据的处理日志：
129
130   ```text
131   HiAppEvent onReceive: domain=OS
132   HiAppEvent eventName=APP_FREEZE
133   HiAppEvent eventInfo.domain=OS
134   HiAppEvent eventInfo.name=APP_FREEZE
135   HiAppEvent eventInfo.eventType=1
136   HiAppEvent eventInfo.params.time=1711440881768
137   HiAppEvent eventInfo.params.foreground=true
138   HiAppEvent eventInfo.params.bundle_version=1.0.0
139   HiAppEvent eventInfo.params.bundle_name=com.example.myapplication
140   HiAppEvent eventInfo.params.process_name=com.example.myapplication
141   HiAppEvent eventInfo.params.pid=3197
142   HiAppEvent eventInfo.params.uid=20010043
143   HiAppEvent eventInfo.params.uuid=27fac7098da46efe1cae9904946ec06c5acc91689c365efeefb7a23a0c37df77
144   HiAppEvent eventInfo.params.exception={"message":"App main thread is not response!","name":"THREAD_BLOCK_6S"}
145   HiAppEvent eventInfo.params.hilog.size=77
146   HiAppEvent eventInfo.params.event_handler.size=6
147   HiAppEvent eventInfo.params.event_handler_size_3s=5
148   HiAppEvent eventInfo.params.event_handler_size_6s=6
149   HiAppEvent eventInfo.params.peer_binder.size=0
150   HiAppEvent eventInfo.params.threads.size=28
151   HiAppEvent eventInfo.params.memory={"pss":0,"rss":0,"sys_avail_mem":1361464,"sys_free_mem":796232,"sys_total_mem":1992340,"vss":0}
152   HiAppEvent eventInfo.params.external_log=["/data/storage/el2/log/hiappevent/APP_FREEZE_1711440899240_3197.log"]
153   HiAppEvent eventInfo.params.log_over_limit=false
154   HiAppEvent eventInfo.params.test_data=100
155   ```
156
157<!--RP1-->
158<!--RP1End-->
159