程序包 ohos.hiviewdfx

类 HiLog

java.lang.Object

ohos.hiviewdfx.HiLog

public final class HiLog
extends Object

Provides methods for outputting HiLog logs.

Before outputting logs, you must define the log type, service domain, and tag in HiLogLabel, use the interface specific to the specified log level, and specify the privacy identifier.

Log level: debug, info, warn, error, and fatal

Parameter format: printf format string, which starts with a % character, including a parameter type identifier and a variable parameter.

Privacy identifier: {public} or {private} added between the % character and the parameter type identifier in each parameter.

Example code:

Defining a label:

    static final HiLogLabel label = new HiLogLabel(HiLog.LOG_APP, MY_MODULE, "MY_TAG"); //MY_MODULE=0x00201
 

Code:

    HiLog.warn(label, "Failed to visit %{private}s, reason:%{public}d.", url, errno);
 

Result: 05-26 11:01:06.870 1051 1051 W 00201/test: Failed to visit <private>, reason:503.

Note: Each parameter has a privacy identifier. If no privacy identifier is added, the parameter is considered to be private.

从以下版本开始:

1

另请参阅:

HiLogLabel

字段概要

字段

限定符和类型	字段	说明
static int	DEBUG	Indicates the debug-level log.
static int	ERROR	Indicates the error-level log.
static int	FATAL	Indicates the fatal-level log.
static int	INFO	Indicates the info-level log.
static int	LOG_APP	Indicates the application log type.
static int	WARN	Indicates the warn-level log.

方法概要

限定符和类型	方法	说明
static int	debug(HiLogLabel label, String format, Object... args)	Outputs debug-level logs.
static int	error(HiLogLabel label, String format, Object... args)	Outputs error-level logs.
static int	fatal(HiLogLabel label, String format, Object... args)	Outputs fatal-level logs.
static String	getStackTrace(Throwable tr)	Obtains the method-call stack from the Throwable object.
static int	info(HiLogLabel label, String format, Object... args)	Outputs info-level logs.
static boolean	isLoggable(int domain, String tag, int level)	Checks whether logs of the specified service domain, tag, and level can be printed.
static int	warn(HiLogLabel label, String format, Object... args)	Outputs warn-level logs.

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

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

字段详细资料

DEBUG

public static final int DEBUG

Indicates the debug-level log.

Value: 3

从以下版本开始:

1

另请参阅:

常量字段值

ERROR

public static final int ERROR

Indicates the error-level log.

Value: 6

从以下版本开始:

1

另请参阅:

常量字段值

FATAL

public static final int FATAL

Indicates the fatal-level log.

Value: 7

从以下版本开始:

1

另请参阅:

常量字段值

INFO

public static final int INFO

Indicates the info-level log.

Value: 4

从以下版本开始:

1

另请参阅:

常量字段值

LOG_APP

public static final int LOG_APP

Indicates the application log type.

Value: 0

从以下版本开始:

1

另请参阅:

常量字段值

WARN

public static final int WARN

Indicates the warn-level log.

Value: 5

从以下版本开始:

1

另请参阅:

常量字段值

方法详细资料

debug

public static int debug(HiLogLabel label,
                        String format,
                        Object... args)

Outputs debug-level logs.

参数:

label - Identifies the log type, service domain, and tag.

format - Indicates a constant format string, including the parameter type and privacy identifier. If no privacy identifier is added, the parameter is considered to be private.

args - Indicates the parameter list corresponding to the parameter type in the format string. The number and type of parameters must be mapped onto the identifier in the format string.

返回:

Returns 0 or an int greater than 0 if the operation is successful; returns an int less than 0 otherwise.

从以下版本开始:

1

info

public static int info(HiLogLabel label,
                       String format,
                       Object... args)

Outputs info-level logs.

参数:

label - Identifies the log type, service domain, and tag.

format - Indicates a constant format string, including the parameter type and privacy identifier. If no privacy identifier is added, the parameter is considered to be private.

args - Indicates the parameter list corresponding to the parameter type in the format string. The number and type of parameters must be mapped onto the identifier in the format string.

返回:

Returns 0 or an int greater than 0 if the operation is successful; returns an int less than 0 otherwise.

从以下版本开始:

1

warn

public static int warn(HiLogLabel label,
                       String format,
                       Object... args)

Outputs warn-level logs.

参数:

label - Identifies the log type, service domain, and tag.

format - Indicates a constant format string, including the parameter type and privacy identifier. If no privacy identifier is added, the parameter is considered to be private.

args - Indicates the parameter list corresponding to the parameter type in the format string. The number and type of parameters must be mapped onto the identifier in the format string.

返回:

Returns 0 or an int greater than 0 if the operation is successful; returns an int less than 0 otherwise.

从以下版本开始:

1

error

public static int error(HiLogLabel label,
                        String format,
                        Object... args)

Outputs error-level logs.

参数:

label - Identifies the log type, service domain, and tag.

format - Indicates a constant format string, including the parameter type and privacy identifier. If no privacy identifier is added, the parameter is considered to be private.

args - Indicates the parameter list corresponding to the parameter type in the format string. The number and type of parameters must be mapped onto the identifier in the format string.

返回:

Returns 0 or an int greater than 0 if the operation is successful; returns an int less than 0 otherwise.

从以下版本开始:

1

fatal

public static int fatal(HiLogLabel label,
                        String format,
                        Object... args)

Outputs fatal-level logs.

参数:

label - Identifies the log type, service domain, and tag.

format - Indicates a constant format string, including the parameter type and privacy identifier. If no privacy identifier is added, the parameter is considered to be private.

args - Indicates the parameter list corresponding to the parameter type in the format string. The number and type of parameters must be mapped onto the identifier in the format string.

返回:

Returns 0 or an int greater than 0 if the operation is successful; returns an int less than 0 otherwise.

从以下版本开始:

1

isLoggable

public static boolean isLoggable(int domain,
                                 String tag,
                                 int level)

Checks whether logs of the specified service domain, tag, and level can be printed.

参数:

domain - Indicates the service domain of logs.

tag - Indicates the log tag.

level - Indicates the log level.

返回:

Returns true if the logs can be printed; returns false otherwise.

从以下版本开始:

1

getStackTrace

public static String getStackTrace(Throwable tr)

Obtains the method-call stack from the Throwable object.

参数:

tr - Indicates the Throwable object or the object of any of its subclasses. Throwable is the superclass of all errors and exceptions in the Java language.

返回:

Returns a string representing the method-call stack pertaining to this Throwable object.

从以下版本开始:

1