HarmonyOS NEXT應(yīng)用開(kāi)發(fā)之異常處理案例

介紹

本示例介紹了通過(guò)應(yīng)用事件打點(diǎn)hiAppEvent獲取上一次應(yīng)用異常信息的方法，主要分為應(yīng)用崩潰、應(yīng)用卡死以及系統(tǒng)查殺三種。

效果圖預(yù)覽

使用說(shuō)明：

  1. 點(diǎn)擊構(gòu)建應(yīng)用崩潰事件，3s之后應(yīng)用退出，然后打開(kāi)應(yīng)用進(jìn)入應(yīng)用異常頁(yè)面，隔1min左右后，顯示上次異常退出信息。
  2. 點(diǎn)擊構(gòu)建應(yīng)用卡死事件，需手動(dòng)退出，然后打開(kāi)應(yīng)用進(jìn)入應(yīng)用異常頁(yè)面，隔1min左右后，顯示上次異常退出信息。

實(shí)現(xiàn)思路

  1. 構(gòu)建應(yīng)用異常。源碼參考ApplicationException.ets 
 handleOperate(index: number) {
    switch (index) {
      case 0:
      // 在按鈕點(diǎn)擊函數(shù)中構(gòu)造一個(gè)APP_CRASH場(chǎng)景，觸發(fā)應(yīng)用崩潰事件
        let result: object = JSON.parse('');
        break;
      case 1:
      // 在按鈕點(diǎn)擊函數(shù)中構(gòu)造一個(gè)APP_FREEZE場(chǎng)景，觸發(fā)應(yīng)用卡死事件,500ms之后執(zhí)行無(wú)限循環(huán)
        while (true) {
        }
    }
  }
  1. 應(yīng)用退出后，進(jìn)入本頁(yè)面，等待訂閱消息通知，待收到訂閱消息后，通過(guò)EventSubscription.ets中的onReceive函數(shù)，接收到異常信息數(shù)據(jù)， 并通過(guò)AppStorage.setOrCreate('appEventGroups',異常信息數(shù)據(jù))雙向綁定異常信息，源碼參考代碼可參考EventSubscription.ets 
import hiAppEvent from '@ohos.hiviewdfx.hiAppEvent';
import { logger } from '@ohos/base';

const TAG: string = 'eventSubscription';

export function eventSubscription() {
  // 添加應(yīng)用事件觀察者方法，可用于訂閱應(yīng)用事件
  hiAppEvent.addWatcher({
    // 開(kāi)發(fā)者可以自定義觀察者名稱(chēng)，系統(tǒng)會(huì)使用名稱(chēng)來(lái)標(biāo)識(shí)不同的觀察者
    name: "mst",
    // 開(kāi)發(fā)者可以訂閱感興趣的系統(tǒng)事件，此處是訂閱了崩潰事件
    appEventFilters: [
      {
        domain: hiAppEvent.domain.OS,
        names: [hiAppEvent.event.APP_CRASH, hiAppEvent.event.APP_FREEZE]
      }
    ],
    // TODO：知識(shí)點(diǎn)：獲取事件組信息。開(kāi)發(fā)者可以自行實(shí)現(xiàn)訂閱實(shí)時(shí)回調(diào)函數(shù)，以便對(duì)訂閱獲取到的事件數(shù)據(jù)進(jìn)行自定義處理
    onReceive: async (domain: string, appEventGroups: Array<hiAppEvent.AppEventGroup>) => {
      logger.info(TAG, `HiAppEvent onReceive: domain=${domain}`);
      // 獲取事件組信息，與ApplicationException文件中的@StorageLink('faultMessage') faultMessage進(jìn)行雙向數(shù)據(jù)綁定
      AppStorage.setOrCreate('appEventGroups', appEventGroups);
    }
  });
}
  1. @StorageLink('appEventGroups')接收訂閱事件函數(shù)傳遞的事件組信息，調(diào)用getFaultMessage函數(shù)對(duì)信息進(jìn)行處理，將處理后的信息通過(guò) this.faultDataSource.pushData(message) 添加到懶加載數(shù)據(jù)源中，并通過(guò)this.faultDataSource.persistenceStorage()執(zhí)行持久化存儲(chǔ)，最后通過(guò)使用LazyForEach將數(shù)據(jù)信息加載到頁(yè)面上。 具體源碼參考ApplicationException.ets 
