鸿蒙南向开发实战：HiSysEvent查询

HiSysEvent提供了查询接口，支持开发者设置条件查询HiSysEvent事件，例如功耗部件可以通过该接口获取所需的系统事件进行业务分析。

开发指导

接口说明

C++接口说明

C++ HiSysEvent查询开发能力如下：HiSysEventManager类，具体API详见接口目录（/base/hiviewdfx/hisysevent/interfaces/native/innerkits/hisysevent_manager/include/）。

说明：

HiSysEventQueryCallback查询回调对象OnQuery方法中的形参类型HiSysEventRecord请参考HiSysEvent订阅中的“表4 HiSysEventRecord系统事件对象”说明。

表1 HiSysEvent查询接口

接口名称	描述
int32_t Query(struct QueryArg& arg, std::vector<QueryRule>& rules, std::shared_ptr<HiSysEventQueryCallback> callback)	接口功能：支持根据时间段、事件领域、事件名称等条件，查询满足条件的HiSysEvent事件。 输入参数： - arg：查询参数。 - rules：事件过滤规则。 - callback：查询接口回调对象。 返回值： - 0：查询成功。 - 负值：查询失败。

表2 QueryArg查询参数对象

属性名称	属性类型	描述
beginTime	long long	用于指定查询事件的开始时间，格式为Unix毫秒级时间戳。
endTime	long long	用于指定查询事件的结束时间，格式为Unix毫秒级时间戳。
maxEvents	int	用于指定查询返回事件的最多条数。

表3 EventType事件类型枚举

事件类型	值	描述
FAULT	1	故障类型。
STATISTIC	2	统计类型。
SECURITY	3	安全类型。
BEHAVIOR	4	用户行为类型。

表4 RuleType匹配规则类型枚举

查询规则类型	值	描述
WHOLE_WORD	1	全词匹配类型。
PREFIX	2	前缀匹配类型。
REGULAR	3	正则匹配类型。

表5 QueryRule查询规则对象

接口名称	描述
QueryRule(const std::string& domain, const std::vector<std::string>& eventList, RuleType ruleType, uint32_t eventType, const std::string& cond)	接口功能：查询规则构造函数，创建查询规则对象。 输入参数： - domain：string类型，用来标识查询规则对象的事件所属领域，如果传入的是空字符串，则默认事件领域字段匹配成功。 - eventList：std::vector<std::string>类型，事件名称的列表，如果传入的是空字符串，则默认事件名称字段匹配成功。 - ruleType：RuleType类型，请参考表4。 - eventType：uint32_t类型，查询的系统事件类型，系统事件类型请参考表3，当eventType取值为0时，表示查询所有事件类型。 - cond：string类型，设置的系统事件查询条件。

对于condition参数需要按照指定的JSON字符串格式传入，使用实例如下：

```json
{
    "version":"V1",
    "condition":{
        "and":[
            {"param":"type_","op":">","value":0},
            {"param":"uid_","op":"=","value":1201}
        ]
    }
}
```

• version字段是必选字段，表示传入条件的支持版本，当前只支持V1版本。
• condition字段是必选字段，表示传入条件的具体内容。
  • and字段是可选字段，表示条件之间是与的关系。
    • param字段是必选字段，表示条件匹配的参数名称，必须为字符串类型。
    • op字段是必选字段，表示条件匹配的参数比较符，必须为字符串类型，支持的比较符包括=、>、<、>=、<=。
    • value字段是必选字段，表示条件匹配的参数值，必须为字符串类型或整型。

表6 HiSysEventQueryCallback查询回调对象

接口名称	描述
void HiSysEventQueryCallback::OnQuery(std::shared_ptr<std::vector<HiSysEventRecord>> sysEvents)	接口功能：事件查询的回调。 输入参数： - sysEvents：返回的事件集合。
void HiSysEventQueryCallback::OnComplete(int32_t reason, int32_t total)	接口功能：事件查询完成的回调。 输入参数： - reason：查询结束的返回原因，0表示查询正常结束，其他值表示查询异常结束。 - total：本次查询返回的事件的总数量。

C接口说明

