1# 订阅主线程超时事件（C/C++）
2
3## 接口说明
4
5API接口的具体使用说明（参数使用限制、具体取值范围等）请参考[HiAppEvent](../reference/apis-performance-analysis-kit/_hi_app_event.md#hiappevent)。
6
7**订阅接口功能介绍：**
8
9| 接口名                                                       | 描述                                         |
10| ------------------------------------------------------------ | -------------------------------------------- |
11| int OH_HiAppEvent_AddWatcher(HiAppEvent_Watcher *watcher)   | 添加应用事件观察者，以添加对应用事件的订阅。 |
12| int OH_HiAppEvent_RemoveWatcher(HiAppEvent_Watcher *watcher） | 移除应用事件观察者，以移除对应用事件的订阅。 |
13
14## 开发步骤
15
161. 新建Native C++工程，并将jsoncpp导入到新建工程内，目录结构如下：
17
18   ```yml
19   entry:
20     src:
21       main:
22         cpp:
23           - json:
24               - json.h
25               - json-forwards.h
26           - types:
27               libentry:
28                 - index.d.ts
29           - CMakeLists.txt
30           - napi_init.cpp
31           - jsoncpp.cpp
32         ets:
33           - entryability:
34               - EntryAbility.ets
35           - pages:
36               - Index.ets
37   ```
38
392. 编辑"CMakeLists.txt"文件，添加源文件及动态库：
40
41   ```cmake
42   # 新增jsoncpp.cpp(解析订阅事件中的json字符串)源文件
43   add_library(entry SHARED napi_init.cpp jsoncpp.cpp)
44   # 新增动态库依赖libhiappevent_ndk.z.so和libhilog_ndk.z.so(日志输出)
45   target_link_libraries(entry PUBLIC libace_napi.z.so libhilog_ndk.z.so libhiappevent_ndk.z.so)
46   ```
47
483. 编辑"napi_init.cpp"文件，导入依赖的文件，并定义LOG_TAG：
49
50   ```c++
51   #include "napi/native_api.h"
52   #include "json/json.h"
53   #include "hilog/log.h"
54   #include "hiappevent/hiappevent.h"
55   #include "hiappevent/hiappevent_event.h"
56   #undef LOG_TAG
57   #define LOG_TAG "testTag"
58   ```
59
604. 订阅系统事件：
61
62    - onReceive类型观察者：
63
64      编辑"napi_init.cpp"文件，定义onReceive类型观察者相关方法：
65
66      ```c++
67      //定义一变量，用来缓存创建的观察者的指针。
68      static HiAppEvent_Watcher *systemEventWatcher;
69
70      static void OnReceive(const char *domain, const struct HiAppEvent_AppEventGroup *appEventGroups, uint32_t groupLen) {
71          for (int i = 0; i < groupLen; ++i) {
72              for (int j = 0; j < appEventGroups[i].infoLen; ++j) {
73                  OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.domain=%{public}s",
74                              appEventGroups[i].appEventInfos[j].domain);
75                  OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.name=%{public}s",
76                              appEventGroups[i].appEventInfos[j].name);
77                  OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.eventType=%{public}d",
78                              appEventGroups[i].appEventInfos[j].type);
79                  if (strcmp(appEventGroups[i].appEventInfos[j].domain, DOMAIN_OS) == 0 &&
80                      strcmp(appEventGroups[i].appEventInfos[j].name, EVENT_MAIN_THREAD_JANK) == 0) {
81                      Json::Value params;
82                      Json::Reader reader(Json::Features::strictMode());
83                      Json::FastWriter writer;
84                      if (reader.parse(appEventGroups[i].appEventInfos[j].params, params)) {
85                          auto time = params["time"].asInt64();
86                          auto pid = params["pid"].asInt();
87                          auto uid = params["uid"].asInt();
88                          auto bundleName = params["bundle_name"].asString();
89                          auto bundleVersion = params["bundle_version"].asString();
90                          auto beginTime = params["begin_time"].asInt64();
91                          auto endTime = params["end_time"].asInt64();
92                          auto externalLog = writer.write(params["external_log"]);
93                          auto logOverLimit = params["logOverLimit"].asBool();
94                          OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.params.time=%{public}lld", time);
95                          OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.params.pid=%{public}d", pid);
96                          OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.params.uid=%{public}d", uid);
97                          OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.params.bundle_name=%{public}s",
98                                      bundleName.c_str());
99                          OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.params.bundle_version=%{public}s",
100                                      bundleVersion.c_str());
101                          OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.params.begin_time=%{public}lld", beginTime);
102                          OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.params.end_time=%{public}lld", endTime);
103                          OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.params.external_log=%{public}s", externalLog.c_str());
104                          OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.params.log_over_limit=%{public}d",
105                                      logOverLimit);
106                      }
107                  }
108              }
109          }
110      }
111
112      static napi_value RegisterWatcher(napi_env env, napi_callback_info info) {
113          OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent RegisterWatcher");
114          // 开发者自定义观察者名称，系统根据不同的名称来识别不同的观察者。
115          systemEventWatcher = OH_HiAppEvent_CreateWatcher("onReceiverWatcher");
116          // 设置订阅的事件为EVENT_MAIN_THREAD_JANK。
117          const char *names[] = {EVENT_MAIN_THREAD_JANK};
118          // 开发者订阅感兴趣的事件，此处订阅了系统事件。
119          OH_HiAppEvent_SetAppEventFilter(systemEventWatcher, DOMAIN_OS, 0, names, 1);
120          // 开发者设置已实现的回调函数，观察者接收到事件后回立即触发OnReceive回调。
121          OH_HiAppEvent_SetWatcherOnReceive(systemEventWatcher, OnReceive);
122          // 使观察者开始监听订阅的事件。
123          OH_HiAppEvent_AddWatcher(systemEventWatcher);
124          return {};
125      }
126      ```
127
1285. 将RegisterWatcher注册为ArkTS接口：
129
130   编辑"napi_init.cpp"文件，将RegisterWatcher注册为ArkTS接口：
131
132   ```c++
133   static napi_value Init(napi_env env, napi_value exports)
134   {
135       napi_property_descriptor desc[] = {
136           { "registerWatcher", nullptr, RegisterWatcher, nullptr, nullptr, nullptr, napi_default, nullptr }
137       };
138       napi_define_properties(env, exports, sizeof(desc) / sizeof(desc[0]), desc);
139       return exports;
140   }
141   ```
142
143   编辑"index.d.ts"文件，定义ArkTS接口：
144
145   ```typescript
146   export const registerWatcher: () => void;
147   ```
148
1496. 编辑工程中的“entry > src > main > ets > entryability> EntryAbility.ets”文件，在onCreate()函数中新增接口调用：
150
151   ```typescript
152   // 导入依赖模块
153   import testNapi from 'libentry.so'
154
155   // 在onCreate()函数中新增接口调用
156   // 启动时，注册系统事件观察者
157   testNapi.registerWatcher();
158   ```
159
1607. 编辑工程中的“entry > src > main > ets > pages> Index.ets”文件，添加一个Button控件onClick中实现主线程超时代码，示例代码如下：
161
162   ```typescript
163      Button("timeOut350")
164      .fontSize(50)
165      .fontWeight(FontWeight.Bold)
166      .onClick(() => {
167          let t = Date.now();
168          while (Date.now() - t <= 350) {}
169      })
170   ```
171
1728. **开发者使用nolog版本，开发者模式处于关闭状态**，可以使能主线程超时检测抓取trace的功能。
173
1749. 点击DevEco Studio界面中的运行按钮，运行应用工程，连续点击两次timeOut350按钮，会触发主线程超时事件。
175
17610. 主线程超时事件上报后，可以在Log窗口看到对系统事件数据的处理日志：
177
178    ```text
179      HiAppEvent eventInfo.domain=OS
180      HiAppEvent eventInfo.name=MAIN_THREAD_JANK
181      HiAppEvent eventInfo.eventType=1
182      HiAppEvent eventInfo.params.time=1717597063727
183      HiAppEvent eventInfo.params.pid=45572
184      HiAppEvent eventInfo.params.uid=20020151
185      HiAppEvent eventInfo.params.bundle_name=com.example.nativemainthread
186      HiAppEvent eventInfo.params.bundle_version=1.0.0
187      HiAppEvent eventInfo.params.begin_time=1717597063225
188      HiAppEvent eventInfo.params.end_time=1717597063727
189      HiAppEvent eventInfo.params.external_log=["/data/storage/el2/log/watchdog/MAIN_THREAD_JANK_20240613221239_45572.txt"]
190      HiAppEvent eventInfo.params.log_over_limit=0
191    ```
192
193    > **说明：**
194    > 主线程超时事件具体规格可参考：[主线程超时事件时间规格](./hiappevent-watcher-mainthreadjank-events-arkts.md#主线程超时事件时间规格) 和 [主线程超时事件规格](./hiappevent-watcher-mainthreadjank-events-arkts.md#主线程超时事件规格)
195
19611. 移除事件观察者：
197
198    ```c++
199    static napi_value RemoveWatcher(napi_env env, napi_callback_info info) {
200        // 使观察者停止监听事件
201        OH_HiAppEvent_RemoveWatcher(systemEventWatcher);
202        return {};
203    }
204    ```
205
20612. 销毁事件观察者：
207
208    ```c++
209    static napi_value DestroyWatcher(napi_env env, napi_callback_info info) {
210        // 销毁创建的观察者，并置systemEventWatcher为nullptr。
211        OH_HiAppEvent_DestroyWatcher(systemEventWatcher);
212        systemEventWatcher = nullptr;
213        return {};
214    }
215    ```
216