@Component
struct FaultArea {
  // 懶加載數(shù)據(jù)源
  @State faultDataSource: FaultDataSource = new FaultDataSource();
  // 雙向數(shù)據(jù)綁定懶加載數(shù)據(jù)源的數(shù)組長(zhǎng)度
  @StorageLink('faultDataSourceLength') faultDataSourceLength: number = 0;
  // 雙向數(shù)據(jù)綁定事件組，與AppStorage.setOrCreate進(jìn)行綁定，此變量發(fā)生變化觸發(fā)getFaultMessage函數(shù)
  @StorageLink('appEventGroups') @Watch('getFaultMessage') appEventGroups: Array<hiAppEvent.AppEventGroup> = [];
  @Consume eventIndex: number;

  async aboutToAppear() {
    logger.info(TAG, `aboutToAppear start`);
    // 獲取Preferences實(shí)例
    PreferencesManager.getPreferences(this.faultDataSource);
  }

  // 獲取應(yīng)用異常信息
  async getFaultMessage() {
    logger.info(TAG, `getAppEventGroups start`);
    if (this.appEventGroups && this.appEventGroups.length > 0) {
      // 遍歷事件組
      this.appEventGroups.forEach((eventGroup: hiAppEvent.AppEventGroup) => {
        // 遍歷事件對(duì)象集合
        eventGroup.appEventInfos.forEach(async (eventInfo: hiAppEvent.AppEventInfo) => {
          let message: string = '';
          message += `HiAppEvent eventInfo.domain=${eventInfo.domain}\n` // 事件領(lǐng)域
            + `HiAppEvent eventInfo.name=${eventInfo.name}\n`  // 事件名稱(chēng)
            + `HiAppEvent eventInfo.eventType=${eventInfo.eventType}\n` // 事件名稱(chēng)
            + `HiAppEvent eventInfo.params.time=${eventInfo.params['time']}\n` // 事件發(fā)生的時(shí)間
            + `HiAppEvent eventInfo.params.crash_type=${eventInfo.params['crash_type']}\n`
            + `HiAppEvent eventInfo.params.foreground=${eventInfo.params['foreground']}\n`
            + `HiAppEvent eventInfo.params.bundle_version=${eventInfo.params['bundle_version']}\n`
            + `HiAppEvent eventInfo.params.bundle_name=${eventInfo.params['bundle_name']}\n`
            + `HiAppEvent eventInfo.params.exception=${JSON.stringify(eventInfo.params['exception'])}\n`
            + `HiAppEvent eventInfo.params.hilog.size=${eventInfo.params['hilog'].length}\n`;
          // TODO：知識(shí)點(diǎn)：將異常信息存儲(chǔ)到數(shù)組faultMessage當(dāng)中
          this.faultDataSource.pushData(message);
        })
      })
    }
    // TODO：知識(shí)點(diǎn)：持久化存儲(chǔ)異常信息集合
    this.faultDataSource.persistenceStorage();
  }

  build() {
    List() {
      // 添加判斷，如果異常信息集合的信息條數(shù)大于0，遍歷異常信息
      if (this.faultDataSourceLength > 0) {
        // 性能：動(dòng)態(tài)加載數(shù)據(jù)場(chǎng)景可以使用LazyForEach遍歷數(shù)據(jù)。https://developer.harmonyos.com/cn/docs/documentation/doc-guides-V3/arkts-rendering-control-lazyforeach-0000001524417213-V3
        LazyForEach(this.faultDataSource, (message: string) => {
          ListItem() {
            Text(message)
              .textAlign(TextAlign.Start)
          }
        }, (item: string) => item)
      } else {
        ListItem() {
          // 根據(jù)被點(diǎn)擊事件的下標(biāo)響應(yīng)指定的信息
          Text(this.eventIndex === 0 ? $r('app.string.crash_event_message') :
            (this.eventIndex === 1 ? $r('app.string.freeze_event_message') :
              (this.faultSign ? $r('app.string.data_delay_toast') :
              $r('app.string.no_message'))))
        }
      }
    }
    .width('92%')
    .height(300)
    .shadow(ShadowStyle.OUTER_DEFAULT_SM)
    .borderRadius($r('app.string.ohos_id_corner_radius_default_m'))
    .padding($r('app.string.ohos_id_card_padding_start'))
  }
}
  1. 以上代碼中有引用懶加載數(shù)據(jù)類(lèi)和持久化存儲(chǔ)類(lèi)，源碼可參考DataSource.ets和 PreferencesManager.ets。
// DataSource.ets
export class FaultDataSource extends BasicDataSource {
  // 懶加載數(shù)據(jù)
  private faultMessage: Array<string> = [];

  // TODO：知識(shí)點(diǎn)：獲取懶加載數(shù)據(jù)源的數(shù)據(jù)長(zhǎng)度
  totalCount(): number {
    return this.faultMessage.length;
  }