C HiSysEvent查询开发能力如下：具体API详见接口目录（/base/hiviewdfx/hisysevent/interfaces/native/innerkits/hisysevent_manager/include/）。

表7 HiSysEvent查询接口

接口名称	描述
int OH_HiSysEvent_Query(const HiSysEventQueryArg& arg, HiSysEventQueryRule rules[], size_t ruleSize, HiSysEventQueryCallback& callback);	接口功能：支持根据时间段、事件领域、事件名称、事件参数等条件，查询满足条件的HiSysEvent事件。 输入参数： - arg：查询参数。 - rules：事件过滤规则。 - ruleSize：事件过滤规则数量。 - callback：查询接口回调。 返回值： - 0：查询成功。 - 负值：查询失败。

表8 HiSysEventQueryArg查询参数结构体

属性名称	属性类型	描述
beginTime	int64_t	用于指定查询事件的开始时间，格式为Unix毫秒级时间戳。
endTime	int64_t	用于指定查询事件的结束时间，格式为Unix毫秒级时间戳。
maxEvents	int32_t	用于指定查询返回事件的最多条数。

表9 HiSysEventQueryRule查询规则结构体

属性名称	属性类型	描述
domain	char[]	用来指定查询的事件领域。
eventList	char[][]	用于指定查询的事件名称列表。
eventListSize	size_t	用于指定查询的事件名称列表大小。
condition	char*	用于指定查询的自定义事件参数条件。

表10 HiSysEventQueryCallback查询回调结构体

属性名称	属性类型	描述
OnQuery	void (*)(HiSysEventRecord records[], size_t size);	接口功能：事件查询的回调。 输入参数： - records：返回的事件集合。 - size：返回的事件集合大小。
OnComplete	void (*)(int32_t reason, int32_t total);	接口功能：事件查询完成的回调。 输入参数： - reason：查询结束的返回原因，0表示查询正常结束，其他值表示查询异常结束。 - total：本次查询返回的事件的总数量。

表11 HiSysEventRecord事件结构体

属性名称	属性类型	描述
domain	char[]	事件的领域名称。
eventName	char[]	事件的名称。
type	HiSysEventEventType	事件的类型。
time	uint64_t	事件的时间戳。
tz	char[]	事件的时区。
pid	int64_t	事件的进程ID。
tid	int64_t	事件的线程ID。
uid	int64_t	事件的用户ID。
traceId	uint64_t	事件的分布式跟踪链ID。
spandId	uint64_t	事件的分布式跟踪分支ID。
pspanId	uint64_t	事件的分布式跟踪父分支ID。
traceFlag	int	事件的分布式跟踪标志位。
level	char*	事件的级别。
tag	char*	事件的标签。
jsonStr	char*	事件的内容。

表12 HiSysEventRecord解析接口

