1# HiLog开发指导 2 3 4## 概述 5 6HiLog是OpenHarmony日志系统，提供给系统框架、服务、以及应用打印日志，记录用户操作、系统运行状态等。 7 8本章节内容对标准系统类设备（参考内存≥128MiB）适用。 9 10 11## 接口说明 12 13 **表1** C++、C的函数接口 14 15| C++ | | C | 16| -------- | -------- | -------- | 17| 类 | 方法 | 方法/宏 | 18| HiLog | int Debug(const HiLogLabel &label, const char \*fmt, ...) | HILOG_DEBUG(type, ...) | 19| | int Info(const HiLogLabel &label, const char \*fmt, ...) | HILOG_INFO(type, ...) | 20| | int Warn(const HiLogLabel &label, const char \*fmt, ...) | HILOG_WARN(type, ...) | 21| | int Error(const HiLogLabel &label, const char \*fmt, ...) | HILOG_ERROR(type, ...) | 22| | int Fatal(const HiLogLabel &label, const char \*fmt, ...) | HILOG_FATAL(type, ...) | 23| | NA | int HiLogPrint(LogType type, LogLevel level, unsigned int domain, const char \*tag, const char \*fmt, ...) | 24| | boolean IsLoggable(unsigned int domain, const char \*tag, LogLevel level) | bool HiLogIsLoggable(unsigned int domain, const char \*tag, LogLevel level) | 25| HiLogLabel | struct HiLogLabel | LOG_DOMAIN<br/>LOG_TAG | 26 27 **表2** C++接口说明函数参数和功能 28 29| 类 | 方法 | 描述 | 30| -------- | -------- | -------- | 31| HiLog | int Debug(const HiLogLabel &label, const char \*fmt, ...) | 功能：输出 debug 级别日志。<br/>输入参数：<br/>- label：用于标识输出日志的类型、业务领域、TAG。<br/>- format：常量格式字符串，包含参数类型、隐私标识。未加隐私标识的缺省为隐私参数。<br/>- fmt：格式化变参描述字符串。<br/>输出参数：无<br/>返回值：大于等于0，成功；小于0，失败。 | 32| | int Info(const HiLogLabel &label, const char \*fmt, ...) | 功能：输出 info 级别日志。<br/>参数说明同 Debug 接口。 | 33| | int Warn(const HiLogLabel &label, const char \*fmt, ...) | 功能：输出 warn 级别日志。<br/>参数说明同 Debug 接口。 | 34| | int Error(const HiLogLabel &label, const char \*fmt, ...) | 功能：输出 error 级别日志。<br/>参数说明同 Debug 接口。 | 35| | int Fatal(const HiLogLabel &label, const char \*fmt, ...) | 功能：输出 fatal 级别日志。<br/>参数说明同 Debug 接口。 | 36| | boolean IsLoggable(unsigned int domain, const char \*tag, LogLevel level) | 功能：检查指定业务领域、TAG、级别的日志是否可以打印。<br/>输入参数：<br/>- domain：指定日志业务领域。<br/>- tag: 指定日志TAG。<br/>- level: 指定日志level。<br/>输出参数：无<br/>返回值：如果指定domain、tag、level日志可以打印则返回true；否则返回false。 | 37| HiLogLabel | struct HiLogLabel | 功能：初始化日志标签参数。<br/>成员参数：<br/>- type: 指定日志type。<br/>- domain：指定日志业务领域。<br/>- tag: 指定日志TAG。 | 38 39 40## 开发实例 41 42 43### C使用示例 44 451. 在.c源文件中，包含hilog头文件： 46 47 ``` 48 #include "hilog/log.h" 49 ``` 50 51 定义domain、tag： 52 53 ``` 54 #undef LOG_DOMAIN 55 #undef LOG_TAG 56 #define LOG_DOMAIN 0xD003200 // 标识业务领域，范围0xD000000~0xD0FFFFF 57 #define LOG_TAG "MY_TAG" 58 ``` 59 60 打印日志： 61 62 ``` 63 HILOG_INFO(LOG_CORE, "Failed to visit %{private}s, reason:%{public}d.", url, errno); 64 ``` 65 662. 编译设置，在BUILD.gn里增加子系统SDK依赖： 67 68 ``` 69 external_deps = [ "hilog_native:libhilog" ] 70 ``` 71 72 73### C++使用示例 74 751. 在.h类定义头文件中，包含hilog头文件： 76 77 ``` 78 #include "hilog/log.h" 79 ``` 80 81 如果类头文件中需要日志打印，在头文件中类定义起始处 定义 LABEL： 82 83 ``` 84 class MyClass { 85 static constexpr OHOS::HiviewDFX::HiLogLabel LABEL = {LOG_CORE, 0xD003200, "MY_TAG"}; 86 ...... 87 } 88 ``` 89 90 如果类头文件中没有日志打印，在类实现文件中 定义 LABEL： 91 92 ``` 93 using namespace OHOS::HiviewDFX; 94 static constexpr HiLogLabel LABEL = {LOG_CORE, 0xD003200, "MY_TAG"}; 95 ``` 96 97 打印日志： 98 99 ``` 100 HiLog::Info(LABEL, "Failed to visit %{private}s, reason:%{public}d.", url, errno); 101 ``` 102 1032. 编译设置，在BUILD.gn里增加子系统SDK依赖： 104 105 ``` 106 external_deps = [ "hiviewdfx:libhilog" ] 107 ``` 108