  // 獲取指定數(shù)據(jù)項(xiàng)
  getData(index: number): string {
    return this.faultMessage[index];
  }

  // TODO：知識(shí)點(diǎn)：存儲(chǔ)數(shù)據(jù)到懶加載數(shù)據(jù)源中
  pushData(data: string): void {
    this.faultMessage.push(data);
    // 在數(shù)組頭部添加數(shù)據(jù)
    this.notifyDataAdd(this.faultMessage.length - 1);
    AppStorage.setOrCreate('faultDataSourceLength', this.totalCount());
  }

  // TODO：知識(shí)點(diǎn)：持久化存儲(chǔ)異常信息集合
  persistenceStorage(): void {
    PreferencesManager.putFaultMessage(this.faultMessage);
  }
}

// PreferencesManager.ets
 /**
   * 存儲(chǔ)數(shù)據(jù)異常信息
   * @param faultMessage 異常信息集合
   */
  public static putFaultMessage(faultMessage: Array<string>) {
    logger.info(`putMessage start`);
    try {
      // TODO：知識(shí)點(diǎn)：通過(guò) dataPreferencesManager.put方法存儲(chǔ)數(shù)據(jù)
      dataPreferencesManager.put('faultMessage', JSON.stringify(faultMessage), async (err: BusinessError) => {
        if (err) {
          logger.error("Failed to put value of 'faultMessage'. code =" + err.code + ", message =" + err.message);
          return;
        }
        logger.info('Succeeded in putting value of faultMessage.');
        dataPreferencesManager.flush();
      })
    } catch (err) {
      let code = (err as BusinessError).code;
      let message = (err as BusinessError).message;
      logger.error("Failed to put value of 'catch err'. code =" + err.code + ", message =" + err.message);
    }
  }

  /**
   * 獲取數(shù)據(jù)異常信息
   * @param faultMessage 異常信息集合
   */
  public static getFaultMessage(faultDataSource:FaultDataSource) {
    logger.info(`getFaultMessage start`);
    try {
      // TODO：知識(shí)點(diǎn)：通過(guò)dataPreferencesManager.get方法獲取異常信息數(shù)據(jù)
      let promise = dataPreferencesManager.get('faultMessage', []);
      promise.then(async (data: dataPreferences.ValueType) => {
        if (typeof data === 'string') {
          let faultData: Array<string> = JSON.parse(data);
          // 將異常數(shù)據(jù)添加到懶加載數(shù)據(jù)源中
          faultData.forEach((item: string) => {
            faultDataSource.pushData(item);
          })
          // 雙向數(shù)據(jù)綁定懶加載數(shù)據(jù)源長(zhǎng)度，更新數(shù)據(jù)源長(zhǎng)度
          AppStorage.setOrCreate('faultDataSourceLength',faultDataSource.totalCount())
          logger.info('Succeeded in getting value of faultMessage.');
        }
      })
    } catch (err) {
      logger.error("Failed to get value of 'catch err'. code =" + err.code + ", message =" + err.message);
    }
  }

高性能知識(shí)點(diǎn)

本示例使用了LazyForEach進(jìn)行數(shù)據(jù)懶加載，將疊加獲取到的應(yīng)用異常信息進(jìn)行渲染。

工程結(jié)構(gòu)&模塊類(lèi)型

aplicationexception                             // har類(lèi)型
|---model
|   |---DataSource.ets                          // 模型層-懶加載數(shù)據(jù)源
|   |---EventSubscription.ets                   // 數(shù)據(jù)模型層-訂閱應(yīng)用事件
|   |---MockData.ets                            // 數(shù)據(jù)模型層-模擬數(shù)據(jù)
|   |---PreferencesManager.ets                  // 數(shù)據(jù)模型層-持久化存儲(chǔ)
|---view
|   |---PreferencesManager.ets                  // 視圖層-應(yīng)用異常頁(yè)面

模塊依賴(lài)

本實(shí)例依賴(lài)common模塊來(lái)實(shí)現(xiàn)日志的打印、資源的調(diào)用以及公共組件FunctionDescription的引用。

參考資料

應(yīng)用事件打點(diǎn)HiAppEvent 數(shù)據(jù)懶加載LazyForEach

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
平臺(tái)聲明：文章內(nèi)容（如有圖片或視頻亦包括在內(nèi)）由作者上傳并發(fā)布，文章內(nèi)容僅代表作者本人觀點(diǎn)，簡(jiǎn)書(shū)系信息發(fā)布平臺(tái)，僅提供信息存儲(chǔ)服務(wù)。

推薦閱讀更多精彩內(nèi)容