鸿蒙5.0版开发：使用HiLog打印日志（C/C++）

炫酷盖茨猫先生

于 2024-09-18 16:04:09 发布

阅读量975

点赞数 20

分类专栏：鸿蒙5.0开发 ArkTS组件文章标签： harmonyos 华为 android ArkTS 鸿蒙 c++ 前端

本文链接：https://blog.csdn.net/m0_73088370/article/details/142336145

版权

ArkTS组件同时被 2 个专栏收录

169 篇文章 0 订阅

订阅专栏

鸿蒙5.0开发

168 篇文章 0 订阅

订阅专栏

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

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

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类型。	123
s	支持打印string、undefined和null类型。	"123"

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

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

约束与限制

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

开发步骤

在CMakeLists.txt中新增libhilog_ndk.z.so链接：

target_link_libraries(entry PUBLIC libhilog_ndk.z.so)

在源文件中包含hilog头文件, 并定义domain、tag宏：

#include "hilog/log.h"

#undef LOG_DOMAIN
#undef LOG_TAG
#define LOG_DOMAIN 0x3200  // 全局domain宏，标识业务领域
#define LOG_TAG "MY_TAG"   // 全局tag宏，标识模块日志tag

打印日志，以打印ERROR级别的日志为例：

OH_LOG_ERROR(LOG_APP, "Failed to visit %{private}s, reason:%{public}d.", url, errno);

输出结果：

12-11 12:21:47.579  2695 2695 E A03200/MY_TAG: Failed to visit <private>, reason:11.

日志回调接口使用示例

#include "hilog/log.h"
static constexpr OHOS::HiviewDFX::HiLogLabel LABEL = {LOG_CORE, 0xD003200, "MY_TAG"};

// 回调函数，开发者自定义的日志处理函数
void MyHiLog(const LogType type, const LogLevel level, const unsigned int domain, const char *tag, const char *msg)
{
    // user-defined to handle your log, such as redirect/filter
}

static void Test(void)
{
   // 1.注册回调接口
    OH_LOG_SetCallback(MyHiLog);
    
   // 2.调用hilog接口打印日志，日志内容会输出到hilog，同时通过回调返回给MyHiLog，开发者可以在MyHiLog中自行处理日志
   HiLog::Info(LABEL, "hello world");
}