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