From 28eebf60e4282088bed3ccd5b114f7eb6c899267 Mon Sep 17 00:00:00 2001 From: zengyawen Date: Wed, 25 May 2022 03:52:44 +0000 Subject: [PATCH] update zh-cn/application-dev/reference/apis/js-apis-hichecker.md. Signed-off-by: zengyawen --- .../reference/apis/js-apis-hichecker.md | 39 ++++++++++--------- 1 file changed, 20 insertions(+), 19 deletions(-) diff --git a/zh-cn/application-dev/reference/apis/js-apis-hichecker.md b/zh-cn/application-dev/reference/apis/js-apis-hichecker.md index 8b7b1f06a1..ab3edd6a3d 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-hichecker.md +++ b/zh-cn/application-dev/reference/apis/js-apis-hichecker.md @@ -1,12 +1,14 @@ # 检测模式 +HiChecker可以作为应用开发阶段使用的检测工具，用于检测代码运行过程中部分易忽略的问题，如应用线程出现耗时调用、应用进程中Ability资源泄露等问题。开发者可以通过日志记录或进程crash等形式查看具体问题并进行修改，提升应用的使用体验。 + > **说明：** > 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 ## 导入模块 -``` +```js import hichecker from '@ohos.hichecker'; ``` @@ -15,20 +17,19 @@ import hichecker from '@ohos.hichecker'; 提供了所有规则类型的常量。 -**系统能力：** 以下各项对应的系统能力均为SystemCapability.HiviewDFX.HiChecker。 +**系统能力：** SystemCapability.HiviewDFX.HiChecker | 名称 | 参数类型 | 说明 | | ---------------------------------- | -------- | ------------------------------------------------------ | -| RULE_CAUTION_PRINT_LOG | BigInt | 告警规则，当有告警时记录日志。 | -| RULE_CAUTION_TRIGGER_CRASH | BigInt | 告警规则，当有告警时让应用推出。 | -| RULE_THREAD_CHECK_SLOW_PROCESS | BigInt | 检测规则，检测是否有耗时函数被调用。 | -| RULE_CHECK_SLOW_EVENT | BigInt | 检测规则，检测是否有事件分发或处理超过规定的时间阈值。 | -| RULE_CHECK_ABILITY_CONNECTION_LEAK | BigInt | 检测规则，检测是否发生ability泄露。 | +| 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 +addRule(rule: bigInt): void 添加一条或多条规则到系统，系统根据添加的规则进行检测或反馈。 @@ -38,11 +39,11 @@ addRule(rule: BigInt): void | 参数名 | 类型 | 必填 | 说明 | | ------ | ------ | ---- | ---------------- | -| rule | BigInt | 是 | 需要添加的规则。 | +| rule | bigInt | 是 | 需要添加的规则。 | **示例：** -``` +```js // 添加一条规则 hichecker.addRule(hichecker.RULE_CAUTION_PRINT_LOG); @@ -53,7 +54,7 @@ hichecker.addRule( ## hichecker.removeRule -removeRule(rule: BigInt): void +removeRule(rule: bigInt): void 删除一条或多条规则，删除的规则后续将不再生效。 @@ -63,11 +64,11 @@ removeRule(rule: BigInt): void | 参数名 | 类型 | 必填 | 说明 | | ------ | ------ | ---- | ---------------- | -| rule | BigInt | 是 | 需要删除的规则。 | +| rule | bigInt | 是 | 需要删除的规则。 | **示例：** -``` +```js // 删除一条规则 hichecker.removeRule(hichecker.RULE_CAUTION_PRINT_LOG); @@ -78,7 +79,7 @@ hichecker.removeRule( ## hichecker.getRule -getRule(): BigInt +getRule(): bigInt 获取当前线程规则、进程规则、告警规则的合集。 @@ -88,11 +89,11 @@ getRule(): BigInt | 类型 | 说明 | | ------ | ---------------------- | -| BigInt | 当前系统中添加的规则。 | +| bigInt | 当前系统中添加的规则。 | **示例：** -``` +```js // 添加一条规则 hichecker.addRule(hichecker.RULE_THREAD_CHECK_SLOW_PROCESS); @@ -102,7 +103,7 @@ hichecker.getRule(); // return 1n; ## hichecker.contains -contains(rule: BigInt): boolean +contains(rule: bigInt): boolean 当前已添加的规则集中是否包含了某一个特定的规则，如果传入的规则级别为线程级别，则仅在当前线程中进行查询。 @@ -112,7 +113,7 @@ contains(rule: BigInt): boolean | 参数名 | 类型 | 必填 | 说明 | | ------ | ------ | ---- | ---------------- | -| rule | BigInt | 是 | 需要查询的规则。 | +| rule | bigInt | 是 | 需要查询的规则。 | **返回值：** @@ -122,7 +123,7 @@ contains(rule: BigInt): boolean **示例：** -``` +```js // 添加一条规则 hichecker.addRule(hichecker.RULE_THREAD_CHECK_SLOW_PROCESS); -- GitLab