使用HiLog打印日志（ArkTS）

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

系统提供不同的API供开发者调用并输出日志信息，即HiLog与console。两个API在使用时略有差异，本文重点介绍HiLog的用法，console的具体用法可查看API参考console。

接口说明

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

说明：

全局日志级别，默认为info, 可参考查看和设置日志级别

参数解析

• domain：用于指定输出日志所对应的业务领域，取值范围为0x0000~0xFFFF，开发者可以根据需要进行自定义。

• tag：用于指定日志标识，可以为任意字符串，建议标识调用所在的类或者业务行为。tag最多为31字节，超出后会截断，不建议使用中文字符，可能出现乱码或者对齐问题。

• level：用于指定日志级别。取值见LogLevel。

• format：格式字符串，用于日志的格式化输出。日志打印的格式化参数需按照“%{private flag}specifier”的格式打印。 |隐私标识符（private flag）|说明| |——–|——–| |private|表示日志打印结果不可见，输出结果为<private>。| |public|表示日志打印结果可见，明文显示参数。| |无|缺省值默认为private，日志打印结果不可见。|

格式字符串中可以设置多个参数，例如格式字符串为“%s World”，“%s”为参数类型为string的变参标识，具体取值在args中定义。

调试时可通过命令“hilog -p off”指令，关闭隐私开关，明文显示private日志内容。

• args：可以为0个或多个参数，是格式字符串中参数类型对应的参数列表。参数的数量、类型必须与格式字符串中的标识一一对应。

说明：

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

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

• isLoggable()返回值：如果指定的domain、tag、level日志可以打印则返回true；否则返回false。

debug应用：不做日志级别管控，所有级别日志都能够正常打印出来；

release应用：按照全局日志级别管控，当日志的级别不低于全局日志级别时，才能正常打印出来；

调试过程中，可手动修改日志级别，参考：查看和设置日志级别。

约束与限制

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

开发示例

在按钮中增加一个单击事件，单击按钮时打印一条日志。

1. 新建一个工程，选择“Empty Ability”。

2. 工程配置界面中，Model选择“Stage”。

3. 在Project窗口单击entry > src > main > ets > pages，打开工程中的Index.ets文件，添加一个按钮，单击按钮打印日志。 示例代码如下：

   // Index.ets
   
   import { hilog } from '@kit.PerformanceAnalysisKit';
   
   @Entry
   @Component
   struct Index {
     build() {
       Row() {
         Column() {
           // 添加按钮，以响应用户点击
           Button() {
             Text('Next')
               .fontSize(30)
               .fontWeight(FontWeight.Bold)
           }
           .type(ButtonType.Capsule)
           .margin({
             top: 20
           })
           .backgroundColor('#0D9FFB')
           .width('40%')
           .height('5%')
           // 跳转按钮绑定onClick事件，点击时打印日志
           .onClick(() => {
             hilog.isLoggable(0xFF00, "testTag", hilog.LogLevel.INFO);
             hilog.info(0xFF00, "testTag", "%{public}s World %{public}d", "hello", 3);
             class Person {
                constructor(name: string, age: number) {
                  this.name = name;
                  this.age = age;
                }
                name: string;
                age:  number;
             }
             let peter: Person = new Person("peter", 15);
             hilog.info(0xFF00, "testTag", "peter is %{public}o", peter);
             // 设置应用日志最低打印级别，设置完成后，低于Warn级别的日志将无法打印
             hilog.setMinLogLevel(hilog.LogLevel.WARN);
             hilog.info(0x0000, 'testTag', 'this is an info level log');
             hilog.error(0x0000, 'testTag', 'this is an error level log');
           })
         }
         .width('100%')
       }
       .height('100%')
     }
   }

以输出一条INFO级别的信息为例，表示输出一条普通信息，格式字符串为：

   '%{public}s World %{public}d'

其中变参”%{public}s”为公共的字符串，”%{public}d”为公共的整型数。

如果要输出对象，格式字符串为：

   'peter is %{public}o'

其中变参”%{public}o”为公共的对象

1. 在真机上运行该工程，单击应用/服务界面上的“Next”按钮。

2. 在DevEco Studio的底部，切换到“Log”窗口，设置日志的过滤条件。 选择当前的设备及进程，日志级别选择Verbose，搜索内容设置为“testTag”。此时窗口仅显示符合条件的日志。

打印日志结果为:

   01-02 08:18:24.947   30988-30988   A0ff00/testTag                  com.example.hilogemo  I     hello World 3
   01-02 08:18:24.947   30988-30988   A0ff00/testTag                  com.example.hilogemo  I     peter is {"name":"peter","age":15}
   01-02 08:18:24.947   30988-30988   A00000/testTag                  com.example.hilogemo  E     this is an error level log

你可能感兴趣的鸿蒙文章

harmony 鸿蒙Performance Analysis Kit（性能分析服务）

harmony 鸿蒙分析AppFreeze（应用无响应）

harmony 鸿蒙应用恢复开发指导

harmony 鸿蒙分析CppCrash（进程崩溃）

harmony 鸿蒙错误管理开发指导

harmony 鸿蒙hdc

harmony 鸿蒙事件上报

harmony 鸿蒙HiAppEvent介绍

harmony 鸿蒙订阅踩内存事件（ArkTS）

harmony 鸿蒙订阅踩内存事件（C/C++）