接口名称
void OH_HiSysEvent_GetParamNames(const HiSysEventRecord& record, char*** params, size_t& len);	接口功能：获取该事件的所有的参数名。 输入参数： - record：事件结构体。 - params：参数名数组。 - len：数组大小。
int OH_HiSysEvent_GetParamInt64Value(const HiSysEventRecord& record, const char* name, int64_t& value);	接口功能：将该事件中参数名为name的参数值，解析为int64_t类型并赋值到value。 输入参数： - record：事件结构体。 - name：参数名。 - value：int64_t类型的参数值。
int OH_HiSysEvent_GetParamUint64Value(const HiSysEventRecord& record, const char* name, uint64_t& value);	接口功能：将该事件中参数名为name的参数值，解析为uint64_t类型并赋值到value。 输入参数： - record：事件结构体。 - name：参数名。 - value：uint64_t类型的参数值。
int OH_HiSysEvent_GetParamDoubleValue(const HiSysEventRecord& record, const char* name, double& value);	接口功能：将该事件中参数名为name的参数值，解析为double类型并赋值到value。 输入参数： - record：事件结构体。 - name：参数名。 - value：double类型的参数值。
int OH_HiSysEvent_GetParamStringValue(const HiSysEventRecord& record, const char* name, char** value);	接口功能：将该事件中参数名为name的参数值，解析为char数组类型并赋值到value，value在使用完成后需要手动释放内存。 输入参数： - record：事件结构体。 - name：参数名。 - value：char*类型引用。
int OH_HiSysEvent_GetParamInt64Values(const HiSysEventRecord& record, const char* name, int64_t** value, size_t& len);	接口功能：将该事件中参数名为name的参数值，解析为int64_t数组类型并赋值到value，value在使用完成后需要手动释放内存。 输入参数： - record：事件结构体。 - name：参数名。 - value：int64_t*类型引用。 - len：数组大小。
int OH_HiSysEvent_GetParamUint64Values(const HiSysEventRecord& record, const char* name, uint64_t** value, size_t& len);	接口功能：将该事件中参数名为name的参数值，解析为uint64_t数组类型并赋值到value，value在使用完成后需要手动释放内存。 输入参数： - record：事件结构体。 - name：参数名。 - value：uint64_t*类型引用。 - len：数组大小。
int OH_HiSysEvent_GetParamDoubleValues(const HiSysEventRecord& record, const char* name, double** value, size_t& len);	接口功能：将该事件中参数名为name的参数值，解析为double数组类型并赋值到value，value在使用完成后需要手动释放内存。 输入参数： - record：事件结构体。 - name：参数名。 - value：double*类型引用。 - len：数组大小。
int OH_HiSysEvent_GetParamStringValues(const HiSysEventRecord& record, const char* name, char*** value, size_t& len);	接口功能：将该事件中参数名为name的参数值，解析为char数组类型并赋值到value，value在使用完成后需要手动释放内存。 输入参数： - record：事件结构体。 - name：参数名。 - value：char\*类型引用。 - len：数组大小。

HiSysEventRecord解析接口的返回值说明如下：

• 0，表示解析成功；
• -1，表示该事件初始化失败；
• -2，表示参数名不存在；
• -3，表示要解析的参数值类型与传入的参数值类型不匹配。

开发步骤

C++ HiSysEvent查询开发步骤

1. 引入对应的头文件。

   #include "hisysevent_manager.h"

2. 业务领域实现对应的查询回调接口。

   class TestQueryCallback : public HiSysEventQueryCallback {
   public:
       void OnQuery(std::shared_ptr<std::vector<HiSysEventRecord>> sysEvents) override
       {
           if (sysEvents == nullptr) {
               return;
           }
           for_each((*sysEvents).cbegin(), (*sysEvents).cend(), [](const HiSysEventRecord& event) {
               std::cout << event.AsJson() << std::endl;
           });
       }
   
       void OnComplete(int32_t reason, int32_t total) override
       {
           std::cout << "Query completed" << std::endl;
           return;
       }
   };

3. 在查询的地方调用查询接口，并传入相应的查询参数、查询规则、查询回调参数。

   // 创建查询参数对象
   long long startTime = 0;
   long long endTime = 1668245644000; //2022-11-12 09:34:04
   int queryCount = 10;
   QueryArg arg(startTime, endTime, queryCount);
   
   // 创建查询规则对象
   QueryRule rule("HIVIEWDFX", { "PLUGIN_LOAD" });
   std::vector<QueryRule> queryRules = { rule };
   
   // 创建查询回调对象
   auto queryCallback = std::make_shared<TestQueryCallback>();
   
   // 调用查询接口
   HiSysEventManager::Query(arg, queryRules, queryCallback);

C HiSysEvent查询开发步骤

1. 引入对应的头文件。

   #include "hisysevent_manager_c.h"

2. 业务领域实现对应的查询回调接口。

   void OnQueryTest(HiSysEventRecord records[], size_t size)
   {
       for (size_t i = 0; i < size; i++) {
           printf("OnQuery: event=%s", records[i].jsonStr);
       }
   }
   
   void OnCompleteTest(int32_t reason, int32_t total)
   {
       printf("OnCompleted, res=%d, total=%d\n", reason, total);
   }

