订阅主线程超时事件（C/C++）
================

#### 简介

本文介绍如何使用HiAppEvent提供的C/C++接口订阅主线程超时事件。接口的详细使用说明（参数限制、取值范围等）请参考[hiappevent.h](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/capi-hiappevent-h)。

#### 接口说明

| 接口名 | 描述 |
| :-- | :-- |
| int OH\_HiAppEvent\_AddWatcher(HiAppEvent\_Watcher \*watcher) | 添加应用事件观察者，以添加对应用事件的订阅。 |
| int OH\_HiAppEvent\_RemoveWatcher(HiAppEvent\_Watcher \*watcher) | 移除应用事件观察者，以移除对应用事件的订阅。 |

#### 开发步骤

#### \[h2\]添加事件观察者

1.  获取该示例工程依赖的jsoncpp文件，从[三方开源库jsoncpp代码仓](https://github.com/open-source-parsers/jsoncpp)下载源码的压缩包，并按照README的**Amalgamated source**中介绍的操作步骤得到jsoncpp.cpp、json.h和json-forwards.h三个文件。
    
2.  新建Native C++工程，并将上述文件导入到新建工程内，目录结构如下。
    
    entry:
      src:
        main:
          cpp:
            json:
              - json.h
              - json-forwards.h
            types:
              libentry:
                - index.d.ts
            - CMakeLists.txt
            - jsoncpp.cpp
            - napi\_init.cpp
          ets:
            entryability:
              - EntryAbility.ets
            pages:
              - Index.ets
    
3.  编辑“CMakeLists.txt”文件，添加源文件及动态库。
    
    \# 新增jsoncpp.cpp(解析订阅事件中的json字符串)源文件
    add\_library(entry SHARED napi\_init.cpp jsoncpp.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)
    
4.  编辑“napi\_init.cpp”文件，导入依赖的文件，并定义LOG\_TAG。
    
    #include "napi/native\_api.h"
    #include "json/json.h"
    #include "hilog/log.h"
    #include "hiappevent/hiappevent.h"
    #include "hiappevent/hiappevent\_event.h"
    #undef LOG\_TAG
    #define LOG\_TAG "testTag"
    
5.  订阅系统事件。
    
    *   onReceive类型观察者
        
        编辑“napi\_init.cpp”文件，定义onReceive类型观察者相关方法：
        
        // 定义一个变量，用来缓存创建的观察者的指针。
        static HiAppEvent\_Watcher \*systemEventWatcher;
        
        static void OnReceive(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\_MAIN\_THREAD\_JANK) == 0) {
                        Json::Value params;
                        Json::Reader reader(Json::Features::strictMode());
                        Json::FastWriter writer;
                        if (reader.parse(appEventGroups\[i\].appEventInfos\[j\].params, params)) {
                            auto time = params\["time"\].asInt64();
                            auto pid = params\["pid"\].asInt();
                            auto uid = params\["uid"\].asInt();
                            auto bundleName = params\["bundle\_name"\].asString();
                            auto bundleVersion = params\["bundle\_version"\].asString();
                            auto beginTime = params\["begin\_time"\].asInt64();
                            auto endTime = params\["end\_time"\].asInt64();
                            auto externalLog = writer.write(params\["external\_log"\]);
                            auto logOverLimit = params\["logOverLimit"\].asBool();
                            OH\_LOG\_INFO(LogType::LOG\_APP, "HiAppEvent eventInfo.params.time=%{public}lld", time);
                            OH\_LOG\_INFO(LogType::LOG\_APP, "HiAppEvent eventInfo.params.pid=%{public}d", pid);
                            OH\_LOG\_INFO(LogType::LOG\_APP, "HiAppEvent eventInfo.params.uid=%{public}d", uid);
                            OH\_LOG\_INFO(LogType::LOG\_APP, "HiAppEvent eventInfo.params.bundle\_name=%{public}s",
                                        bundleName.c\_str());
                            OH\_LOG\_INFO(LogType::LOG\_APP, "HiAppEvent eventInfo.params.bundle\_version=%{public}s",
                                        bundleVersion.c\_str());
                            OH\_LOG\_INFO(LogType::LOG\_APP, "HiAppEvent eventInfo.params.begin\_time=%{public}lld", beginTime);
                            OH\_LOG\_INFO(LogType::LOG\_APP, "HiAppEvent eventInfo.params.end\_time=%{public}lld", endTime);
                            OH\_LOG\_INFO(LogType::LOG\_APP, "HiAppEvent eventInfo.params.external\_log=%{public}s", externalLog.c\_str());
                            OH\_LOG\_INFO(LogType::LOG\_APP, "HiAppEvent eventInfo.params.log\_over\_limit=%{public}d",
                                        logOverLimit);
                        }
                    }
                }
            }
        }
        
        static napi\_value RegisterWatcher(napi\_env env, napi\_callback\_info info) {
            OH\_LOG\_INFO(LogType::LOG\_APP, "HiAppEvent RegisterWatcher");
            // 开发者自定义观察者名称，系统根据不同的名称来识别不同的观察者。
            systemEventWatcher = OH\_HiAppEvent\_CreateWatcher("onReceiverWatcher");
            // 设置订阅的事件为EVENT\_MAIN\_THREAD\_JANK。
            const char \*names\[\] = {EVENT\_MAIN\_THREAD\_JANK};
            // 开发者订阅感兴趣的事件，此处订阅了系统事件。
            OH\_HiAppEvent\_SetAppEventFilter(systemEventWatcher, DOMAIN\_OS, 0, names, 1);
            // 开发者设置已实现的回调函数，观察者接收到事件后会立即触发OnReceive回调。
            OH\_HiAppEvent\_SetWatcherOnReceive(systemEventWatcher, OnReceive);
            // 使观察者开始监听订阅的事件。
            OH\_HiAppEvent\_AddWatcher(systemEventWatcher);
            return {};
        }
        
