1# 使用HiLog打印日志（ArkTS） 2 3<!--Kit: Performance Analysis Kit--> 4<!--Subsystem: HiviewDFX--> 5<!--Owner: @liuyifeifei;@buzhenwang--> 6<!--Designer: @shenchenkai--> 7<!--Tester: @liyang2235--> 8<!--Adviser: @foryourself--> 9 10在应用开发过程中，可在关键代码处输出日志信息。在运行应用后，通过查看日志信息来分析应用执行情况（如应用是否正常运行、代码运行时序、运行逻辑分支是否正常等）。 11 12 13系统提供不同的API供开发者调用并输出日志信息，即HiLog与Console。两个API在使用时略有差异，本文重点介绍HiLog的用法，Console的具体用法可查看API参考[Console](../reference/common/js-apis-logs.md)。 14 15 16## 接口说明 17 18HiLog中定义了DEBUG、INFO、WARN、ERROR、FATAL五种日志级别，并提供了对应的方法输出不同级别的日志，接口如下表所示，具体说明可查阅[API参考文档](../reference/apis-performance-analysis-kit/js-apis-hilog.md)。 19 20| 接口名 | 功能描述 | 21| -------- | -------- | 22| isLoggable(domain: number, tag: string, level: LogLevel) | 在打印日志前调用该接口，检查指定领域标识、日志标识和级别的日志是否可以打印。 | 23| debug(domain: number, tag: string, format: string, ...args: any[]) | 输出DEBUG级别日志。仅用于应用/服务调试。<br/>在DevEco Studio的terminal窗口或cmd里，通过命令“hdc shell hilog -b D”设置可打印日志的等级为DEBUG。 | 24| info(domain: number, tag: string, format: string, ...args: any[]) | 输出INFO级别日志。表示普通的信息。 | 25| warn(domain: number, tag: string, format: string, ...args: any[]) | 输出WARN级别日志。表示存在警告。 | 26| error(domain: number, tag: string, format: string, ...args: any[]) | 输出ERROR级别日志。表示存在错误。 | 27| fatal(domain: number, tag: string, format: string, ...args: any[]) | 输出FATAL级别日志。表示出现致命错误、不可恢复错误。 | 28| setMinLogLevel(level: LogLevel) | 设置应用日志打印的最低日志级别，用于拦截低级别日志打印。<br/>需要注意：如果设置的日志级别低于[全局日志级别](hilog.md#查看和设置日志级别)，设置不生效。<br/>**说明**：从API version 15开始，支持该接口。 | 29 30 31### 参数解析 32 33- **domain**：用于指定输出日志所对应的业务领域，取值范围为0x0000~0xFFFF，开发者可以根据需要进行自定义。 34 35- **tag**：用于指定日志标识，可以为任意字符串，建议标识调用所在的类或者业务行为。tag最多为31字节，超出后会截断。不建议使用中文字符，可能出现乱码或者对齐问题。 36 37- **level**：用于指定日志级别。取值见[LogLevel](../reference/apis-performance-analysis-kit/js-apis-hilog.md#loglevel)。 38 39- **format**：格式字符串，用于日志的格式化输出。日志打印的格式化参数需按照“%{private flag}specifier”的格式打印。 40 41 | 隐私标识符（private flag） | 说明 | 42 | -------- | -------- | 43 | private | 表示日志打印结果不可见，输出结果为<private>。 | 44 | public | 表示日志打印结果可见，明文显示参数。 | 45 | 无 | 缺省值默认为private，日志打印结果不可见。 | 46 47 | 格式说明符（specifier） | 说明 | 示例 | 48 | -------- | -------- | -------- | 49 | d/i | 支持打印number和bigint类型。 | 123 | 50 | s | 支持打印string、undefined、boolean和null类型。 | "123" | 51 | o/O | 支持打印object、undefined和null类型。<br/>从API version 20开始，支持该能力。 | { 'name': "Jack", 'age': 22 } | 52 53 格式字符串中可以设置多个参数，例如格式字符串为“%{public}s World”，“%{public}s”表示参数类型为string的变参标识，具体取值在args中定义。 54 55 debug应用无隐私管控机制，使用上述任意隐私标识符打印日志，都可明文显示参数。 56 57- **args**：可以为0个或多个参数，是格式字符串中参数类型对应的参数列表。参数的数量、类型必须与格式字符串中的标识一一对应。 58 59> **说明：** 60> 61> - isLoggable()和具体日志打印接口使用的domain和tag应保持一致。 62> 63> - isLoggable()使用的level，应和具体日志打印接口级别保持一致。 64> 65> - isLoggable()返回值：如果指定的domain、tag、level日志可以打印则返回true；否则返回false。 66> 67> [debug应用](https://developer.huawei.com/consumer/cn/doc/harmonyos-guides/ide-hvigor-compilation-options-customizing-guide#section192461528194916)：不做日志级别管控，所有级别日志都能够正常打印出来； 68> 69> [release应用](https://developer.huawei.com/consumer/cn/doc/harmonyos-guides/ide-hvigor-compilation-options-customizing-guide#section192461528194916)：按照全局日志级别管控，当日志的级别不低于全局日志级别时，才能正常打印出来； 70> 调试过程中，可手动修改日志级别，参考：[查看和设置日志级别](hilog.md#查看和设置日志级别)。 71 72 73## 约束与限制 74 75日志最多打印4096字节，超出限制文本将被截断。 76 77 78## 开发步骤 79 80在按钮中增加一个单击事件，单击按钮时打印一条日志。 81 821. 新建一个工程，选择“Empty Ability”。 83 842. 工程配置界面中，**Model**选择“Stage”。 85 863. 在**Project**窗口单击entry > src > main > ets > pages，打开工程中的Index.ets文件，添加一个按钮，单击按钮打印日志。 87 88 示例代码如下： 89 90 ```ts 91 // Index.ets 92 93 import { hilog } from '@kit.PerformanceAnalysisKit'; 94 95 @Entry 96 @Component 97 struct Index { 98 build() { 99 Row() { 100 Column() { 101 // 添加按钮，以响应用户点击 102 Button() { 103 Text('Next') 104 .fontSize(30) 105 .fontWeight(FontWeight.Bold) 106 } 107 .type(ButtonType.Capsule) 108 .margin({ 109 top: 20 110 }) 111 .backgroundColor('#0D9FFB') 112 .width('40%') 113 .height('5%') 114 // 跳转按钮绑定onClick事件，点击时打印日志 115 .onClick(() => { 116 hilog.isLoggable(0xFF00, "testTag", hilog.LogLevel.INFO); 117 hilog.info(0xFF00, "testTag", "%{public}s World %{public}d", "hello", 3); 118 class Person { 119 constructor(name: string, age: number) { 120 this.name = name; 121 this.age = age; 122 } 123 name: string; 124 age: number; 125 } 126 let peter: Person = new Person("peter", 15); 127 hilog.info(0xFF00, "testTag", "peter is %{public}o", peter); 128 // 设置应用日志最低打印级别，设置完成后，低于Warn级别的日志将无法打印 129 hilog.setMinLogLevel(hilog.LogLevel.WARN); 130 hilog.info(0x0000, 'testTag', 'this is an info level log'); 131 hilog.error(0x0000, 'testTag', 'this is an error level log'); 132 }) 133 } 134 .width('100%') 135 } 136 .height('100%') 137 } 138 } 139 ``` 140 141 以输出一条INFO级别的信息为例，表示输出一条普通信息，格式字符串为： 142 143 ```txt 144 '%{public}s World %{public}d' 145 ``` 146 147 其中变参"%{public}s"为公共的字符串，"%{public}d"为公共的整型数。 148 149 如果要输出对象，格式字符串为： 150 151 ```txt 152 'peter is %{public}o' 153 ``` 154 155 其中变参"%{public}o"为公共的对象 156 1574. 在真机上运行该工程，单击应用/服务界面上的“Next”按钮。 158 1595. 在DevEco Studio的底部，切换到“Log”窗口，设置日志的过滤条件。 160 161 选择当前的设备及进程，日志级别选择Verbose，搜索内容设置为“testTag”。此时窗口仅显示符合条件的日志。 162 163<!--RP3--> 164 打印日志结果为: 165 166 ```txt 167 01-02 08:18:24.947 30988-30988 A0ff00/testTag com.example.hilogDemo I hello World 3 168 01-02 08:18:24.947 30988-30988 A0ff00/testTag com.example.hilogDemo I peter is {"name":"peter","age":15} 169 01-02 08:18:24.947 30988-30988 A00000/testTag com.example.hilogDemo E this is an error level log 170 ``` 171<!--RP3End--> 172 173<!--RP1--> 174<!--RP1End--> 175