簡介

傳統的日志系統里匯聚了整個設備上所有程序運行的過程流水日志，難以識別其中的關鍵信息。因此，應用開發者需要一種數據打點機制，用來評估如訪問數、日活、用戶操作習慣以及影響用戶使用的關鍵因素等關鍵信息。

HiAppEvent是在系統層面為應用開發者提供的一種事件打點機制，用于幫助應用記錄在運行過程中發生的故障信息、統計信息、安全信息、用戶行為信息，以支撐開發者分析應用的運行情況。

基本概念

• 打點
  記錄由用戶操作引起的變化，提供業務數據信息，以供開發、產品、運維分析。

事件設計規范

• 事件領域：用于標識事件的領域，建議設置為業務模塊名稱，以便于區分不同的業務模塊。
• 事件名稱：用于指定事件的名稱，建議設置為具體的業務名稱，以便于描述實際的業務意義。
• 事件類型：用于指定事件的類型，支持以下四種類型事件：
  • 行為事件：用于記錄用戶日常操作行為的事件，例如按鈕點擊、界面跳轉等行為。
  • 故障事件：用于定位和分析應用故障的事件，例如界面卡頓、掉網掉話等異常。
  • 統計事件：用于統計和度量應用關鍵行為的事件，例如對使用時長、訪問數等的統計。
  • 安全事件：用于記錄涉及應用安全行為的事件，例如密碼修改、用戶授權等行為。
• 事件參數：用于指定事件的參數，每個事件可以包含一組參數，建議設置為事件屬性或事件發生上下文信息，以便于描述事件的詳細信息。

接口說明

應用事件打點接口由hiAppEvent模塊提供。

打點接口功能介紹：

訂閱接口功能介紹：

開發步驟

更多鴻蒙開發文檔mau123789是v添加后免費領取。

以實現對用戶點擊按鈕行為的事件打點及訂閱為例，說明開發步驟。

1. 新建一個ArkTS應用工程，編輯工程中的“entry > src > main > ets > entryability > EntryAbility.ts” 文件，在onCreate函數中添加對用戶點擊按鈕事件的訂閱，完整示例代碼如下：

   import hilog from '@ohos.hilog';
   import UIAbility from '@ohos.app.ability.UIAbility';
   import Window from '@ohos.window'
   import hiAppEvent from '@ohos.hiviewdfx.hiAppEvent'
   
   export default class EntryAbility extends UIAbility {
       onCreate(want, launchParam) {
           hilog.isLoggable(0x0000, 'testTag', hilog.LogLevel.INFO);
           hilog.info(0x0000, 'testTag', '%{public}s', 'Ability onCreate');
           hilog.info(0x0000, 'testTag', '%{public}s', 'want param:' + JSON.stringify(want) ?? '');
           hilog.info(0x0000, 'testTag', '%{public}s', 'launchParam:' + JSON.stringify(launchParam) ?? '');
           hiAppEvent.addWatcher({
               // 開發者可以自定義觀察者名稱，系統會使用名稱來標識不同的觀察者
               name: "watcher1",
               // 開發者可以訂閱感興趣的應用事件，此處是訂閱了按鈕事件
               appEventFilters: [{ domain: "button" }],
               // 開發者可以設置訂閱回調觸發的條件，此處是設置為事件打點數量滿足1個
               triggerCondition: { row: 1 },
               // 開發者可以自行實現訂閱回調函數，以便對訂閱獲取到的事件打點數據進行自定義處理
               onTrigger: function (curRow, curSize, holder) {
                   // 返回的holder對象為null，表示訂閱過程發生異常，因此在記錄錯誤日志后直接返回
                   if (holder == null) {
                       hilog.error(0x0000, 'testTag', "HiAppEvent holder is null")
                       return
                   }
                   let eventPkg = 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)
                       }
                   }
               }
           })
       }
   }
   

2. 編輯工程中的“entry > src > main > ets > pages > Index.ets” 文件，添加一個按鈕并在其onClick函數中進行事件打點，以記錄按鈕點擊事件，完整示例代碼如下：

   import hiAppEvent from '@ohos.hiviewdfx.hiAppEvent'
   import hilog from '@ohos.hilog'
   
   @Entry
   @Component
   struct Index {
     @State message: string = 'Hello World'
     build() {
       Row() {
         Column() {
           Text(this.message)
             .fontSize(50)
             .fontWeight(FontWeight.Bold)
           Button("writeTest").onClick(()= >{
             // 在按鈕點擊函數中進行事件打點，以記錄按鈕點擊事件
             hiAppEvent.write({
               // 事件領域定義
               domain: "button",
               // 事件名稱定義
               name: "click",
               // 事件類型定義
               eventType: hiAppEvent.EventType.BEHAVIOR,
               // 事件參數定義
               params: { click_time: 100 }
             }).then(() = > {
               hilog.info(0x0000, 'testTag', `HiAppEvent success to write event`)
             }).catch((err) = > {
               hilog.error(0x0000, 'testTag', `HiAppEvent err.code: ${err.code}, err.message: ${err.message}`)
             })
           })
         }
         .width('100%')
       }
       .height('100%')
     }
   }
   

3. 點擊IDE界面中的運行按鈕，運行應用工程，然后在應用界面中點擊按鈕“writeTest”，觸發一次按鈕點擊事件打點。
4. 最終，可以在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}
   

審核編輯 黃宇