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