1# 使用HiLog打印日志（ArkTS） 2 3 4在应用开发过程中，可在关键代码处输出日志信息。在运行应用后，通过查看日志信息来分析应用执行情况（如应用是否正常运行、代码运行时序、运行逻辑分支是否正常等）。 5 6 7系统提供不同的API供开发者调用并输出日志信息，即HiLog与console。两个API在使用时略有差异，本文重点介绍HiLog的用法，console的具体用法可查看API参考[console](../reference/common/js-apis-logs.md)。 8 9 10## 接口说明 11 12HiLog中定义了DEBUG、INFO、WARN、ERROR、FATAL五种日志级别，并提供了对应的方法输出不同级别的日志，接口如下表所示，具体说明可查阅[API参考文档](../reference/apis-performance-analysis-kit/js-apis-hilog.md)。 13 14| 接口名 | 功能描述 | 15| -------- | -------- | 16| isLoggable(domain: number, tag: string, level: LogLevel) | 在打印日志前调用该接口，检查指定领域标识、日志标识和级别的日志是否可以打印。 | 17| debug(domain: number, tag: string, format: string, ...args: any[]) | 输出DEBUG级别日志。仅用于应用/服务调试。<br/>在DevEco Studio的terminal窗口或cmd里，通过命令“hdc shell hilog -b D”设置可打印日志的等级为DEBUG。 | 18| info(domain: number, tag: string, format: string, ...args: any[]) | 输出INFO级别日志。表示普通的信息。 | 19| warn(domain: number, tag: string, format: string, ...args: any[]) | 输出WARN级别日志。表示存在警告。 | 20| error(domain: number, tag: string, format: string, ...args: any[]) | 输出ERROR级别日志。表示存在错误。 | 21| fatal(domain: number, tag: string, format: string, ...args: any[]) | 输出FATAL级别日志。表示出现致命错误、不可恢复错误。 | 22| setMinLogLevel(level: LogLevel) | 设置应用日志打印的最低日志级别，进程在打印日志时，需要同时校验该日志级别和全局日志级别，所以设置的日志级别不能低于全局日志级别，[全局日志级别](hilog.md#查看和设置日志级别)默认为Info。| 23 24### 参数解析 25 26> **说明：** 27> 28> - isLoggable()和具体日志打印接口使用的domain和tag应保持一致。 29> 30> - isLoggable()使用的level，应和具体日志打印接口级别保持一致。 31 32- **domain**：用于指定输出日志所对应的业务领域，取值范围为0x0000~0xFFFF，开发者可以根据需要进行自定义。 33 34- **tag**：用于指定日志标识，可以为任意字符串，建议标识调用所在的类或者业务行为。tag最多为31字节，超出后会截断，不建议使用中文字符，可能出现乱码或者对齐问题。 35 36- **level**：用于指定日志级别。取值见[LogLevel](../reference/apis-performance-analysis-kit/js-apis-hilog.md#loglevel)。 37 38- **format**：格式字符串，用于日志的格式化输出。日志打印的格式化参数需按照“%{private flag}specifier”的格式打印。 39 | 隐私标识符（private flag） | 说明 | 40 | -------- | -------- | 41 | private | 表示日志打印结果不可见，输出结果为<private>。 | 42 | public | 表示日志打印结果可见，明文显示参数。 | 43 | 无 | 缺省值默认为private，日志打印结果不可见。 | 44 45 | 格式说明符（specifier） | 说明 | 示例 | 46 | -------- | -------- | -------- | 47 | d/i | 支持打印number和bigint类型。 | 123 | 48 | s | 支持打印string、undefined、boolean和null类型。 | "123" | 49 50 格式字符串中可以设置多个参数，例如格式字符串为“%s World”，“%s”为参数类型为string的变参标识，具体取值在args中定义。<!--Del--> 51 52 调试时可通过命令“hilog -p off”指令，关闭隐私开关，明文显示private日志内容。 53<!--DelEnd--> 54 55- **args**：可以为0个或多个参数，是格式字符串中参数类型对应的参数列表。参数的数量、类型必须与格式字符串中的标识一一对应。 56 57## 约束与限制 58 59日志最多打印4096字节，超出限制文本将被截断。 60 61## 开发示例 62 63在按钮中增加一个单击事件，单击按钮时打印一条日志。 64 651. 新建一个工程，选择“Empty Ability”。 66 672. 工程配置界面中，**Model**选择“Stage”。 68 693. 在**Project**窗口单击entry > src > main > ets > pages，打开工程中的Index.ets文件，添加一个按钮，单击按钮打印日志。 70 示例代码如下： 71 72 ```ts 73 // Index.ets 74 75 import { hilog } from '@kit.PerformanceAnalysisKit'; 76 77 @Entry 78 @Component 79 struct Index { 80 build() { 81 Row() { 82 Column() { 83 // 添加按钮，以响应用户点击 84 Button() { 85 Text('Next') 86 .fontSize(30) 87 .fontWeight(FontWeight.Bold) 88 } 89 .type(ButtonType.Capsule) 90 .margin({ 91 top: 20 92 }) 93 .backgroundColor('#0D9FFB') 94 .width('40%') 95 .height('5%') 96 // 跳转按钮绑定onClick事件，点击时打印日志 97 .onClick(() => { 98 hilog.isLoggable(0xFF00, "testTag", hilog.LogLevel.INFO); 99 hilog.info(0xFF00, "testTag", "%{public}s World %{public}d", "hello", 3); 100 // 设置应用日志最低打印级别，设置完成后，低于Warn级别的日志将无法打印 101 hilog.setMinLogLevel(hilog.LogLevel.WARN); 102 hilog.info(0x0000, 'testTag', 'this is an info level log'); 103 hilog.error(0x0000, 'testTag', 'this is an error level log'); 104 }) 105 } 106 .width('100%') 107 } 108 .height('100%') 109 } 110 } 111 ``` 112 113 以输出一条INFO级别的信息为例，表示输出一条普通信息，格式字符串为： 114 115 ```txt 116 '%{public}s World %{public}d' 117 ``` 118 其中变参"%{public}s"为公共的字符串，"%{public}d"为公共的整型数。 119 1204. 在真机上运行该工程，单击应用/服务界面上的“Next”按钮。 121 1225. 在DevEco Studio的底部，切换到“Log”窗口，设置日志的过滤条件。 123 选择当前的设备及进程，日志级别选择Verbose，搜索内容设置为“testTag”。此时窗口仅显示符合条件的日志。 124 125 打印日志结果为: 126 ```txt 127 01-02 08:18:24.947 30988-30988 A0ff00/testTag com.example.hilogemo I hello World 3 128 01-02 08:18:24.947 30988-30988 A00000/testTag com.example.hilogemo E this is an error level log 129 ``` 130 131<!--RP1--> 132<!--RP1End-->