介紹
本示例介紹了透過應用事件打點hiAppEvent獲取上一次應用異常資訊的方法，主要分為應用崩潰、應用卡死以及系統查殺三種。
效果圖預覽
使用說明：
- 點選構建應用崩潰事件，3s之後應用退出，然後開啟應用進入應用異常頁面，隔1min左右後，顯示上次異常退出資訊。
- 點選構建應用卡死事件，需手動退出，然後開啟應用進入應用異常頁面，隔1min左右後，顯示上次異常退出資訊。
實現思路
- 構建應用異常。原始碼參考ApplicationException.ets
handleOperate(index: number) {
switch (index) {
case 0:
// 在按鈕點選函式中構造一個APP_CRASH場景，觸發應用崩潰事件
let result: object = JSON.parse('');
break;
case 1:
// 在按鈕點選函式中構造一個APP_FREEZE場景，觸發應用卡死事件,500ms之後執行無限迴圈
while (true) {
}
}
}
- 應用退出後，進入本頁面，等待訂閱訊息通知，待收到訂閱訊息後，透過EventSubscription.ets中的onReceive函式，接收到異常資訊資料， 並透過AppStorage.setOrCreate('appEventGroups',異常資訊資料)雙向繫結異常資訊，原始碼參考程式碼可參考EventSubscription.ets
import hiAppEvent from '@ohos.hiviewdfx.hiAppEvent';
import { logger } from '@ohos/base';
const TAG: string = 'eventSubscription';
export function eventSubscription() {
// 新增應用事件觀察者方法，可用於訂閱應用事件
hiAppEvent.addWatcher({
// 開發者可以自定義觀察者名稱，系統會使用名稱來標識不同的觀察者
name: "mst",
// 開發者可以訂閱感興趣的系統事件，此處是訂閱了崩潰事件
appEventFilters: [
{
domain: hiAppEvent.domain.OS,
names: [hiAppEvent.event.APP_CRASH, hiAppEvent.event.APP_FREEZE]
}
],
// TODO：知識點：獲取事件組資訊。開發者可以自行實現訂閱實時回撥函式，以便對訂閱獲取到的事件資料進行自定義處理
onReceive: async (domain: string, appEventGroups: Array<hiAppEvent.AppEventGroup>) => {
logger.info(TAG, `HiAppEvent onReceive: domain=${domain}`);
// 獲取事件組資訊，與ApplicationException檔案中的@StorageLink('faultMessage') faultMessage進行雙向資料繫結
AppStorage.setOrCreate('appEventGroups', appEventGroups);
}
});
}
- @StorageLink('appEventGroups')接收訂閱事件函式傳遞的事件組資訊，呼叫getFaultMessage函式對資訊進行處理，將處理後的資訊透過 this.faultDataSource.pushData(message) 新增到懶載入資料來源中，並透過this.faultDataSource.persistenceStorage()執行持久化儲存，最後透過使用LazyForEach將資料資訊載入到頁面上。 具體原始碼參考ApplicationException.ets
@Component
struct FaultArea {
// 懶載入資料來源
@State faultDataSource: FaultDataSource = new FaultDataSource();
// 雙向資料繫結懶載入資料來源的陣列長度
@StorageLink('faultDataSourceLength') faultDataSourceLength: number = 0;
// 雙向資料繫結事件組，與AppStorage.setOrCreate進行繫結，此變數發生變化觸發getFaultMessage函式
@StorageLink('appEventGroups') @Watch('getFaultMessage') appEventGroups: Array<hiAppEvent.AppEventGroup> = [];
@Consume eventIndex: number;
async aboutToAppear() {
logger.info(TAG, `aboutToAppear start`);
// 獲取Preferences例項
PreferencesManager.getPreferences(this.faultDataSource);
}
// 獲取應用異常資訊
async getFaultMessage() {
logger.info(TAG, `getAppEventGroups start`);
if (this.appEventGroups && this.appEventGroups.length > 0) {
// 遍歷事件組
this.appEventGroups.forEach((eventGroup: hiAppEvent.AppEventGroup) => {
// 遍歷事件物件集合
eventGroup.appEventInfos.forEach(async (eventInfo: hiAppEvent.AppEventInfo) => {
let message: string = '';
message += `HiAppEvent eventInfo.domain=${eventInfo.domain}\n` // 事件領域
+ `HiAppEvent eventInfo.name=${eventInfo.name}\n` // 事件名稱
+ `HiAppEvent eventInfo.eventType=${eventInfo.eventType}\n` // 事件名稱
+ `HiAppEvent eventInfo.params.time=${eventInfo.params['time']}\n` // 事件發生的時間
+ `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：知識點：將異常資訊儲存到陣列faultMessage當中
this.faultDataSource.pushData(message);
})
})
}
// TODO：知識點：持久化儲存異常資訊集合
this.faultDataSource.persistenceStorage();
}
build() {
List() {
// 新增判斷，如果異常資訊集合的資訊條數大於0，遍歷異常資訊
if (this.faultDataSourceLength > 0) {
// 效能：動態載入資料場景可以使用LazyForEach遍歷資料。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() {
// 根據被點選事件的下標響應指定的資訊
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'))
}
}
- 以上程式碼中有引用懶載入資料類和持久化儲存類，原始碼可參考DataSource.ets和 PreferencesManager.ets。
// DataSource.ets
export class FaultDataSource extends BasicDataSource {
// 懶載入資料
private faultMessage: Array<string> = [];
// TODO：知識點：獲取懶載入資料來源的資料長度
totalCount(): number {
return this.faultMessage.length;
}
// 獲取指定資料項
getData(index: number): string {
return this.faultMessage[index];
}
// TODO：知識點：儲存資料到懶載入資料來源中
pushData(data: string): void {
this.faultMessage.push(data);
// 在陣列頭部新增資料
this.notifyDataAdd(this.faultMessage.length - 1);
AppStorage.setOrCreate('faultDataSourceLength', this.totalCount());
}
// TODO：知識點：持久化儲存異常資訊集合
persistenceStorage(): void {
PreferencesManager.putFaultMessage(this.faultMessage);
}
}
// PreferencesManager.ets
/**
* 儲存資料異常資訊
* @param faultMessage 異常資訊集合
*/
public static putFaultMessage(faultMessage: Array<string>) {
logger.info(`putMessage start`);
try {
// TODO：知識點：透過 dataPreferencesManager.put方法儲存資料
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);
}
}
/**
* 獲取資料異常資訊
* @param faultMessage 異常資訊集合
*/
public static getFaultMessage(faultDataSource:FaultDataSource) {
logger.info(`getFaultMessage start`);
try {
// TODO：知識點：透過dataPreferencesManager.get方法獲取異常資訊資料
let promise = dataPreferencesManager.get('faultMessage', []);
promise.then(async (data: dataPreferences.ValueType) => {
if (typeof data === 'string') {
let faultData: Array<string> = JSON.parse(data);
// 將異常資料新增到懶載入資料來源中
faultData.forEach((item: string) => {
faultDataSource.pushData(item);
})
// 雙向資料繫結懶載入資料來源長度，更新資料來源長度
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);
}
}
高效能知識點
本示例使用了LazyForEach進行資料懶載入，將疊加獲取到的應用異常資訊進行渲染。
工程結構&模組型別
aplicationexception // har型別
|---model
| |---DataSource.ets // 模型層-懶載入資料來源
| |---EventSubscription.ets // 資料模型層-訂閱應用事件
| |---MockData.ets // 資料模型層-模擬資料
| |---PreferencesManager.ets // 資料模型層-持久化儲存
|---view
| |---PreferencesManager.ets // 檢視層-應用異常頁面
模組依賴
本例項依賴common模組來實現日誌的列印、資源的呼叫以及公共元件FunctionDescription的引用。
參考資料
應用事件打點HiAppEvent 資料懶載入LazyForEach