1# 订阅任务执行超时事件（C/C++） 2 3## 简介 4 5本文介绍如何使用HiAppEvent提供的C/C++接口订阅任务执行超时事件。接口的详细使用说明（参数限制、取值范围等）请参考[HiAppEvent C API文档](../reference/apis-performance-analysis-kit/capi-hiappevent-h.md)。 6 7## 接口说明 8 9| 接口名 | 描述 | 10| -------- | -------- | 11| int OH_HiAppEvent_AddWatcher(HiAppEvent_Watcher \*watcher) | 添加应用事件观察者，以添加对应用事件的订阅。 | 12| int OH_HiAppEvent_RemoveWatcher(HiAppEvent_Watcher \*watcher) | 移除应用事件观察者，以移除对应用事件的订阅。 | 13 14## 开发步骤 15 16### 添加事件观察者 17 18以实现对用户点击按钮触发卡顿场景生成的卡顿事件订阅为例，说明开发步骤。 19 201. 参考[三方开源库jsoncpp代码仓](https://github.com/open-source-parsers/jsoncpp)README中**Using JsonCpp in your project**介绍的使用方法获取到jsoncpp.cpp、json.h和json-forwards.h三个文件。 21 222. 新建Native C++工程，并将上述文件导入到新建工程内，目录结构如下： 23 24 ```yml 25 entry: 26 src: 27 main: 28 cpp: 29 json: 30 - json.h 31 - json-forwards.h 32 types: 33 libentry: 34 - index.d.ts 35 - CMakeLists.txt 36 - jsoncpp.cpp 37 - napi_init.cpp 38 ets: 39 entryability: 40 - EntryAbility.ets 41 pages: 42 - Index.ets 43 ``` 44 453. 编辑“CMakeLists.txt”文件，添加源文件及动态库。 46 47 ```cmake 48 # 新增jsoncpp.cpp(解析订阅事件中的json字符串)源文件 49 add_library(entry SHARED napi_init.cpp jsoncpp.cpp) 50 # 新增动态库依赖libhiappevent_ndk.z.so、libhilog_ndk.z.so（日志输出）及libohhicollie.so（hicollie检测） 51 target_link_libraries(entry PUBLIC libace_napi.z.so libhilog_ndk.z.so libohhicollie.so libhiappevent_ndk.z.so) 52 ``` 53 544. 编辑“napi_init.cpp”文件，导入依赖的文件，并定义LOG_TAG。 55 56 ```c++ 57 #include "napi/native_api.h" 58 #include "json/json.h" 59 #include "hilog/log.h" 60 #include "hiappevent/hiappevent.h" 61 #include <thread> 62 #include <unistd.h> 63 64 #undef LOG_TAG 65 #define LOG_TAG "testTag" 66 ``` 67 685. 订阅系统事件： 69 70 - onReceive类型观察者 71 72 编辑“napi_init.cpp”文件，定义onReceive类型观察者相关函数： 73 74 ```c++ 75 //定义一变量，用来缓存创建的观察者的指针。 76 static HiAppEvent_Watcher *systemEventWatcher; 77 78 static void OnReceive(const char *domain, const struct HiAppEvent_AppEventGroup *appEventGroups, uint32_t groupLen) { 79 for (int i = 0; i < groupLen; ++i) { 80 for (int j = 0; j < appEventGroups[i].infoLen; ++j) { 81 OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.domain=%{public}s", appEventGroups[i].appEventInfos[j].domain); 82 OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.name=%{public}s", appEventGroups[i].appEventInfos[j].name); 83 OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.eventType=%{public}d", appEventGroups[i].appEventInfos[j].type); 84 if (strcmp(appEventGroups[i].appEventInfos[j].domain, DOMAIN_OS) == 0 && 85 strcmp(appEventGroups[i].appEventInfos[j].name, EVENT_APP_HICOLLIE) == 0) { 86 Json::Value params; 87 Json::Reader reader(Json::Features::strictMode()); 88 Json::FastWriter writer; 89 if (reader.parse(appEventGroups[i].appEventInfos[j].params, params)) { 90 auto time = params["time"].asInt64(); 91 auto foreground = params["foreground"].asBool(); 92 auto bundleVersion = params["bundle_version"].asString(); 93 auto processName = params["process_name"].asString(); 94 auto pid = params["pid"].asInt(); 95 auto uid = params["uid"].asInt(); 96 auto uuid = params["uuid"].asString(); 97 auto exception = writer.write(params["exception"]); 98 auto hilogSize = params["hilog"].size(); 99 auto peerBindSize = params["peer_binder"].size(); 100 auto memory = writer.write(params["memory"]); 101 auto externalLog = writer.write(params["external_log"]); 102 auto logOverLimit = params["log_over_limit"].asBool(); 103 OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.params.time=%{public}lld", time); 104 OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.params.foreground=%{public}d", foreground); 105 OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.params.bundle_version=%{public}s", bundleVersion.c_str()); 106 OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.params.process_name=%{public}s", processName.c_str()); 107 OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.params.pid=%{public}d", pid); 108 OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.params.uid=%{public}d", uid); 109 OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.params.uuid=%{public}s", uuid.c_str()); 110 OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.params.exception=%{public}s", exception.c_str()); 111 OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.params.hilog.size=%{public}d", hilogSize); 112 OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.params.peer_binder.size=%{public}d", peerBindSize); 113 OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.params.memory=%{public}s", memory.c_str()); 114 OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.params.external_log=%{public}s", externalLog.c_str()); 115 OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.params.log_over_limit=%{public}d", logOverLimit); 116 } 117 } 118 } 119 } 120 } 121 122 static napi_value RegisterWatcher(napi_env env, napi_callback_info info) { 123 // 开发者自定义观察者名称，系统根据不同的名称来识别不同的观察者。 124 systemEventWatcher = OH_HiAppEvent_CreateWatcher("onReceiverWatcher"); 125 // 设置订阅的事件为EVENT_APP_HICOLLIE。 126 const char *names[] = {EVENT_APP_HICOLLIE}; 127 // 开发者订阅感兴趣的事件，此处订阅了系统事件。 128 OH_HiAppEvent_SetAppEventFilter(systemEventWatcher, DOMAIN_OS, 0, names, 1); 129 // 开发者设置已实现的回调函数，观察者接收到事件后回立即触发OnReceive回调。 130 OH_HiAppEvent_SetWatcherOnReceive(systemEventWatcher, OnReceive); 131 // 使观察者开始监听订阅的事件。 132 OH_HiAppEvent_AddWatcher(systemEventWatcher); 133 return {}; 134 } 135 ``` 136 137 - onTrigger类型观察者 138 139 编辑“napi_init.cpp”文件，定义OnTrigger类型观察者相关函数： 140 141 ```c++ 142 //定义一变量，用来缓存创建的观察者的指针。 143 static HiAppEvent_Watcher *systemEventWatcher; 144 145 // 开发者可以自行实现获取已监听到事件的回调函数，其中events指针指向内容仅在该函数内有效。 146 static void OnTake(const char *const *events, uint32_t eventLen) { 147 Json::Reader reader(Json::Features::strictMode()); 148 Json::FastWriter writer; 149 for (int i = 0; i < eventLen; ++i) { 150 Json::Value eventInfo; 151 if (reader.parse(events[i], eventInfo)) { 152 auto domain = eventInfo["domain_"].asString(); 153 auto name = eventInfo["name_"].asString(); 154 auto type = eventInfo["type_"].asInt(); 155 OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.domain=%{public}s", domain.c_str()); 156 OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.name=%{public}s", name.c_str()); 157 OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.eventType=%{public}d", type); 158 if (domain == DOMAIN_OS && name == EVENT_APP_HICOLLIE) { 159 auto time = eventInfo["time"].asInt64(); 160 auto foreground = eventInfo["foreground"].asBool(); 161 auto bundleVersion = eventInfo["bundle_version"].asString(); 162 auto processName = eventInfo["process_name"].asString(); 163 auto pid = eventInfo["pid"].asInt(); 164 auto uid = eventInfo["uid"].asInt(); 165 auto uuid = eventInfo["uuid"].asString(); 166 auto exception = writer.write(eventInfo["exception"]); 167 auto hilogSize = eventInfo["hilog"].size(); 168 auto peerBindSize = eventInfo["peer_binder"].size(); 169 auto memory = writer.write(eventInfo["memory"]); 170 auto externalLog = writer.write(eventInfo["external_log"]); 171 auto logOverLimit = eventInfo["log_over_limit"].asBool(); 172 OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.params.time=%{public}lld", time); 173 OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.params.foreground=%{public}d", foreground); 174 OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.params.bundle_version=%{public}s", bundleVersion.c_str()); 175 OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.params.process_name=%{public}s", processName.c_str()); 176 OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.params.pid=%{public}d", pid); 177 OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.params.uid=%{public}d", uid); 178 OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.params.uuid=%{public}s", uuid.c_str()); 179 OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.params.exception=%{public}s", exception.c_str()); 180 OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.params.hilog.size=%{public}d", hilogSize); 181 OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.params.peer_binder.size=%{public}d", peerBindSize); 182 OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.params.memory=%{public}s", memory.c_str()); 183 OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.params.external_log=%{public}s", externalLog.c_str()); 184 OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.params.log_over_limit=%{public}d", logOverLimit); 185 } 186 } 187 } 188 } 189 190 // 开发者可以自行实现订阅回调函数，以便对获取到的事件打点数据进行自定义处理。 191 static void OnTrigger(int row, int size) { 192 // 接收回调后，获取指定数量的已接收事件。 193 OH_HiAppEvent_TakeWatcherData(systemEventWatcher, row, OnTake); 194 } 195 196 static napi_value RegisterWatcher(napi_env env, napi_callback_info info) { 197 // 开发者自定义观察者名称，系统根据不同的名称来识别不同的观察者。 198 systemEventWatcher = OH_HiAppEvent_CreateWatcher("onTriggerWatcher"); 199 // 设置订阅的事件为EVENT_APP_HICOLLIE。 200 const char *names[] = {EVENT_APP_HICOLLIE}; 201 // 开发者订阅感兴趣的事件，此处订阅了系统事件。 202 OH_HiAppEvent_SetAppEventFilter(systemEventWatcher, DOMAIN_OS, 0, names, 1); 203 // 开发者设置已实现的回调函数，需OH_HiAppEvent_SetTriggerCondition设置的条件满足方可触发。 204 OH_HiAppEvent_SetWatcherOnTrigger(systemEventWatcher, OnTrigger); 205 // 开发者可以设置订阅触发回调的条件，此处是设置新增事件打点数量为1个时，触发onTrigger回调。 206 OH_HiAppEvent_SetTriggerCondition(systemEventWatcher, 1, 0, 0); 207 // 使观察者开始监听订阅的事件。 208 OH_HiAppEvent_AddWatcher(systemEventWatcher); 209 return {}; 210 } 211 ``` 212 2136. 新增TestHiCollieTimerNdk函数。 214 215 编辑“napi_init.cpp”文件，新增TestHiCollieTimerNdk函数，构造任务执行超时事件： 216 217 ```c++ 218 // 引入hicollie.h头文件 219 #include "hicollie/hicollie.h" 220 static napi_value TestHiCollieTimerNdk(napi_env env, napi_callback_info exports) 221 { 222 // 定义执行任务超时id值 223 int id; 224 // 定义任务超时检测参数：超时时间阈值1s，动作级别为生成日志 225 HiCollie_SetTimerParam param = {"testTimer", 1, nullptr, nullptr, HiCollie_Flag::HICOLLIE_FLAG_LOG}; 226 // 设置检测 227 HiCollie_ErrorCode errorCode = OH_HiCollie_SetTimer(param, &id); 228 if (errorCode == HICOLLIE_SUCCESS) { 229 OH_LOG_INFO(LogType::LOG_APP, "Timer Id is %{public}d", id); 230 // 构造超时2s 231 sleep(2); 232 OH_HiCollie_CancelTimer(id); 233 } 234 return nullptr; 235 } 236 ``` 237 2387. 将RegisterWatcher及TestHiCollieTimerNdk注册为ArkTS接口。 239 240 编辑“napi_init.cpp”文件，将RegisterWatcher及TestHiCollieTimerNdk注册为ArkTS接口： 241 242 ```c++ 243 EXTERN_C_START 244 static napi_value Init(napi_env env, napi_value exports) 245 { 246 napi_property_descriptor desc[] = { 247 { "RegisterWatcher", nullptr, RegisterWatcher, nullptr, nullptr, nullptr, napi_default, nullptr }, 248 { "TestHiCollieTimerNdk", nullptr, TestHiCollieTimerNdk, nullptr, nullptr, nullptr, napi_default, nullptr }, 249 }; 250 napi_define_properties(env, exports, sizeof(desc) / sizeof(desc[0]), desc); 251 return exports; 252 } 253 EXTERN_C_END 254 static napi_module demoModule = { 255 .nm_version = 1, 256 .nm_flags = 0, 257 .nm_filename = nullptr, 258 .nm_register_func = Init, 259 .nm_modname = "entry", 260 .nm_priv = ((void*)0), 261 .reserved = { 0 }, 262 }; 263 extern "C" __attribute__((constructor)) void RegisterEntryModule(void) 264 { 265 napi_module_register(&demoModule); 266 } 267 ``` 268 269 编辑“index.d.ts”文件，定义ArkTS接口： 270 271 ```typescript 272 export const RegisterWatcher: () => void; 273 export const TestHiCollieTimerNdk: () => void; 274 ``` 275 2768. 编辑“EntryAbility.ets”文件，在onCreate()函数中新增接口调用。 277 278 ```typescript 279 // 导入依赖模块 280 import testNapi from 'libentry.so' 281 282 // 在onCreate()函数中新增接口调用 283 // 启动时，注册系统事件观察者 284 testNapi.RegisterWatcher(); 285 ``` 286 2879. 编辑“Index.ets”文件，新增按钮触发任务执行超时事件。 288 289 ```typescript 290 import testNapi from 'libentry.so'; 291 @Entry 292 @Component 293 struct Index { 294 @State message: string = 'Hello World'; 295 296 build() { 297 Row() { 298 Column() { 299 Button("TestHiCollieTimerNdk") 300 .fontSize(50) 301 .fontWeight(FontWeight.Bold) 302 .onClick(testNapi.TestHiCollieTimerNdk); //添加点击事件，触发TestHiCollieTimerNdk方法。 303 } 304 .width('100%') 305 } 306 .height('100%') 307 } 308 } 309 ``` 310 31110. 点击DevEco Studio界面中的运行按钮，运行应用工程，然后在应用界面中点击按钮“testHiCollieTimerNdk”，触发任务执行超时事件。 312 313### 验证观察者是否订阅到任务执行超时事件 314 3151. 应用工程崩溃退出后再次运行可以在Log窗口看到对系统事件数据的处理日志。 316 317 ```text 318 HiAppEvent eventInfo.domain=OS 319 HiAppEvent eventInfo.name=APP_HICOLLIE 320 HiAppEvent eventInfo.eventType=1 321 HiAppEvent eventInfo.params.time=1740993639620 322 HiAppEvent eventInfo.params.foreground=1 323 HiAppEvent eventInfo.params.bundle_version=1.0.0 324 HiAppEvent eventInfo.params.process_name=com.example.myapplication 325 HiAppEvent eventInfo.params.pid=26251 326 HiAppEvent eventInfo.params.uid=20020172 327 HiAppEvent eventInfo.params.uuid=4e5d7d0e18f5d6d84cf4f0c9e80d66d0b646c1cc2343d3595f07abb0d3547feb 328 HiAppEvent eventInfo.params.exception={"message":"","name":"APP_HICOLLIE"} 329 HiAppEvent eventInfo.params.hilog.size=77 330 HiAppEvent eventInfo.params.peer_binder.size=18 331 HiAppEvent eventInfo.params.threads.size=28 332 HiAppEvent eventInfo.params.memory={"pss":0,"rss":124668,"sys_avail_mem":2220032,"sys_free_mem":526680,"sys_total_mem":11692576,"vss":4238700} 333 HiAppEvent eventInfo.params.external_log=["/data/storage/el2/log/hiappevent/APP_HICOLLIE_1740993644458_26215.log"] 334 HiAppEvent eventInfo.params.log_over_limit=0 335 ``` 336 337### 移除并销毁事件观察者 338 3391. 移除事件观察者。 340 341 ```c++ 342 static napi_value RemoveWatcher(napi_env env, napi_callback_info info) { 343 // 使观察者停止监听事件 344 OH_HiAppEvent_RemoveWatcher(systemEventWatcher); 345 return {}; 346 } 347 ``` 348 3492. 销毁事件观察者。 350 351 ```c++ 352 static napi_value DestroyWatcher(napi_env env, napi_callback_info info) { 353 // 销毁创建的观察者，并置systemEventWatcher为nullptr。 354 OH_HiAppEvent_DestroyWatcher(systemEventWatcher); 355 systemEventWatcher = nullptr; 356 return {}; 357 } 358 ``` 359