HarmonyOS-日志打印

79 阅读2分钟

HiLog

在应用开发过程中,可在关键代码处输出日志信息。在运行应用后,通过查看日志信息来分析应用执行情况(如应用是否正常运行、代码运行时序、运行逻辑分支是否正常等)。

系统提供不同的API供开发者调用并输出日志信息,即HiLog与console。两个API在使用时略有差异,在日常的开发过程中,更推荐使用HiLog,console的具体用法可查看API参考console

一、日志级别

HiLog中定义了DEBUG、INFO、WARN、ERROR、FATAL五种日志级别,并提供了对应的方法输出不同级别的日志,接口如下表所示,具体说明可查阅API参考文档

接口名功能描述
isLoggable(domain: number, tag: string, level: LogLevel)在打印日志前调用该接口,检查指定领域标识、日志标识和级别的日志是否可以打印。
debug(domain: number, tag: string, format: string, ...args: any[])输出DEBUG级别日志。仅用于应用/服务调试。在DevEco Studio的terminal窗口或cmd里,通过命令“hdc shell hilogcat”设置可打印日志的等级为DEBUG。
info(domain: number, tag: string, format: string, ...args: any[])输出INFO级别日志。表示普通的信息。
warn(domain: number, tag: string, format: string, ...args: any[])输出WARN级别日志。表示存在警告。
error(domain: number, tag: string, format: string, ...args: any[])输出ERROR级别日志。表示存在错误。
fatal(domain: number, tag: string, format: string, ...args: any[])输出FATAL级别日志。表示出现致命错误、不可恢复错误。

二、参数解析

  • domain:用于指定输出日志所对应的业务领域,取值范围为0x0000~0xFFFF,开发者可以根据需要进行自定义。
  • tag:用于指定日志标识,可以为任意字符串,建议标识调用所在的类或者业务行为。
  • level:用于指定日志级别。取值见LogLevel
  • format:格式字符串,用于日志的格式化输出。日志打印的格式化参数需按照“%{private flag}specifier”的格式打印。格式字符串中可以设置多个参数,例如格式字符串为“%s World”,“%s”为参数类型为string的变参标识,具体取值在args中定义。
  • args:可以为0个或多个参数,是格式字符串中参数类型对应的参数列表。参数的数量、类型必须与格式字符串中的标识一一对应。

注意:

  • isLoggable()和具体日志打印接口使用的domain和tag应保持一致。
  • isLoggable()使用的level,应和具体日志打印接口级别保持一致。

三、约束与限制

日志打印最多打印4096字节,超出限制文本将被截断。