HiChecker

java.lang.Object
- ohos.hiviewdfx.HiChecker

```
public class HiChecker
extends Object
```
Represents the HiChecker tool that is used to detect bad code usage and execution results during your application and system development.
You can use HiChecker to detect any file read/write or network access operation that is not supposed to take place on a specific thread, helping you fix the issue. For example, you can use HiChecker to catch file read/write on the UI thread, which should not involve such time-consuming operations. In addition, you can use HiChecker to detect process-specific resource leakage.
Sample code for adding a rule and starting detection:
```
 if (HICHECKER_ENABLED) {
     EnumSet<Rule> rules = EnumSet.of(Rule.CHECK_FILE_READ, Rule.CHECK_VM_RELEASE_MISS, Rule.CAUTION_BY_LOG);
     HiChecker.addRule(rules);
 }
 
```
从以下版本开始:

5

嵌套类概要

嵌套类
限定符和类型	类	说明
`static interface`	`HiChecker.OnCautionListener`	Obtains and handles cautions.
`static class`	`HiChecker.Rule`	Enumerates detection rules and caution rules.

方法概要

所有方法静态方法具体方法
限定符和类型	方法	说明
`static void`	`addAllRules()`	Adds all rules to start detection.
`static void`	`addDefaultRules()`	Adds default rules to start detection.
`static void`	`addRule(EnumSet<HiChecker.Rule> rules)`	Adds one or more rules for HiChecker.
`static void`	`addRule(HiChecker.Rule rule)`	Adds a rule for HiChecker.
`static boolean`	`contains(HiChecker.Rule rule)`	Checks whether a specified rule is included in the added rules.
`static EnumSet<HiChecker.Rule>`	`getRule()`	Obtains all available rules.
`static void`	`notifySlowProcess(String tag)`	Notifies your application of a slow processing if the current code has invoked time-consuming operations.
`static void`	`removeAllRules()`	Removes all available rules.
`static EnumSet<HiChecker.Rule>`	`removeCheckFileReadRule()`	Removes the rule of detecting file read operations.
`static EnumSet<HiChecker.Rule>`	`removeCheckFileWriteRule()`	Removes the rule of detecting file write operations.
`static void`	`removeRule(EnumSet<HiChecker.Rule> rules)`	Removes one or more rules.
`static void`	`removeRule(HiChecker.Rule rule)`	Removes a rule.
`static void`	`setCautionListener(Executor executor, HiChecker.OnCautionListener listener)`	Sets a callback for caution handling.

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 方法详细资料
  - addRule
```
public static void addRule(EnumSet<HiChecker.Rule> rules)
```
    Adds one or more rules for HiChecker.
    HiChecker detects unexpected operations or gives feedback based on the added rules.
    
    参数:
    
    rules - Indicates one or more rules you want to add. If this parameter is null, HiChecker will not perform detection or give feedback.
    
    从以下版本开始:
    
    5
    
    另请参阅:
    
    HiChecker.Rule
  - addRule
```
public static void addRule(HiChecker.Rule rule)
```
    Adds a rule for HiChecker.
    HiChecker detects unexpected operations or gives feedback based on the added rule.
    
    参数:
    
    rule - Indicates the rule you want to add. If this parameter is null, HiChecker will not perform detection or give feedback.
    
    从以下版本开始:
    
    5
    
    另请参阅:
    
    HiChecker.Rule
  - addDefaultRules
```
public static void addDefaultRules()
```
    Adds default rules to start detection.
    Available default rules cover all those specific to the current thread and process, and the caution rule (cautions just being logged, as defined by Rule.CAUTION_BY_LOG).
    
    从以下版本开始:
    
    5
    
    另请参阅:
    
    HiChecker.Rule
  - addAllRules
```
public static void addAllRules()
```
    Adds all rules to start detection.
    Such rules cover all those specific to the current thread, process, and caution.
    
    从以下版本开始:
    
    5
    
    另请参阅:
    
    HiChecker.Rule
  - removeRule
```
public static void removeRule(EnumSet<HiChecker.Rule> rules)
```
    Removes one or more rules. The removed rules will no longer take effect.
    
    参数:
    
    rules - Indicates one or more rules you want to remove.
    
    从以下版本开始:
    
    5
    
    另请参阅:
    
    HiChecker.Rule
  - removeRule
```
public static void removeRule(HiChecker.Rule rule)
```
    Removes a rule. The removed rule will no longer take effect.
    
    参数:
    
    rule - Indicates the rule you want to remove.
    
    从以下版本开始:
    
    5
    
    另请参阅:
    
    HiChecker.Rule
  - removeAllRules
```
public static void removeAllRules()
```
    Removes all available rules.
    
    从以下版本开始:
    
    5
  - getRule
```
public static EnumSet<HiChecker.Rule> getRule()
```
    Obtains all available rules.
    Such rules cover all those specific to the current thread, process, and caution.
    
    返回:
    
    Returns the obtained rules.
    
    从以下版本开始:
    
    5
  - contains
```
public static boolean contains(HiChecker.Rule rule)
```
    Checks whether a specified rule is included in the added rules.
    If the specified rule is thread-specific, this method only checks the current thread for that rule.
    
    参数:
    
    rule - Indicates the specified rule.
    
    返回:
    
    Returns true if the specified rule is included; returns false otherwise.
    
    从以下版本开始:
    
    5
    
    另请参阅:
    
    HiChecker.Rule
  - removeCheckFileWriteRule
```
public static EnumSet<HiChecker.Rule> removeCheckFileWriteRule()
```
    Removes the rule of detecting file write operations.
    You can call this method when file write operations are regarded normal. After the removal, you can restore the rule if required.
    
    返回:
    
    Returns the rules before removal.
    
    从以下版本开始:
    
    5
  - removeCheckFileReadRule
```
public static EnumSet<HiChecker.Rule> removeCheckFileReadRule()
```
    Removes the rule of detecting file read operations.
    You can call this method when file read operations are regarded normal. After the removal, you can restore the rule if required.
    
    返回:
    
    Returns the rules before removal.
    
    从以下版本开始:
    
    5
  - notifySlowProcess
```
public static void notifySlowProcess(String tag)
```
    Notifies your application of a slow processing if the current code has invoked time-consuming operations.
    This notification helps your application avoid calling the current code in a key thread.
    
    参数:
    
    tag - Indicates the slow processing tag, which reflects information except for stack information.
    
    从以下版本开始:
    
    5
  - setCautionListener
```
public static void setCautionListener(Executor executor,
                                      HiChecker.OnCautionListener listener)
```
    Sets a callback for caution handling.
    After a caution is generated, the preset rules (such as caution logging) are applied and the caution is passed via the callback to the application for caution handling.
    
    参数:
    
    executor - Indicates the provided Executor object, where the callback will be executed. If this parameter is null, a null pointer will be thrown.
    
    listener - Indicates the OnCautionListener object. If this parameter is null, a null pointer will be thrown.
    
    从以下版本开始:
    
    5
    
    另请参阅:
    
    HiChecker.OnCautionListener

类 HiChecker

嵌套类概要

方法概要

从类继承的方法 java.lang.Object

方法详细资料

addRule

addRule

addDefaultRules

addAllRules

removeRule

removeRule

removeAllRules

getRule

contains

removeCheckFileWriteRule

removeCheckFileReadRule

notifySlowProcess

setCautionListener