1# 订阅崩溃事件（C/C++） 2 3## 接口说明 4 5API接口的具体使用说明（参数使用限制、具体取值范围等）请参考[HiAppEvent](../reference/apis-performance-analysis-kit/_hi_app_event.md#hiappevent)。 6 7> **说明：** 8> 9> 使用C/C++接口订阅崩溃事件，包含JsError和NativeCrash两种崩溃类型。 10 11**订阅接口功能介绍：** 12 13| 接口名 | 描述 | 14| ------------------------------------------------------------ | -------------------------------------------- | 15| int OH_HiAppEvent_AddWatcher(HiAppEvent_Watcher \*watcher) | 添加应用事件观察者，以添加对应用事件的订阅。 | 16| int OH_HiAppEvent_RemoveWatcher (HiAppEvent_Watcher \*watcher) | 移除应用事件观察者，以移除对应用事件的订阅。 | 17 18## 开发步骤 19 20以实现对用户点击按钮触发崩溃场景生成的崩溃事件订阅为例，说明开发步骤。 21 221. 新建Native C++工程，并将jsoncpp导入到新建工程内，目录结构如下： 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 - napi_init.cpp 37 - jsoncpp.cpp 38 ets: 39 - entryability: 40 - EntryAbility.ets 41 - pages: 42 - Index.ets 43 ``` 44 452. 编辑"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(日志输出) 51 target_link_libraries(entry PUBLIC libace_napi.z.so libhilog_ndk.z.so libhiappevent_ndk.z.so) 52 ``` 53 543. 编辑"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 62 #undef LOG_TAG 63 #define LOG_TAG "testTag" 64 ``` 65 664. 订阅系统事件： 67 68 - onReceive类型观察者： 69 70 编辑"napi_init.cpp"文件，定义onReceive类型观察者相关方法： 71 72 ```c++ 73 //定义一变量，用来缓存创建的观察者的指针。 74 static HiAppEvent_Watcher *systemEventWatcher; 75 76 static void OnReceive(const char *domain, const struct HiAppEvent_AppEventGroup *appEventGroups, uint32_t groupLen) { 77 for (int i = 0; i < groupLen; ++i) { 78 for (int j = 0; j < appEventGroups[i].infoLen; ++j) { 79 OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.domain=%{public}s", appEventGroups[i].appEventInfos[j].domain); 80 OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.name=%{public}s", appEventGroups[i].appEventInfos[j].name); 81 OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.eventType=%{public}d", appEventGroups[i].appEventInfos[j].type); 82 if (strcmp(appEventGroups[i].appEventInfos[j].domain, DOMAIN_OS) == 0 && 83 strcmp(appEventGroups[i].appEventInfos[j].name, EVENT_APP_CRASH) == 0) { 84 Json::Value params; 85 Json::Reader reader(Json::Features::strictMode()); 86 Json::FastWriter writer; 87 if (reader.parse(appEventGroups[i].appEventInfos[j].params, params)) { 88 auto time = params["time"].asInt64(); 89 auto crashType = params["crash_type"].asString(); 90 auto foreground = params["foreground"].asBool(); 91 auto bundleVersion = params["bundle_version"].asString(); 92 auto bundleName = params["bundle_name"].asString(); 93 auto pid = params["pid"].asInt(); 94 auto uid = params["uid"].asInt(); 95 auto uuid = params["uuid"].asString(); 96 auto exception = writer.write(params["exception"]); 97 auto hilogSize = params["hilog"].size(); 98 auto externalLog = writer.write(params["external_log"]); 99 auto logOverLimit = params["log_over_limit"].asBool(); 100 OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.params.time=%{public}lld", time); 101 OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.params.crash_type=%{public}s", crashType.c_str()); 102 OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.params.foreground=%{public}d", foreground); 103 OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.params.bundle_version=%{public}s", bundleVersion.c_str()); 104 OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.params.bundle_name=%{public}s", bundleName.c_str()); 105 OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.params.pid=%{public}d", pid); 106 OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.params.uid=%{public}d", uid); 107 OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.params.uuid=%{public}s", uuid.c_str()); 108 OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.params.exception=%{public}s", exception.c_str()); 109 OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.params.hilog.size=%{public}d", hilogSize); 110 OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.params.external_log=%{public}s", externalLog.c_str()); 111 OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.params.log_over_limit=%{public}d", logOverLimit); 112 } 113 } 114 } 115 } 116 } 117 118 static napi_value RegisterWatcher(napi_env env, napi_callback_info info) { 119 // 开发者自定义观察者名称，系统根据不同的名称来识别不同的观察者。 120 systemEventWatcher = OH_HiAppEvent_CreateWatcher("onReceiverWatcher"); 121 // 设置订阅的事件为EVENT_APP_CRASH。 122 const char *names[] = {EVENT_APP_CRASH}; 123 // 开发者订阅感兴趣的事件，此处订阅了系统事件。 124 OH_HiAppEvent_SetAppEventFilter(systemEventWatcher, DOMAIN_OS, 0, names, 1); 125 // 开发者设置已实现的回调函数，观察者接收到事件后回立即触发OnReceive回调。 126 OH_HiAppEvent_SetWatcherOnReceive(systemEventWatcher, OnReceive); 127 // 使观察者开始监听订阅的事件。 128 OH_HiAppEvent_AddWatcher(systemEventWatcher); 129 return {}; 130 } 131 ``` 132 133 - onTrigger类型观察者： 134 135 编辑"napi_init.cpp"文件，定义OnTrigger类型观察者相关方法： 136 137 ```c++ 138 //定义一变量，用来缓存创建的观察者的指针。 139 static HiAppEvent_Watcher *systemEventWatcher; 140 141 // 开发者可以自行实现获取已监听到事件的回调函数，其中events指针指向内容仅在该函数内有效。 142 static void OnTake(const char *const *events, uint32_t eventLen) { 143 Json::Reader reader(Json::Features::strictMode()); 144 Json::FastWriter writer; 145 for (int i = 0; i < eventLen; ++i) { 146 Json::Value eventInfo; 147 if (reader.parse(events[i], eventInfo)) { 148 auto domain = eventInfo["domain_"].asString(); 149 auto name = eventInfo["name_"].asString(); 150 auto type = eventInfo["type_"].asInt(); 151 OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.domain=%{public}s", domain.c_str()); 152 OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.name=%{public}s", name.c_str()); 153 OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.eventType=%{public}d", type); 154 if (domain == DOMAIN_OS && name == EVENT_APP_CRASH) { 155 auto time = eventInfo["time"].asInt64(); 156 auto crashType = eventInfo["crash_type"].asString(); 157 auto foreground = eventInfo["foreground"].asBool(); 158 auto bundleVersion = eventInfo["bundle_version"].asString(); 159 auto bundleName = eventInfo["bundle_name"].asString(); 160 auto pid = eventInfo["pid"].asInt(); 161 auto uid = eventInfo["uid"].asInt(); 162 auto uuid = eventInfo["uuid"].asString(); 163 auto exception = writer.write(eventInfo["exception"]); 164 auto hilogSize = eventInfo["hilog"].size(); 165 auto externalLog = writer.write(eventInfo["external_log"]); 166 auto logOverLimit = eventInfo["log_over_limit"].asBool(); 167 OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.params.time=%{public}lld", time); 168 OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.params.crash_type=%{public}s", crashType.c_str()); 169 OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.params.foreground=%{public}d", foreground); 170 OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.params.bundle_version=%{public}s", bundleVersion.c_str()); 171 OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.params.bundle_name=%{public}s", bundleName.c_str()); 172 OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.params.pid=%{public}d", pid); 173 OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.params.uid=%{public}d", uid); 174 OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.params.uuid=%{public}s", uuid.c_str()); 175 OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.params.exception=%{public}s", exception.c_str()); 176 OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.params.hilog.size=%{public}d", hilogSize); 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_CRASH。 194 const char *names[] = {EVENT_APP_CRASH}; 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. 编辑"EntryAbility.ets"文件，在onCreate()函数中新增接口调用： 229 230 ```typescript 231 // 导入依赖模块 232 import testNapi from 'libentry.so' 233 234 // 在onCreate()函数中新增接口调用 235 // 启动时，注册系统事件观察者 236 testNapi.registerWatcher(); 237 ``` 238 2397. 编辑"Index.ets"文件，新增按钮触发崩溃事件： 240 241 ```typescript 242 Button("appCrash").onClick(() => { 243 JSON.parse(""); 244 }) 245 ``` 246 2478. 点击DevEco Studio界面中的运行按钮，运行应用工程，然后在应用界面中点击按钮“appCrash”，触发一次崩溃事件。崩溃事件发生后，系统会根据崩溃类型（JsError或NativeCrash）采用不同的栈回溯方式生成崩溃日志，然后再进行回调。其中NativeCrash栈回溯耗时约2秒，实际耗时与业务线程数量、进程间通信耗时有关。JsError触发进程内栈回溯，NativeCrash触发进程外栈回溯，因此NativeCrash栈回溯会比JsError栈回溯更耗时。用户可以订阅崩溃事件，栈回溯完成后会异步上报，不会阻塞当前业务。 248 2499. 下次应用启动后，HiAppEvent将崩溃事件上报给应用已注册的监听，完成回调。并可以在Log窗口看到对系统事件数据的处理日志： 250 251 ```text 252 HiAppEvent eventInfo.domain=OS 253 HiAppEvent eventInfo.name=APP_CRASH 254 HiAppEvent eventInfo.eventType=1 255 HiAppEvent eventInfo.params.time=1502032265088 256 HiAppEvent eventInfo.params.crash_type=JsError 257 HiAppEvent eventInfo.params.foreground=1 258 HiAppEvent eventInfo.params.bundle_version=1.0.0 259 HiAppEvent eventInfo.params.bundle_name=com.example.myapplication 260 HiAppEvent eventInfo.params.pid=19237 261 HiAppEvent eventInfo.params.uid=20010043 262 HiAppEvent eventInfo.params.uuid=cc0f062e1b28c1fd2c817fafab5e8ca3207925b4bdd87c43ed23c60029659e01 263 HiAppEvent eventInfo.params.exception={"message":"Unexpected Text in JSON","name":"SyntaxError","stack":"at anonymous (entry/src/main/ets/pages/Index.ets:16:11)"} 264 HiAppEvent eventInfo.params.hilog.size=110 265 HiAppEvent eventInfo.params.external_log=["/data/storage/el2/log/hiappevent/APP_CRASH_1502032265211_19237.log"] 266 HiAppEvent eventInfo.params.log_over_limit=0 267 ``` 268 26910. 移除事件观察者： 270 271 ```c++ 272 static napi_value RemoveWatcher(napi_env env, napi_callback_info info) { 273 // 使观察者停止监听事件 274 OH_HiAppEvent_RemoveWatcher(systemEventWatcher); 275 return {}; 276 } 277 ``` 278 27911. 销毁事件观察者： 280 281 ```c++ 282 static napi_value DestroyWatcher(napi_env env, napi_callback_info info) { 283 // 销毁创建的观察者，并置systemEventWatcher为nullptr。 284 OH_HiAppEvent_DestroyWatcher(systemEventWatcher); 285 systemEventWatcher = nullptr; 286 return {}; 287 } 288 ``` 289