订阅崩溃事件(C/C++)
简介
本文介绍如何使用HiAppEvent提供的C/C++接口订阅应用崩溃事件。详细使用说明请参考hiappevent.h。
说明:
使用C/C++接口订阅JsError和NativeCrash崩溃事件。
接口说明
| 接口名 | 描述 |
|---|---|
| int OH_HiAppEvent_AddWatcher(HiAppEvent_Watcher *watcher) | 添加应用事件观察者,以添加对应用事件的订阅。 |
| int OH_HiAppEvent_RemoveWatcher(HiAppEvent_Watcher *watcher) | 移除应用事件观察者,以移除对应用事件的订阅。 |
开发步骤
添加事件观察者
在应用启动后,在执行业务逻辑前添加事件观察者,以确保订阅到崩溃事件。否则,应用可能因崩溃而退出,无法订阅崩溃事件。
以用户点击按钮触发崩溃事件为例,开发步骤如下:
-
获取该示例工程依赖的jsoncpp文件,打开链接HiAppEvent示例工程EventSub,点击“下载当前目录”,下载EventSub工程文件。
-
新建Native C++工程,并将上述文件导入到新建工程,目录结构如下。
entry: libs: // 放置jsoncpp关联三方库的文件夹 src: main: cpp: - thirdparty: jsoncpp: // 放置jsoncpp关联三方库的文件夹 - types: libentry: - index.d.ts - CMakeLists.txt - napi_init.cpp ets: - entryability: - EntryAbility.ets - pages: - Index.ets该示例工程中jsoncpp库文件对应的源码来自三方开源库jsoncpp。
-
在"CMakeLists.txt"文件中,添加源文件和动态库。
add_library(entry SHARED napi_init.cpp) # 新增动态库依赖libhiappevent_ndk.z.so和libhilog_ndk.z.so(日志输出) target_link_libraries(entry PUBLIC libace_napi.z.so libhilog_ndk.z.so libhiappevent_ndk.z.so) set(GZ_FILE "${CMAKE_CURRENT_SOURCE_DIR}/thirdparty/jsoncpp/src/jsoncpp-1.9.6.tar.gz") set(DEST_DIR "${CMAKE_CURRENT_SOURCE_DIR}/../../../build") # 检查是否存在entry/build目录 execute_process(COMMAND ${CMAKE_COMMAND} -E make_directory ${DEST_DIR}) # 解压jsoncpp-1.9.6.tar.gz到entry/build,得到jsoncpp头文件的目录 execute_process(COMMAND tar -xzf ${GZ_FILE} -C ${DEST_DIR} WORKING_DIRECTORY ${DEST_DIR}) # 新增三方库依赖libjsoncpp.so(解析订阅事件中的json字符串) target_link_libraries(entry PRIVATE ${CMAKE_CURRENT_SOURCE_DIR}/thirdparty/jsoncpp/${OHOS_ARCH}/lib/libjsoncpp.so) target_include_directories(entry PRIVATE ${DEST_DIR}/jsoncpp-1.9.6/include/json) -
在"napi_init.cpp"文件中,导入依赖文件,并定义LOG_TAG。
#include "napi/native_api.h" // 根据工程中三方库jsoncpp的位置适配引用json.h的路径 #include "../../../build/jsoncpp-1.9.6/include/json/json.h" #include "hiappevent/hiappevent.h" #include "hiappevent/hiappevent_param.h" #include "hilog/log.h" #undef LOG_TAG #define LOG_TAG "testTag" -
订阅系统事件。
-
onReceive类型观察者
在"napi_init.cpp"文件中,定义onReceive类型观察者的方法:
static void OnReceiveCrashEvent(const char *domain, const struct HiAppEvent_AppEventGroup *appEventGroups, uint32_t groupLen) { for (int i = 0; i < groupLen; ++i) { for (int j = 0; j < appEventGroups[i].infoLen; ++j) { OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.domain=%{public}s", appEventGroups[i].appEventInfos[j].domain); OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.name=%{public}s", appEventGroups[i].appEventInfos[j].name); OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.eventType=%{public}d", appEventGroups[i].appEventInfos[j].type); if (strcmp(appEventGroups[i].appEventInfos[j].domain, DOMAIN_OS) != 0 || strcmp(appEventGroups[i].appEventInfos[j].name, EVENT_APP_CRASH) != 0) { continue; } Json::Value params; Json::Reader reader(Json::Features::strictMode()); Json::FastWriter writer; if (reader.parse(appEventGroups[i].appEventInfos[j].params, params)) { OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.params.time=%{public}lld", params["time"].asInt64()); OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.params.crash_type=%{public}s", params["crash_type"].asString().c_str()); OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.params.foreground=%{public}d", params["foreground"].asBool()); OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.params.app_running_unique_id=%{public}s", params["app_running_unique_id"].asString().c_str()); OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.params.bundle_version=%{public}s", params["bundle_version"].asString().c_str()); OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.params.bundle_name=%{public}s", params["bundle_name"].asString().c_str()); OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.params.pid=%{public}d", params["pid"].asInt()); OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.params.uid=%{public}d", params["uid"].asInt()); OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.params.uuid=%{public}s", params["uuid"].asString().c_str()); OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.params.exception=%{public}s", writer.write(params["exception"]).c_str()); OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.params.hilog.size=%{public}d", params["hilog"].size()); OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.params.process_life_time=%{public}d", params["process_life_time"].asInt()); OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.params.memory=%{public}s", writer.write(params["memory"]).c_str()); OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.params.external_log=%{public}s", writer.write(params["external_log"]).c_str()); OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.params.log_over_limit=%{public}d", params["log_over_limit"].asBool()); } } } } // 定义变量,用来缓存创建的观察者的指针。 static HiAppEvent_Watcher *systemEventWatcherR; static napi_value RegisterWatcherCrashEvent(napi_env env, napi_callback_info info) { // 开发者自定义观察者名称,系统根据不同的名称来识别不同的观察者。 systemEventWatcherR = OH_HiAppEvent_CreateWatcher("AppCrashWatcherR"); // 设置订阅的事件名称为EVENT_APP_CRASH,即崩溃事件。 const char *names[] = {EVENT_APP_CRASH}; // 开发者订阅感兴趣的事件,此处订阅了系统事件。 OH_HiAppEvent_SetAppEventFilter(systemEventWatcherR, DOMAIN_OS, 0, names, 1); // 开发者设置已实现的回调函数,观察者接收到事件后回立即触发OnReceiveCrashEvent回调。 OH_HiAppEvent_SetWatcherOnReceive(systemEventWatcherR, OnReceiveCrashEvent); // 使观察者开始监听订阅的事件。 OH_HiAppEvent_AddWatcher(systemEventWatcherR); // 1. 创建配置对象 HiAppEvent_Config* config = OH_HiAppEvent_CreateConfig(); // 2. 设置各项配置参数 // 开启寄存器扩展内存打印 OH_HiAppEvent_SetConfigItem(config, OH_APP_CRASH_PARAM_EXTEND_PC_LR_PRINTING, "true"); // 设置日志截断大小为 2MB OH_HiAppEvent_SetConfigItem(config, OH_APP_CRASH_PARAM_LOG_FILE_CUTOFF_SZ_BYTES, "2097152"); // 开启简化 VMA 映射信息打印 OH_HiAppEvent_SetConfigItem(config, OH_APP_CRASH_PARAM_SIMPLIFY_VMA_PRINTING, "true"); // 开启拼接应用日志 OH_HiAppEvent_SetConfigItem(config, OH_APP_CRASH_PARAM_MERGE_CPPCRASH_APP_LOG, "true"); // 3. 应用配置到 EVENT_APP_CRASH 事件 int ret = OH_HiAppEvent_SetEventConfig(EVENT_APP_CRASH, config); if (ret == HIAPPEVENT_SUCCESS) { OH_LOG_INFO(LogType::LOG_APP, "Successfully set APP_CRASH event configurations."); } // 4. 销毁配置对象 OH_HiAppEvent_DestroyConfig(config); return {}; } -
onTrigger类型观察者
在"napi_init.cpp"文件中,定义OnTrigger类型观察者:
// 开发者可以自行实现获取已监听到事件的回调函数,其中events指针指向内容仅在该函数内有效。 static void OnTakeCrash(const char *const *events, uint32_t eventLen) { Json::Reader reader(Json::Features::strictMode()); Json::FastWriter writer; for (int i = 0; i < eventLen; ++i) { Json::Value eventInfo; if (reader.parse(events[i], eventInfo)) { auto domain = eventInfo["domain_"].asString(); auto name = eventInfo["name_"].asString(); auto type = eventInfo["type_"].asInt(); OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.WatcherType=OnTrigger"); OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.domain=%{public}s", domain.c_str()); OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.name=%{public}s", name.c_str()); OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.eventType=%{public}d", type); if (domain == DOMAIN_OS && name == EVENT_APP_CRASH) { OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.params.time=%{public}lld", eventInfo["time"].asInt64()); OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.params.crash_type=%{public}s", eventInfo["crash_type"].asString().c_str()); OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.params.foreground=%{public}d", eventInfo["foreground"].asBool()); OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.params.app_running_unique_id=%{public}s", eventInfo["app_running_unique_id"].asString().c_str()); OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.params.bundle_version=%{public}s", eventInfo["bundle_version"].asString().c_str()); OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.params.bundle_name=%{public}s", eventInfo["bundle_name"].asString().c_str()); OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.params.pid=%{public}d", eventInfo["pid"].asInt()); OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.params.uid=%{public}d", eventInfo["uid"].asInt()); OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.params.uuid=%{public}s", eventInfo["uuid"].asString().c_str()); OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.params.exception=%{public}s", writer.write(eventInfo["exception"]).c_str()); OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.params.hilog.size=%{public}d", eventInfo["hilog"].size()); OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.params.process_life_time=%{public}d", eventInfo["process_life_time"].asInt()); OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.params.memory=%{public}s", writer.write(eventInfo["memory"]).c_str()); OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.params.external_log=%{public}s", writer.write(eventInfo["external_log"]).c_str()); OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.params.log_over_limit=%{public}d", eventInfo["log_over_limit"].asBool()); } } } } // 定义变量,用来缓存创建的观察者的指针。 static HiAppEvent_Watcher *systemEventWatcherT; // 开发者可以自行实现订阅回调函数,以便对获取到的事件打点数据进行自定义处理。 static void OnTriggerCrash(int row, int size) { // 接收回调后,获取指定数量的已接收事件。 OH_HiAppEvent_TakeWatcherData(systemEventWatcherT, row, OnTakeCrash); } static napi_value RegisterWatcherClickCrash(napi_env env, napi_callback_info info) { // 开发者自定义观察者名称,系统根据不同的名称来识别不同的观察者。 systemEventWatcherT = OH_HiAppEvent_CreateWatcher("AppCrashWatcherT"); // 设置订阅的事件为EVENT_APP_CRASH。 const char *names[] = {EVENT_APP_CRASH}; // 开发者订阅感兴趣的事件,此处订阅了系统事件。 OH_HiAppEvent_SetAppEventFilter(systemEventWatcherT, DOMAIN_OS, 0, names, 1); // 开发者设置已实现的回调函数,需OH_HiAppEvent_SetTriggerCondition设置的条件满足方可触发。 OH_HiAppEvent_SetWatcherOnTrigger(systemEventWatcherT, OnTriggerCrash); // 开发者可以设置订阅触发回调的条件,此处是设置新增事件打点数量为1个时,触发OnTriggerCrash回调。 OH_HiAppEvent_SetTriggerCondition(systemEventWatcherT, 1, 0, 0); // 使观察者开始监听订阅的事件。 OH_HiAppEvent_AddWatcher(systemEventWatcherT); return {}; }
-
-
将RegisterWatcher注册为ArkTS接口。
在"napi_init.cpp"文件中,将RegisterWatcher注册为ArkTS接口:
static napi_value Init(napi_env env, napi_value exports) { napi_property_descriptor desc[] = { // ··· { "registerWatcherCrashEvent", nullptr, RegisterWatcherCrashEvent, nullptr, nullptr, nullptr, napi_default, nullptr }, { "registerWatcherClickCrash", nullptr, RegisterWatcherClickCrash, nullptr, nullptr, nullptr, napi_default, nullptr }, // ··· }; napi_define_properties(env, exports, sizeof(desc) / sizeof(desc[0]), desc); return exports; }在"index.d.ts"文件中,定义ArkTS接口:
-
在"EntryAbility.ets"文件的onCreate()函数中添加接口调用。
// 在onCreate()函数中添加C API接口调用 // 启动时,注册崩溃事件观察者 testNapi.registerWatcherClickCrash(); // 启动时,注册按钮点击事件观察者 testNapi.registerWatcherCrashEvent(); -
在"Index.ets"文件中,新增按钮触发崩溃事件。
- 构造JsError类型崩溃
Button('JsError') .type(ButtonType.Capsule) .margin({ top: 20 }) .backgroundColor('#0D9FFB') .width('80%') .height('5%') .onClick(() => { // 在按钮点击函数中构造一个crash场景,触发应用崩溃事件 JSON.parse(''); })-
构造MergeLogNativeCrash拼接应用日志类型崩溃
编辑工程中的“entry > src > main > ets > pages > Index.ets”文件,导入依赖模块。示例代码如下:
编辑工程中的“entry > src > main > ets > pages > Index.ets”文件,添加按钮并在其onClick函数中构造崩溃场景,以触发崩溃事件。示例代码如下:
Button('MergeLogNativeCrash') .type(ButtonType.Capsule) .margin({ top: 20 }) .backgroundColor('#0D9FFB') .width('80%') .height('5%') .onClick(() => { // 模拟创建 applog,假设应用包名为 com.samples.eventsub let filePath : string = "/data/storage/el2/log/com.samples.eventsub_CppCrash_AppMerge.log"; let file = fileIo.openSync(filePath, fileIo.OpenMode.CREATE | fileIo.OpenMode.READ_WRITE); let str: string = "only test for merge app log!"; let writeLen = fileIo.writeSync(file.fd, str); console.info("hiappevent write data to file succeed and size is:" + writeLen); fileIo.closeSync(file); // 在按钮点击函数中构造一个crash场景,触发应用崩溃事件 testNapi.testNullptr(); })
-
点击运行按钮启动应用工程。在应用界面中单击“JsError”或“MergeLogNativeCrash”按钮触发崩溃事件。系统生成崩溃日志并回调。
说明:
JsError通过进程内采集故障信息触发回调,速度快。NativeCrash采取进程外采集故障信息,平均耗时约2秒,具体受业务线程数量和进程间通信影响。订阅崩溃事件后,故障信息采集完成会异步上报,不阻塞当前业务。
验证观察者是否订阅到崩溃事件
在应用未主动捕获崩溃异常和主动捕获崩溃异常的两种场景中,崩溃事件的回调时机不同。开发者需要在每种情况下验证是否订阅到崩溃事件。
应用未主动捕获崩溃异常场景
若应用未主动捕获崩溃异常,则系统处理崩溃后应用将退出。应用下次启动时,HiAppEvent将崩溃事件上报给已注册的监听,完成回调。
从API version 21开始,若应用无法启动或长时间未启动,开发者可以参考使用FaultLogExtensionAbility订阅事件回调重写的函数,进行延迟上报。
应用主动捕获崩溃异常场景
若应用主动捕获崩溃异常,HiAppEvent事件将在应用退出前触发回调,例如:
-
异常处理中未主动退出的应用崩溃后不会退出。
采用errorManager.on方法捕获异常会导致JsError类型的崩溃事件在应用退出前触发回调。若应用注册崩溃信号处理函数但未主动退出,会导致NativeCrash类型的崩溃事件在应用退出前触发回调。
-
异常处理耗时过长,会导致应用退出延迟。
在开发调试阶段,HiAppEvent上报事件完成回调后,可在DevEco Studio的HiLog窗口查看订阅的崩溃事件内容。
HiAppEvent eventInfo.domain=OS
HiAppEvent eventInfo.name=APP_CRASH
HiAppEvent eventInfo.eventType=1
HiAppEvent eventInfo.params.time=1503045716054
HiAppEvent eventInfo.params.crash_type=JsError
HiAppEvent eventInfo.params.foreground=1
HiAppEvent eventInfo.params.app_running_unique_id=365426736245712514
HiAppEvent eventInfo.params.bundle_version=1.0.0
HiAppEvent eventInfo.params.bundle_name=com.samples.eventsub
HiAppEvent eventInfo.params.pid=2610
HiAppEvent eventInfo.params.uid=20010044
HiAppEvent eventInfo.params.uuid=7c3b1579c8ca8629af3858f8145254c2867ee402dc16ee18034337aae258620b
HiAppEvent eventInfo.params.exception={"message":"Unexpected Text in JSON: Empty Text","name":"SyntaxError","stack":" at anonymous (entry|entry|1.0.0|src/main/ets/pages/Index.ts:163:22)\n","thread_name":"amples.eventsub"}
HiAppEvent eventInfo.params.hilog.size=100
HiAppEvent eventInfo.params.process_life_time=25
HiAppEvent eventInfo.params.memory={"rss":181964,"sys_avail_mem":1230456,"sys_free_mem":676940,"sys_total_mem":2001932}
HiAppEvent eventInfo.params.external_log=["/data/storage/el2/log/hiappevent/APP_CRASH_1503045716408_2610.log"]
HiAppEvent eventInfo.params.log_over_limit=0
移除并销毁事件观察者
-
移除事件观察者。
static napi_value RemoveWatcherCrash(napi_env env, napi_callback_info info) { // 使观察者停止监听crash事件 OH_HiAppEvent_RemoveWatcher(systemEventWatcherR); OH_HiAppEvent_RemoveWatcher(systemEventWatcherT); return {}; } -
销毁事件观察者。
static napi_value DestroyWatcherCrash(napi_env env, napi_callback_info info) { // 销毁创建的观察者,并置eventWatcher为nullptr。 OH_HiAppEvent_DestroyWatcher(systemEventWatcherR); OH_HiAppEvent_DestroyWatcher(systemEventWatcherT); systemEventWatcherR = nullptr; systemEventWatcherT = nullptr; return {}; }
本文来自 OpenHarmony 文档贡献者,按 CC BY 4.0 整理版式与相对链接,保留正文与代码。图示请参阅原文。作者与贡献记录。
