• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# log.h
2
3
4## 概述
5
6HiLog模块日志接口定义，通过这些接口实现日志打印相关功能。
7
8用户输出日志时，先定义日志所属业务领域、日志TAG，然后按照类型、级别选择对应API，指定参数隐私标识输出日志内容。
9
10业务领域：指定日志所对应的业务领域，用户自定义使用，用于标识业务的子系统、模块。16进制整数，范围0x0~0xFFFF。
11
12日志TAG：字符串常量，用于标识调用所在的类或者业务。
13
14日志级别：DEBUG、INFO、WARN、ERROR、FATAL。
15
16参数格式：类printf的方式，包括格式字符串（包括参数类型标识）和变参。
17
18隐私参数标识：在格式字符串每个参数中符号后类型前增加{public}、{private}标识。
19
20注意：每个参数未指定隐私标识时，缺省为隐私。
21
22使用示例：
23
24定义业务领域、TAG：
25
26
27```
28#define LOG_DOMAIN 0x0201
29#define LOG_TAG "MY_TAG"
30```
31
32日志打印：
33
34
35```
36HILOG_WARN(LOG_APP, "Failed to visit %{private}s, reason:%{public}d.", url, errno);
37```
38
39结果输出：
40
41
42```
4305-06 15:01:06.870 1051 1051 W 0201/MY_TAG: Failed to visit <private>, reason:503.
44```
45
46**起始版本：**
47
488
49
50**相关模块：**
51
52[HiLog](_hi_log.md)
53
54
55## 汇总
56
57
58### 宏定义
59
60| 宏定义名称 | 描述 |
61| -------- | -------- |
62| [LOG_DOMAIN](_hi_log.md#log_domain)   0 | 日志所对应的业务领域，用于标识业务的子系统、模块。 |
63| [LOG_TAG](_hi_log.md#log_tag)   NULL | 字符串常量，标识调用所在的类或者业务。 |
64| [OH_LOG_DEBUG](_hi_log.md#oh_log_debug)(type, ...)   ((void)[OH_LOG_Print](_hi_log.md#oh_log_print)((type), LOG_DEBUG, LOG_DOMAIN, LOG_TAG, \_\_VA\_ARGS\_\_)) | DEBUG级别写日志，宏封装接口。 |
65| [OH_LOG_INFO](_hi_log.md#oh_log_info)(type, ...)   ((void)[OH_LOG_Print](_hi_log.md#oh_log_print)((type), LOG_INFO, LOG_DOMAIN, LOG_TAG, \_\_VA\_ARGS\_\_)) | INFO级别写日志，宏封装接口。 |
66| [OH_LOG_WARN](_hi_log.md#oh_log_warn)(type, ...)   ((void)[OH_LOG_Print](_hi_log.md#oh_log_print)((type), LOG_WARN, LOG_DOMAIN, LOG_TAG, \_\_VA\_ARGS\_\_)) | WARN级别写日志，宏封装接口。 |
67| [OH_LOG_ERROR](_hi_log.md#oh_log_error)(type, ...)   ((void)[OH_LOG_Print](_hi_log.md#oh_log_print)((type), LOG_ERROR, LOG_DOMAIN, LOG_TAG, \_\_VA\_ARGS\_\_)) | ERROR级别写日志，宏封装接口。 |
68| [OH_LOG_FATAL](_hi_log.md#oh_log_fatal)(type, ...)   ((void)HiLogPrint((type), LOG_FATAL, LOG_DOMAIN, LOG_TAG, \_\_VA\_ARGS\_\_s)) | FATAL级别写日志，宏封装接口。 |
69
70
71### 枚举
72
73| 枚举名称 | 描述 |
74| -------- | -------- |
75| [LogType](_hi_log.md#logtype) { LOG_APP= 0 } | 日志类型。 |
76| [LogLevel](_hi_log.md#loglevel) { LOG_DEBUG = 3, LOG_INFO = 4, LOG_WARN = 5, LOG_ERROR = 6, LOG_FATAL =7 } | 日志级别。 |
77
78
79### 函数
80
81| 函数名称 | 描述 |
82| -------- | -------- |
83| [OH_LOG_Print](_hi_log.md#oh_log_print) ([LogType](_hi_log.md#logtype) type, [LogLevel](_hi_log.md#loglevel) level, unsigned int domain, const char \*tag, const char \*fmt,...) __attribute__((__format__(os_log | 写日志接口。 |
84| [OH_LOG_IsLoggable](_hi_log.md#oh_log_isloggable) (unsigned int domain, const char \*tag, [LogLevel](_hi_log.md#loglevel) level) | 检查指定业务领域、TAG、级别的日志是否可以打印。 |
85