3. 在查询的地方调用查询接口，并传入相应的查询参数、查询规则、查询回调参数。

   // 创建查询参数对象
   HiSysEventQueryArg arg;
   arg.beginTime = 0;
   arg.endTime = 1668245644000; //2022-11-12 09:34:04
   arg.maxEvents = 10;
   
   // 创建查询规则对象
   constexpr char TEST_DOMAIN[] = "HIVIEWDFX";
   constexpr char TEST_NAME[] = "PLUGIN_LOAD";
   HiSysEventQueryRule rule;
   (void)strcpy_s(rule.domain, strlen(TEST_DOMAIN) + 1, TEST_DOMAIN);
   (void)strcpy_s(rule.eventList[0], strlen(TEST_NAME) + 1, TEST_NAME);
   rule.eventListSize = 1;
   rule.condition = nullptr;
   HiSysEventQueryRule rules[] = { rule };
   
   // 创建查询回调对象
   HiSysEventQueryCallback callback;
   callback.OnQuery = OnQueryTest;
   callback.OnComplete = OnCompleteTest;
   
   // 调用查询接口
   OH_HiSysEvent_Query(arg, rules, sizeof(rules) / sizeof(HiSysEventQueryRule), callback);

开发实例

C++ HiSysEvent查询开发实例

假设业务模块需要查询截止至当前时间、事件领域为HIVIEWDFX、事件名称为PLUGIN_LOAD的所有事件，其完整使用示例如下所示：

1. 在业务模块的在BUILD.gn里增加hisysevent部件的libhisysevent及libhisyseventmanager依赖。

   external_deps = [
     "hisysevent:libhisysevent",
     "hisysevent:libhisyseventmanager",
   ]

2. 在业务模块的TestQuery()函数中，调用查询接口去查询事件。

   #include "hisysevent_manager.h"
   #include <iostream>
   #include <unistd.h>
   
   using namespace OHOS::HiviewDFX;
   
   class TestQueryCallback : public HiSysEventQueryCallback {
   public:
       void OnQuery(std::shared_ptr<std::vector<HiSysEventRecord>> sysEvents) override
       {
           if (sysEvents == nullptr) {
               return;
           }
           for_each((*sysEvents).cbegin(), (*sysEvents).cend(), [](const HiSysEventRecord& event) {
               std::cout << event.AsJson() << std::endl;
           });
       }
   
       void OnComplete(int32_t reason, int32_t total) override
       {
           std::cout << "Query completed" << std::endl;
           return;
       }
   };
   
   int64_t GetMilliseconds()
   {
       auto now = std::chrono::system_clock::now();
       auto millisecs = std::chrono::duration_cast<std::chrono::milliseconds>(now.time_since_epoch());
       return millisecs.count();
   }
   
   void TestQuery()
   {
       long long startTime = 0;
       long long endTime = GetMilliseconds();
       int maxEvents = 100;
       QueryArg arg(startTime, endTime, maxEvents);
       QueryRule rule("HIVIEWDFX", { "PLUGIN_LOAD" });
       std::vector<QueryRule> queryRules = { rule };
       auto queryCallback = std::make_shared<TestQueryCallback>();
       int ret = HiSysEventManager::Query(arg, queryRules, queryCallback);
   }

C HiSysEvent查询开发实例

假设业务模块需要查询截止至当前时间、事件领域为HIVIEWDFX、事件名称为PLUGIN_LOAD的所有事件，其完整使用示例如下所示：

1. 在业务模块的在BUILD.gn里增加hisysevent部件的libhisyseventmanager依赖。

    external_deps = [ "hisysevent:libhisyseventmanager" ]

    // for strcpy_s
    deps = [ "//third_party/bounds_checking_function:libsec_shared" ]