6.  将RegisterWatcher注册为ArkTS接口。
    
    编辑“napi\_init.cpp”文件，将RegisterWatcher注册为ArkTS接口：
    
    static napi\_value Init(napi\_env env, napi\_value exports)
    {
        napi\_property\_descriptor desc\[\] = {
            { "registerWatcher", nullptr, RegisterWatcher, nullptr, nullptr, nullptr, napi\_default, nullptr }
        };
        napi\_define\_properties(env, exports, sizeof(desc) / sizeof(desc\[0\]), desc);
        return exports;
    }
    
    编辑“index.d.ts”文件，定义ArkTS接口：
    
    export const registerWatcher: () => void;
    
7.  编辑工程中的“entry > src > main > ets > entryability> EntryAbility.ets”文件，在onCreate()函数中新增接口调用。
    
    // 导入依赖模块
    import testNapi from 'libentry.so';
    
    // 在onCreate()函数中新增接口调用
    // 启动时，注册系统事件观察者
    testNapi.registerWatcher();
    
8.  编辑工程中的“entry > src > main > ets > pages> Index.ets”文件，添加一个Button按钮，并在其onClick函数中模拟触发主线程超时场景，示例代码如下：
    
       Button("timeOut350")
       .fontSize(50)
       .fontWeight(FontWeight.Bold)
       .onClick(() => {
           let t = Date.now();
           while (Date.now() - t <= 350) {}
       })
    
9.  点击DevEco Studio界面中的运行按钮，运行应用工程，可以快速点击2~3次timeOut350按钮，以触发主线程超时事件。
    

#### \[h2\]验证观察者是否订阅到主线程超时事件

1.  主线程超时事件上报后，可以在Log窗口看到对系统事件数据的处理日志：
    
      HiAppEvent eventInfo.domain=OS
      HiAppEvent eventInfo.name=MAIN\_THREAD\_JANK
      HiAppEvent eventInfo.eventType=1
      HiAppEvent eventInfo.params.time=1717597063727
      HiAppEvent eventInfo.params.pid=45572
      HiAppEvent eventInfo.params.uid=20020151
      HiAppEvent eventInfo.params.bundle\_name=com.example.nativemainthread
      HiAppEvent eventInfo.params.bundle\_version=1.0.0
      HiAppEvent eventInfo.params.begin\_time=1717597063225
      HiAppEvent eventInfo.params.end\_time=1717597063727
      HiAppEvent eventInfo.params.external\_log=\["/data/storage/el2/log/watchdog/MAIN\_THREAD\_JANK\_20240613221239\_45572.txt"\]
      HiAppEvent eventInfo.params.log\_over\_limit=0
    
    ![](https://contentcenter-vali-drcn.dbankcdn.cn/pvt_2/DeveloperAlliance_scene_100_1/4c/v3/Um2_9rBjSLigOXluw78VRQ/note_3.0-zh-cn.png?HW-CC-KV=V1&HW-CC-Date=20260612T073455Z&HW-CC-Expire=86400&HW-CC-Sign=CAD0EDCE3A55F77B42DA1F022D55DEDEA06C964553537D788FE250879E95B963)
    
    主线程超时事件具体规格可参考：[主线程超时事件默认时间规格](https://developer.huawei.com/consumer/cn/doc/harmonyos-guides/apptask-timeout-guidelines#检测原理) 和 [主线程超时事件日志规格](https://developer.huawei.com/consumer/cn/doc/harmonyos-guides/apptask-timeout-guidelines#日志规格)。
    

#### \[h2\]移除并销毁事件观察者

1.  移除事件观察者：
    
    static napi\_value RemoveWatcher(napi\_env env, napi\_callback\_info info) {
        // 使观察者停止监听事件
        OH\_HiAppEvent\_RemoveWatcher(systemEventWatcher);
        return {};
    }
    
2.  销毁事件观察者：
    
    static napi\_value DestroyWatcher(napi\_env env, napi\_callback\_info info) {
        // 销毁创建的观察者，并置systemEventWatcher为nullptr。
        OH\_HiAppEvent\_DestroyWatcher(systemEventWatcher);
        systemEventWatcher = nullptr;
        return {};
    }