檢測模式

HiChecker可以作為應用開發階段使用的檢測工具，用于檢測代碼運行過程中部分易忽略的問題，如應用線程出現耗時調用、應用進程中Ability資源泄露等問題。開發者可以通過日志記錄或進程crash等形式查看具體問題并進行修改，提升應用的使用體驗。

說明： 本模塊首批接口從API version 8開始支持。后續版本的新增接口，采用上角標單獨標記接口的起始版本。 開發前請熟悉鴻蒙開發指導文檔 ：[gitee.com/li-shizhen-skin/harmony-os/blob/master/README.md]

導入模塊

import hichecker from '@ohos.hichecker';

常量

提供了所有規則類型的常量。

系統能力： SystemCapability.HiviewDFX.HiChecker

名稱	參數類型	說明
RULE_CAUTION_PRINT_LOG	bigint	告警規則，當有告警時記錄日志。
RULE_CAUTION_TRIGGER_CRASH	bigint	告警規則，當有告警時讓應用推出。
RULE_THREAD_CHECK_SLOW_PROCESS	bigint	檢測規則，檢測是否有耗時函數被調用。
RULE_CHECK_ABILITY_CONNECTION_LEAK	bigint	檢測規則，檢測是否發生ability泄露。

hichecker.addRule

addRule(rule: bigint): void

添加一條或多條規則到系統，系統根據添加的規則進行檢測或反饋。

系統能力： SystemCapability.HiviewDFX.HiChecker

參數：

參數名	類型	必填	說明
rule	bigint	是	需要添加的規則。

示例：

// 添加一條規則
hichecker.addRule(hichecker.RULE_CAUTION_PRINT_LOG);

// 添加多條規則
hichecker.addRule(
          hichecker.RULE_CAUTION_PRINT_LOG | hichecker.RULE_CAUTION_TRIGGER_CRASH);

hichecker.removeRule

removeRule(rule: bigint): void

刪除一條或多條規則，刪除的規則后續將不再生效。

系統能力： SystemCapability.HiviewDFX.HiChecker

參數：

參數名	類型	必填	說明
rule	bigint	是	需要刪除的規則。

示例：

// 刪除一條規則
hichecker.removeRule(hichecker.RULE_CAUTION_PRINT_LOG);

// 刪除多條規則
hichecker.removeRule(
          hichecker.RULE_CAUTION_PRINT_LOG | hichecker.RULE_CAUTION_TRIGGER_CRASH);

hichecker.getRule

getRule(): bigint

獲取當前線程規則、進程規則、告警規則的合集。

系統能力： SystemCapability.HiviewDFX.HiChecker

返回值：

類型	說明
bigint	當前系統中添加的規則。

示例：

// 添加一條規則
hichecker.addRule(hichecker.RULE_THREAD_CHECK_SLOW_PROCESS);

// 獲取已添加的規則
hichecker.getRule();   // return 1n;

hichecker.contains

contains(rule: bigint): boolean

當前已添加的規則集中是否包含了某一個特定的規則，如果傳入的規則級別為線程級別，則僅在當前線程中進行查詢。

系統能力： SystemCapability.HiviewDFX.HiChecker

參數：

參數名	類型	必填	說明
rule	bigint	是	需要查詢的規則。

返回值：

類型	說明
boolean	查詢結果，true 表示規則已添加，false 表示規則未添加。`HarmonyOS與OpenHarmony鴻蒙文檔籽料：mau123789是v直接拿`

搜狗高速瀏覽器截圖20240326151450.png

示例：

// 添加一條規則
hichecker.addRule(hichecker.RULE_THREAD_CHECK_SLOW_PROCESS);

// 查詢是否包含
hichecker.contains(hichecker.RULE_THREAD_CHECK_SLOW_PROCESS); // return true;
hichecker.contains(hichecker.RULE_CAUTION_PRINT_LOG); // return false;