鸿蒙5.0版开辟：利用HiLog打印日记（C/C++）

 往期鸿蒙全套实战文章必看：

• 鸿蒙开辟核心知识点，看这篇文章就够了
  
• 最新版！鸿蒙HarmonyOS Next应用开辟实战学习蹊径
  
• 鸿蒙HarmonyOS NEXT开辟技能最全学习蹊径指南
  
• 鸿蒙应用开辟实战项目，看这一篇文章就够了（部门项目附源码）
  

---

在应用开辟过程中，可在关键代码处输出日记信息。在运行应用后，通过查察日记信息来分析应用执行情况（如应用是否正常运行、代码运行时序、运行逻辑分支是否正常等）。
HiLog日记系统，提供给系统框架、服务、以及应用，用于打印日记，记录用户操纵、系统运行状态等。
接口分析

HiLog中界说了DEBUG、INFO、WARN、ERROR、FATAL五种日记级别，并提供了对应的方法输出不同级别的日记，接口如下表所示。
方法/宏接口形貌bool OH_LOG_IsLoggable(unsigned int domain, const char *tag, LogLevel level) 查抄指定domain、tag和日记级别的日记是否可以打印。
如果指定日记可以打印则返回true；否则返回false。
int OH_LOG_Print(LogType type, LogLevel level, unsigned int domain, const char *tag, const char *fmt, ...) 输出指定domain、tag和日记级别的日记，并按照printf格式类型和隐私指示确定需要输出的变参。
打印成功则返回日记总字节数；失败则返回-1。
#define OH_LOG_DEBUG(type, ...) ((void)OH_LOG_Print((type), LOG_DEBUG, LOG_DOMAIN, LOG_TAG, __VA_ARGS__))DEBUG级别写日记，宏封装接口。#define OH_LOG_INFO(type, ...) ((void)OH_LOG_Print((type), LOG_INFO, LOG_DOMAIN, LOG_TAG, __VA_ARGS__))INFO级别写日记，宏封装接口。#define OH_LOG_WARN(type, ...) ((void)OH_LOG_Print((type), LOG_WARN, LOG_DOMAIN, LOG_TAG, __VA_ARGS__))WARN级别写日记，宏封装接口。#define OH_LOG_ERROR(type, ...) ((void)OH_LOG_Print((type), LOG_ERROR, LOG_DOMAIN, LOG_TAG, __VA_ARGS__))ERROR级别写日记，宏封装接口。#define OH_LOG_FATAL(type, ...) ((void)OH_LOG_Print((type), LOG_FATAL, LOG_DOMAIN, LOG_TAG, __VA_ARGS__))FATAL级别写日记，宏封装接口。void OH_LOG_SetCallback(LogCallback callback)注册函数，注册后可通过LogCallback回调获取本进程所有的hilog日记。 参数剖析

分析
   OH_LOG_IsLoggable()和OH_LOG_Print()利用的domain、tag和level应保持一致。
  

• domain：用于指定输出日记所对应的业务领域，取值范围为0x0000~0xFFFF，开辟者可以根据需要举行自界说。
  
• tag：用于指定日记标识，可以为任意字符串，建议标识调用地点的类大概业务举动。
  
• level：用于指定日记级别。
  
• fmt：格式字符串，用于日记的格式化输出。日记打印的格式化参数需按照“%{private flag}specifier”的格式打印。
     隐私标识符（private flag）分析private表示日记打印效果不可见，输出效果为<private>。public表示日记打印效果可见，明文显示参数。无缺省值默以为private，日记打印效果不可见。   格式分析符（specifier）分析示例d/i支持打印number、bool和bigint类型。123s支持打印string、undefined和null类型。"123"格式字符串中可以设置多个参数，例如格式字符串为“%s World”，“%s”为参数类型为string的变参标识，详细取值在args中界说。
  
• args：可以为0个或多个参数，是格式字符串中参数类型对应的参数列表。参数的数量、类型必须与格式字符串中的标识逐一对应。
  

约束与限制

日记打印最多打印4096字节，超出限制文本将被截断。
开辟步调

• 在CMakeLists.txt中新增libhilog_ndk.z.so链接：
  
  1. target_link_libraries(entry PUBLIC libhilog_ndk.z.so)

  复制代码
• 在源文件中包含hilog头文件, 并界说domain、tag宏：
  
  1. #include "hilog/log.h"

  复制代码
  1. #undef LOG_DOMAIN
  2. #undef LOG_TAG
  3. #define LOG_DOMAIN 0x3200  // 全局domain宏，标识业务领域
  4. #define LOG_TAG "MY_TAG"   // 全局tag宏，标识模块日志tag

  复制代码
• 打印日记，以打印ERROR级别的日记为例：
  
  1. OH_LOG_ERROR(LOG_APP, "Failed to visit %{private}s, reason:%{public}d.", url, errno);

  复制代码
• 输出效果：
  
  1. 12-11 12:21:47.579  2695 2695 E A03200/MY_TAG: Failed to visit <private>, reason:11.

  复制代码

日记回调接口利用示例

1. #include "hilog/log.h"
2. static constexpr OHOS::HiviewDFX::HiLogLabel LABEL = {LOG_CORE, 0xD003200, "MY_TAG"};
4. // 回调函数，开发者自定义的日志处理函数
5. void MyHiLog(const LogType type, const LogLevel level, const unsigned int domain, const char *tag, const char *msg)
6. {
7.     // user-defined to handle your log, such as redirect/filter
8. }
10. static void Test(void)
11. {
12.    // 1.注册回调接口
13.     OH_LOG_SetCallback(MyHiLog);
14.    
15.    // 2.调用hilog接口打印日志，日志内容会输出到hilog，同时通过回调返回给MyHiLog，开发者可以在MyHiLog中自行处理日志
16.    HiLog::Info(LABEL, "hello world");
17. }

复制代码

看完三件事❤️

• 如果你觉得这篇内容对你还蛮有帮助，我想邀请你帮我三个小忙：
  
• 点赞，转发，有你们的 『点赞和评论』，才是我创造的动力。
  
• 关注作者，不定期分享原创知识。
  
• 同时可以等待后续文章ing