1. 在业务模块的TestQuery()函数中，调用查询接口去查询事件。

   #include "hisysevent_manager_c.h"
   #include <securec.h>
   #include <time.h>
    
   void OnQueryTest(HiSysEventRecord records[], size_t size)
   {
       for (size_t i = 0; i < size; i++) {
           printf("OnQuery: event=%s", records[i].jsonStr);
       }
   }
   
   void OnCompleteTest(int32_t reason, int32_t total)
   {
       printf("OnCompleted, res=%d, total=%d\n", reason, total);
   }
   
   int64_t GetMilliseconds()
   {
       return time(NULL);
   }
   
   void TestQuery()
   {
       HiSysEventQueryArg arg;
       arg.beginTime = 0;
       arg.endTime = GetMilliseconds();
       arg.maxEvents = 100;
       constexpr char TEST_DOMAIN[] = "HIVIEWDFX";
       constexpr char TEST_NAME[] = "PLUGIN_LOAD";
       HiSysEventQueryRule rule;
       (void)strcpy_s(rule.domain, strlen(TEST_DOMAIN) + 1, TEST_DOMAIN);
       (void)strcpy_s(rule.eventList[0], strlen(TEST_NAME) + 1, TEST_NAME);
       rule.eventListSize = 1;
       rule.condition = nullptr;
       HiSysEventQueryRule rules[] = { rule };
       HiSysEventQueryCallback callback;
       callback.OnQuery = OnQueryTest;
       callback.OnComplete = OnCompleteTest;
       int ret = OH_HiSysEvent_Query(arg, rules, sizeof(rules) / sizeof(HiSysEventQueryRule), callback);
   }

最后

有很多小伙伴不知道学习哪些鸿蒙开发技术？不知道需要重点掌握哪些鸿蒙应用开发知识点？而且学习时频繁踩坑，最终浪费大量时间。所以有一份实用的鸿蒙（HarmonyOS NEXT）资料用来跟着学习是非常有必要的。 

这份鸿蒙（HarmonyOS NEXT）资料包含了鸿蒙开发必掌握的核心知识要点，内容包含了（ArkTS、ArkUI开发组件、Stage模型、多端部署、分布式应用开发、音频、视频、WebGL、OpenHarmony多媒体技术、Napi组件、OpenHarmony内核、Harmony南向开发、鸿蒙项目实战等等）鸿蒙（HarmonyOS NEXT）技术知识点。

希望这一份鸿蒙学习资料能够给大家带来帮助，有需要的小伙伴自行领取，限时开源，先到先得~无套路领取！！

如果你是一名有经验的资深Android移动开发、Java开发、前端开发、对鸿蒙感兴趣以及转行人员，可以直接领取这份资料

 获取这份完整版高清学习路线，请点击→纯血版全套鸿蒙HarmonyOS学习资料

鸿蒙（HarmonyOS NEXT）最新学习路线

•  HarmonOS基础技能

• HarmonOS就业必备技能 
•  HarmonOS多媒体技术

• 鸿蒙NaPi组件进阶

• HarmonOS高级技能

• 初识HarmonOS内核 
• 实战就业级设备开发

 有了路线图，怎么能没有学习资料呢，小编也准备了一份联合鸿蒙官方发布笔记整理收纳的一套系统性的鸿蒙（OpenHarmony ）学习手册（共计1236页）与鸿蒙（OpenHarmony ）开发入门教学视频，内容包含：ArkTS、ArkUI、Web开发、应用模型、资源分类…等知识点。

获取以上完整版高清学习路线，请点击→纯血版全套鸿蒙HarmonyOS学习资料

《鸿蒙 (OpenHarmony)开发入门教学视频》

《鸿蒙生态应用开发V2.0白皮书》

《鸿蒙 (OpenHarmony)开发基础到实战手册》

OpenHarmony北向、南向开发环境搭建

 《鸿蒙开发基础》

• ArkTS语言
• 安装DevEco Studio
• 运用你的第一个ArkTS应用
• ArkUI声明式UI开发
• .……

 《鸿蒙开发进阶》

• Stage模型入门
• 网络管理
• 数据管理
• 电话服务
• 分布式应用开发
• 通知与窗口管理
• 多媒体技术
• 安全技能
• 任务管理
• WebGL
• 国际化开发
• 应用测试
• DFX面向未来设计
• 鸿蒙系统移植和裁剪定制
• ……

《鸿蒙进阶实战》

• ArkTS实践
• UIAbility应用
• 网络案例
• ……

 获取以上完整鸿蒙HarmonyOS学习资料，请点击→纯血版全套鸿蒙HarmonyOS学习资料

总结

总的来说，华为鸿蒙不再兼容安卓，对中年程序员来说是一个挑战，也是一个机会。只有积极应对变化，不断学习和提升自己，他们才能在这个变革的时代中立于不败之地。