HiAppEvent

煸橙干儿~~

于 2024-10-01 06:30:00 发布

阅读量482

点赞数 14

分类专栏： HarmonyOS 文章标签：前端 harmonyos 华为

本文链接：https://blog.csdn.net/sinat_34896766/article/details/142351513

版权

HarmonyOS 专栏收录该内容

100 篇文章 3 订阅

订阅专栏

HiAppEvent是在系统层面为应用开发者提供的一种事件打点机制，帮助应用记录在运行过程中发生的故障信息、统计信息、安全信息、用户行为信息，支撑开发者分析应用的运行情况。以便进一步统计分析访问数、日常用户活跃数量、用户操作习惯以及其他影响用户使用产品的关键因素。

一、基本概念

打点： 记录由用户操作引起的变化，提供业务数据信息，供开发、产品、运维分析。

二、事件设计规范

事件领域：标识事件的领域，建议设置为业务模块名称，以便于区分不同的业务模块。
事件名称：指定事件的名称，建议设置为具体的业务名称，以便于描述实际的业务意义。
事件类型：指定事件的类型，支持以下四种类型事件：
- 行为事件：记录用户日常操作行为的事件，例如按钮点击、界面跳转等行为。
- 故障事件：定位和分析应用故障的事件，例如界面卡顿、掉网掉话等异常。
- 统计事件：统计和度量应用关键行为的事件，例如对使用时长、访问数等的统计。
- 安全事件：记录涉及应用安全行为的事件，例如密码修改、用户授权等行为。
事件参数：指定事件的参数，每个事件可以包含一组参数，建议设置为事件属性或事件发生上下文信息，以便于描述事件的详细信息。

三、事件订阅

HiAppEvent提供了事件订阅接口，用于本地获取应用事件。

1、打点接口功能介绍

接口名	描述
write(info: AppEventInfo, callback: AsyncCallback<void>): void	应用事件异步打点方法，使用callback方式作为异步回调。
write(info: AppEventInfo): Promise<void>	应用事件异步打点方法，使用Promise方式作为异步回调。

2、订阅接口功能介绍

接口名	描述
addWatcher(watcher: Watcher): AppEventPackageHolder	添加应用事件观察者，以添加对应用事件的订阅。
removeWatcher(watcher: Watcher): void	移除应用事件观察者，以移除对应用事件的订阅。

四、开发步骤

1、新建一个ArkTS应用工程，编辑工程中的“entry > src > main > ets > entryability > EntryAbility.ets”文件，导入依赖模块

import { hiAppEvent, hilog } from '@kit.PerformanceAnalysisKit';

2、编辑工程中的“entry > src > main > ets > entryability > EntryAbility.ets” 文件，在onCreate函数中添加对用户点击按钮事件的订阅

 hiAppEvent.addWatcher({
   // 开发者可以自定义观察者名称，系统会使用名称来标识不同的观察者
   name: "watcher1",
   // 开发者可以订阅感兴趣的应用事件，此处是订阅了按钮事件
   appEventFilters: [{ domain: "button" }],
   // 开发者可以设置订阅回调触发的条件，此处是设置为事件打点数量满足1个
   triggerCondition: { row: 1 },
   // 开发者可以自行实现订阅回调函数，以便对订阅获取到的事件打点数据进行自定义处理
   onTrigger: (curRow: number, curSize: number, holder: hiAppEvent.AppEventPackageHolder) => {
     // 返回的holder对象为null，表示订阅过程发生异常，因此在记录错误日志后直接返回
     if (holder == null) {
       hilog.error(0x0000, 'testTag', "HiAppEvent holder is null");
       return;
     }
     hilog.info(0x0000, 'testTag', `HiAppEvent onTrigger: curRow=%{public}d, curSize=%{public}d`, curRow, curSize);
     let eventPkg: hiAppEvent.AppEventPackage | null = null;
     // 根据设置阈值大小（默认为512KB）去获取订阅事件包，直到将订阅数据全部取出
     // 返回的事件包对象为null，表示当前订阅数据已被全部取出，此次订阅回调触发结束
     while ((eventPkg = holder.takeNext()) != null) {
       // 开发者可以对事件包中的事件打点数据进行自定义处理，此处是将事件打点数据打印在日志中
       hilog.info(0x0000, 'testTag', `HiAppEvent eventPkg.packageId=%{public}d`, eventPkg.packageId);
       hilog.info(0x0000, 'testTag', `HiAppEvent eventPkg.row=%{public}d`, eventPkg.row);
       hilog.info(0x0000, 'testTag', `HiAppEvent eventPkg.size=%{public}d`, eventPkg.size);
       for (const eventInfo of eventPkg.data) {
         hilog.info(0x0000, 'testTag', `HiAppEvent eventPkg.info=%{public}s`, eventInfo);
       }
     }
   }
 });

3、编辑工程中的“entry > src > main > ets > pages > Index.ets” 文件，导入依赖模块

import { BusinessError } from '@kit.BasicServicesKit';
import { hiAppEvent, hilog } from '@kit.PerformanceAnalysisKit';

4、编辑工程中的“entry > src > main > ets > pages > Index.ets” 文件，添加一个按钮并在其onClick函数中进行事件打点，以记录按钮点击事件

  Button("writeTest").onClick(()=>{
    // 在按钮点击函数中进行事件打点，以记录按钮点击事件
    let eventParams: Record<string, number> = { 'click_time': 100 };
    let eventInfo: hiAppEvent.AppEventInfo = {
      // 事件领域定义
      domain: "button",
      // 事件名称定义
      name: "click",
      // 事件类型定义
      eventType: hiAppEvent.EventType.BEHAVIOR,
      // 事件参数定义
      params: eventParams,
    };
    hiAppEvent.write(eventInfo).then(() => {
      hilog.info(0x0000, 'testTag', `HiAppEvent success to write event`)
    }).catch((err: BusinessError) => {
      hilog.error(0x0000, 'testTag', `HiAppEvent err.code: ${err.code}, err.message: ${err.message}`)
    });
  })

5、点击IDE界面中的运行按钮，运行应用工程，然后在应用界面中点击按钮“writeTest”，触发一次按钮点击事件打点

6、可以在Log窗口看到按钮点击事件打点成功的日志，以及触发订阅回调后对打点事件数据的处理日志

HiAppEvent success to write event
HiAppEvent eventPkg.packageId=0
HiAppEvent eventPkg.row=1
HiAppEvent eventPkg.size=124
HiAppEvent eventPkg.info={"domain_":"button","name_":"click","type_":4,"time_":1670268234523,"tz_":"+0800","pid_":3295,"tid_":3309,"click_time":100}