回复
HarmonyOS API：@ohos.hilog (HiLog日志打印)
joytrian
发布于 2023-4-7 16:06
浏览
0收藏
版本：v3.1 Beta
@ohos.hilog (HiLog日志打印)
更新时间: 2023-02-17 09:19
hilog日志系统，使应用/服务可以按照指定级别、标识和格式字符串输出日志内容，帮助开发者了解应用/服务的运行状态，更好地调试程序。
说明
本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
导入模块
import hilog from '@ohos.hilog';
hilog.isLoggable
isLoggable(domain: number, tag: string, level: LogLevel) : boolean
在打印日志前调用该接口，用于检查指定领域标识、日志标识和级别的日志是否可以打印。
系统能力： SystemCapability.HiviewDFX.HiLog
参数：
参数名 | 类型 | 必填 | 说明 |
domain | number | 是 | 日志对应的领域标识，范围是0x0~0xFFFF。 建议开发者在应用内根据需要自定义划分。 |
tag | string | 是 | 指定日志标识，可以为任意字符串，建议用于标识调用所在的类或者业务行为。 |
level | 是 | 日志级别。 |
返回值：
类型 | 说明 |
boolean | 如果返回true，则该领域标识、日志标识和级别的日志可以打印，否则不能打印。 |
示例：
hilog.isLoggable(0x0001, "testTag", hilog.LogLevel.INFO);
LogLevel
日志级别。
系统能力： SystemCapability.HiviewDFX.HiLog
名称 | 值 | 说明 |
DEBUG | 3 | 详细的流程记录，通过该级别的日志可以更详细地分析业务流程和定位分析问题。 |
INFO | 4 | 用于记录业务关键流程节点，可以还原业务的主要运行过程； 用于记录可预料的非正常情况信息，如无网络信号、登录失败等。 这些日志都应该由该业务内处于支配地位的模块来记录，避免在多个被调用的模块或低级函数中重复记录。 |
WARN | 5 | 用于记录较为严重的非预期情况，但是对用户影响不大，应用可以自动恢复或通过简单的操作就可以恢复的问题。 |
ERROR | 6 | 应用发生了错误，该错误会影响功能的正常运行或用户的正常使用，可以恢复但恢复代价较高，如重置数据等。 |
FATAL | 7 | 重大致命异常，表明应用即将崩溃，故障无法恢复。 |
hilog.debug
debug(domain: number, tag: string, format: string, ...args: any[]) : void
打印DEBUG级别的日志。
DEBUG级别的日志在正式发布版本中默认不被打印，只有在调试版本或打开调试开关的情况下才会打印。
系统能力： SystemCapability.HiviewDFX.HiLog
参数：
参数名 | 类型 | 必填 | 说明 |
domain | number | 是 | 日志对应的领域标识，范围是0x0~0xFFFF。 建议开发者在应用内根据需要自定义划分。 |
tag | string | 是 | 指定日志标识，可以为任意字符串，建议用于标识调用所在的类或者业务行为。 |
format | string | 是 | 格式字符串，用于日志的格式化输出。格式字符串中可以设置多个参数，参数需要包含参数类型、隐私标识。 隐私标识分为{public}和{private}，缺省为{private}。标识{public}的内容明文输出，标识{private}的内容以<private>过滤回显。 |
args | any[] | 是 | 与格式字符串format对应的可变长度参数列表。参数数目、参数类型必须与格式字符串中的标识一一对应。 |
示例：
输出一条DEBUG信息，格式字符串为"%{public}s World %{private}d"。其中变参%{public}s为明文显示的字符串；%{private}d为隐私的整型数。
hilog.debug(0x0001, "testTag", "%{public}s World %{private}d", "hello", 3);字符串"hello"填入%{public}s，整型数3填入%{private}d，输出日志：
08-05 12:21:47.579 2695-2703/com.example.myapplication D 00001/testTag: hello World <private>
hilog.info
info(domain: number, tag: string, format: string, ...args: any[]) : void
打印INFO级别的日志。
系统能力： SystemCapability.HiviewDFX.HiLog
参数：
参数名 | 类型 | 必填 | 说明 |
domain | number | 是 | 日志对应的领域标识，范围是0x0~0xFFFF。 建议开发者在应用内根据需要自定义划分。 |
tag | string | 是 | 指定日志标识，可以为任意字符串，建议用于标识调用所在的类或者业务行为。 |
format | string | 是 | 格式字符串，用于日志的格式化输出。格式字符串中可以设置多个参数，参数需要包含参数类型、隐私标识。 隐私标识分为{public}和{private}，缺省为{private}。标识{public}的内容明文输出，标识{private}的内容以<private>过滤回显。 |
args | any[] | 是 | 与格式字符串format对应的可变长度参数列表。参数数目、参数类型必须与格式字符串中的标识一一对应。 |
示例：
输出一条INFO信息，格式字符串为"%{public}s World %{private}d"。其中变参%{public}s为明文显示的字符串；%{private}d为隐私的整型数。
hilog.info(0x0001, "testTag", "%{public}s World %{private}d", "hello", 3);字符串"hello"填入%{public}s，整型数3填入%{private}d，输出日志：
08-05 12:21:47.579 2695-2703/com.example.myapplication I 00001/testTag: hello World <private>
hilog.warn
warn(domain: number, tag: string, format: string, ...args: any[]) : void
打印WARN级别的日志。
系统能力： SystemCapability.HiviewDFX.HiLog
参数：
参数名 | 类型 | 必填 | 说明 |
domain | number | 是 | 日志对应的领域标识，范围是0x0~0xFFFF。 建议开发者在应用内根据需要自定义划分。 |
tag | string | 是 | 指定日志标识，可以为任意字符串，建议用于标识调用所在的类或者业务行为。 |
format | string | 是 | 格式字符串，用于日志的格式化输出。格式字符串中可以设置多个参数，参数需要包含参数类型、隐私标识。 隐私标识分为{public}和{private}，缺省为{private}。标识{public}的内容明文输出，标识{private}的内容以<private>过滤回显。 |
args | any[] | 是 | 与格式字符串format对应的可变长度参数列表。参数数目、参数类型必须与格式字符串中的标识一一对应。 |
示例：
输出一条WARN信息，格式字符串为"%{public}s World %{private}d"。其中变参%{public}s为明文显示的字符串；%{private}d为隐私的整型数。
hilog.warn(0x0001, "testTag", "%{public}s World %{private}d", "hello", 3);字符串"hello"填入%{public}s，整型数3填入%{private}d，输出日志：
08-05 12:21:47.579 2695-2703/com.example.myapplication W 00001/testTag: hello World <private>
hilog.error
error(domain: number, tag: string, format: string, ...args: any[]) : void
打印ERROR级别的日志。
系统能力： SystemCapability.HiviewDFX.HiLog
参数：
参数名 | 类型 | 必填 | 说明 |
domain | number | 是 | 日志对应的领域标识，范围是0x0~0xFFFF。 建议开发者在应用内根据需要自定义划分。 |
tag | string | 是 | 指定日志标识，可以为任意字符串，建议用于标识调用所在的类或者业务行为。 |
format | string | 是 | 格式字符串，用于日志的格式化输出。格式字符串中可以设置多个参数，参数需要包含参数类型、隐私标识。 隐私标识分为{public}和{private}，缺省为{private}。标识{public}的内容明文输出，标识{private}的内容以<private>过滤回显。 |
args | any[] | 是 | 与格式字符串format对应的可变长度参数列表。参数数目、参数类型必须与格式字符串中的标识一一对应。 |
示例：
输出一条ERROR信息，格式字符串为"%{public}s World %{private}d"。其中变参%{public}s为明文显示的字符串；%{private}d为隐私的整型数。
hilog.error(0x0001, "testTag", "%{public}s World %{private}d", "hello", 3);字符串"hello"填入%{public}s，整型数3填入%{private}d，输出日志：
08-05 12:21:47.579 2695-2703/com.example.myapplication E 00001/testTag: hello World <private>
hilog.fatal
fatal(domain: number, tag: string, format: string, ...args: any[]) : void
打印FATAL级别的日志。
系统能力： SystemCapability.HiviewDFX.HiLog
参数：
参数名 | 类型 | 必填 | 说明 |
domain | number | 是 | 日志对应的领域标识，范围是0x0~0xFFFF。 建议开发者在应用内根据需要自定义划分。 |
tag | string | 是 | 指定日志标识，可以为任意字符串，建议用于标识调用所在的类或者业务行为。 |
format | string | 是 | 格式字符串，用于日志的格式化输出。格式字符串中可以设置多个参数，参数需要包含参数类型、隐私标识。 隐私标识分为{public}和{private}，缺省为{private}。标识{public}的内容明文输出，标识{private}的内容以<private>过滤回显。 |
args | any[] | 是 | 与格式字符串format对应的可变长度参数列表。参数数目、参数类型必须与格式字符串中的标识一一对应。 |
示例：
输出一条FATAL信息，格式字符串为"%{public}s World %{private}d"。其中变参%{public}s为明文显示的字符串；%{private}d为隐私的整型数。
hilog.fatal(0x0001, "testTag", "%{public}s World %{private}d", "hello", 3);字符串"hello"填入%{public}s，整型数3填入%{private}d，输出日志：
08-05 12:21:47.579 2695-2703/com.example.myapplication F 00001/testTag: hello World <private>分类
已于2023-4-7 16:06:59修改
赞
收藏
回复
相关推荐
