1# 使用HiLog打印日志（C/C++） 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 12HiLog日志系统，提供给系统框架、服务、以及应用，用于打印日志，记录用户操作、系统运行状态等。 13 14## 接口说明 15 16HiLog中定义了DEBUG、INFO、WARN、ERROR、FATAL五种日志级别，并提供了对应的方法输出不同级别的日志，接口如下表所示，具体说明可查阅[API参考文档](../reference/apis-performance-analysis-kit/capi-log-h.md)。 17 18| 方法/宏 | 接口描述 | 19| -------- | -------- | 20| bool OH_LOG_IsLoggable(unsigned int domain, const char \*tag, LogLevel level) | 检查指定domain、tag和日志级别的日志是否可以打印。<br/>如果指定日志可以打印则返回true；否则返回false。 | 21| int OH_LOG_Print(LogType type, LogLevel level, unsigned int domain, const char \*tag, const char \*fmt, ...) | 输出指定domain、tag和日志级别的日志，并按照printf格式类型和隐私指示确定需要输出的变参。<br/>返回值大于等于0表示成功，小于0表示失败。 | 22| int OH_LOG_PrintMsg(LogType type, LogLevel level, unsigned int domain, const char \*tag, const char \*message) | 输出指定domain、tag和日志级别的日志字符串。<br/>返回值大于等于0表示成功，小于0表示失败。<br/>**说明**：从API version 18开始，支持该接口。 | 23| int OH_LOG_PrintMsgByLen(LogType type, LogLevel level, unsigned int domain, const char \*tag, size_t tagLen, const char \*message, size_t messageLen) | 输出指定domain、tag和日志级别的日志字符串，需要指定tag及字符串长度。<br/>返回值大于等于0表示成功，小于0表示失败。<br/>**说明**：从API version 18开始，支持该接口。 | 24| int OH_LOG_VPrint(LogType type, LogLevel level, unsigned int domain, const char \*tag, const char \*fmt, va_list ap) | 等效于OH_LOG_Print，但是参数列表为va_list。<br/>**说明**：从API version 18开始，支持该接口。 | 25| \#define OH_LOG_DEBUG(type, ...) ((void)OH_LOG_Print((type), LOG_DEBUG, LOG_DOMAIN, LOG_TAG, **VA_ARGS**)) | DEBUG级别写日志，宏封装接口。 | 26| \#define OH_LOG_INFO(type, ...) ((void)OH_LOG_Print((type), LOG_INFO, LOG_DOMAIN, LOG_TAG, **VA_ARGS**)) | INFO级别写日志，宏封装接口。 | 27| \#define OH_LOG_WARN(type, ...) ((void)OH_LOG_Print((type), LOG_WARN, LOG_DOMAIN, LOG_TAG, **VA_ARGS**)) | WARN级别写日志，宏封装接口。 | 28| \#define OH_LOG_ERROR(type, ...) ((void)OH_LOG_Print((type), LOG_ERROR, LOG_DOMAIN, LOG_TAG, **VA_ARGS**)) | ERROR级别写日志，宏封装接口。 | 29| \#define OH_LOG_FATAL(type, ...) ((void)OH_LOG_Print((type), LOG_FATAL, LOG_DOMAIN, LOG_TAG, **VA_ARGS**)) | FATAL级别写日志，宏封装接口。 | 30| void OH_LOG_SetCallback(LogCallback callback) | 注册函数，注册后可通过LogCallback回调获取本进程的hilog日志。若OH_LOG_IsLoggable接口返回true，则回调函数可获取到该条日志。 | 31| void OH_LOG_SetMinLogLevel(LogLevel level) | 设置应用日志打印的最低日志级别，用于拦截低级别日志打印。<br/>**说明**：从API version 15开始，支持该接口。<br/>**注意**：如果设置的日志级别低于[全局日志级别](hilog.md#查看和设置日志级别)，设置不生效。 | 32 33### 参数解析 34 35- domain：用于指定输出日志所对应的业务领域，取值范围为0x0000~0xFFFF，开发者可以根据需要进行自定义。 36 37- tag：用于指定日志标识，可以为任意字符串，建议标识调用所在的类或者业务行为。tag最多为31字节，超出后会截断。不建议使用中文字符，可能出现乱码或者对齐问题。 38 39- level：用于指定日志级别。取值见[LogLevel](../reference/apis-performance-analysis-kit/capi-log-h.md#loglevel)。 40 41- fmt：格式字符串，用于日志的格式化输出。日志打印的格式化参数需按照“%{private flag}specifier”的格式打印。 42 43 | 隐私标识符（private flag） | 说明 | 44 | -------- | -------- | 45 | private | 表示日志打印结果不可见，输出结果为<private>。 | 46 | public | 表示日志打印结果可见，明文显示参数。 | 47 | 无 | 缺省值默认为private，日志打印结果不可见。 | 48 49 | 格式说明符（specifier） | 说明 | 示例 | 50 | -------- | -------- | -------- | 51 | d/i | 支持打印number、bool类型。 | 123 | 52 | s | 支持打印char\*类型。 | "123" | 53 54 格式字符串中可以设置多个参数，例如格式字符串为“%s World”，“%s”为参数类型为字符串的变参标识，具体取值在args中定义。 55 56 debug应用无隐私管控机制，使用上述任意隐私标识符打印日志，都可明文显示参数。 57 58- args：可以为0个或多个参数，是格式字符串中参数类型对应的参数列表。参数的数量、类型必须与格式字符串中的标识一一对应。 59 60> **说明：** 61> 62> - OH_LOG_IsLoggable()和OH_LOG_Print()使用的domain、tag和level应保持一致。 63> 64> - OH_LOG_IsLoggable()返回值：如果指定的domain、tag、level日志可以打印则返回true；否则返回false。 65> debug应用：不做日志级别管控，所有级别日志都能够正常打印出来； 66> 67> release应用：按照全局日志级别管控，当日志的级别不低于全局日志级别时，才能正常打印出来； 68> 69> 调试过程中，可手动修改日志级别，参考：[查看和设置日志级别](hilog.md#查看和设置日志级别)。 70 71## 约束与限制 72 73日志最多打印4096字节，超出限制文本将被截断。 74 75## 开发步骤 76 771. 在CMakeLists.txt中新增libhilog_ndk.z.so链接： 78 79 ```txt 80 target_link_libraries(entry PUBLIC libhilog_ndk.z.so) 81 ``` 82 832. 在源文件中包含hilog头文件，并定义domain、tag宏： 84 85 ```c++ 86 #include "hilog/log.h" 87 ``` 88 89 ```c++ 90 #undef LOG_DOMAIN 91 #undef LOG_TAG 92 #define LOG_DOMAIN 0x3200 // 全局domain宏，标识业务领域 93 #define LOG_TAG "MY_TAG" // 全局tag宏，标识模块日志tag 94 ``` 95 963. 打印日志： 97 98 ```c++ 99 OH_LOG_INFO(LOG_APP, "Failed to visit %{private}s, reason:%{public}d.", url, errno); 100 // 设置应用日志最低打印级别，设置完成后，低于Warn级别的日志将无法打印 101 OH_LOG_SetMinLogLevel(LOG_WARN); 102 OH_LOG_INFO(LOG_APP, "this is an info level log"); 103 OH_LOG_ERROR(LOG_APP, "this is an error level log"); 104 ``` 105 1064. 输出结果： 107 108<!--RP2--> 109 ```txt 110 01-02 08:39:38.915 9012-9012 A03200/MY_TAG com.example.hilogDemo I Failed to visit <private>, reason:11. 111 01-02 08:39:38.915 9012-9012 A03200/MY_TAG com.example.hilogDemo E this is an error level log 112 ``` 113<!--RP2End--> 114 115### 日志回调接口使用示例 116 117> **注意：** 118> 119> 1.在回调函数中禁止递归调用hilog接口，否则会导致循环调用问题。 120> 121> 2.一个进程只需注册一次回调函数，若多次注册，以最后一次注册的回调函数为准。 122 123```c++ 124#include "hilog/log.h" 125 126// 回调函数，开发者自定义的日志处理函数 127void MyHiLog(const LogType type, const LogLevel level, const unsigned int domain, const char *tag, const char *msg) 128{ 129 // user-defined to handle your log, such as redirect/filter 130 // 注意: 在回调函数中禁止递归调用hilog接口，否则会导致循环调用问题。 131} 132 133static void Test(void) 134{ 135 // 1.注册回调接口 136 OH_LOG_SetCallback(MyHiLog); 137 138 // 2.调用hilog接口打印日志，日志内容会输出到hilog，同时通过回调返回给MyHiLog，开发者可以在MyHiLog中自行处理日志 139 OH_LOG_INFO(LOG_APP, "hello world"); 140} 141``` 142