1# HiLog 2 3 4HiLog模块实现日志打印功能。 5 6 7开发者可以通过使用这些接口实现日志相关功能，输出日志时可以指定日志类型、所属业务领域、日志TAG标识、日志级别等。 8 9 10@syscap SystemCapability.HiviewDFX.HiLog 11 12 13**起始版本：** 14 15 168 17 18 19## 汇总 20 21 22### 文件 23 24| 文件名称 | 描述 | 25| -------- | -------- | 26| [log.h](log_8h.md) | HiLog模块日志接口定义，通过这些接口实现日志打印相关功能。<br>引用文件：<hilog/log.h> | 27 28 29### 宏定义 30 31| 宏定义名称 | 描述 | 32| -------- | -------- | 33| [LOG_DOMAIN](#log_domain) 0 | 日志所对应的业务领域，用于标识业务的子系统、模块。 | 34| [LOG_TAG](#log_tag) NULL | 字符串常量，标识调用所在的类或者业务。 | 35| [OH_LOG_DEBUG](#oh_log_debug)(type, ...) ((void)[OH_LOG_Print](#oh_log_print)((type), LOG_DEBUG, LOG_DOMAIN, LOG_TAG, \_\_VA_ARGS__)) | DEBUG级别写日志，宏封装接口。 | 36| [OH_LOG_INFO](#oh_log_info)(type, ...) ((void)[OH_LOG_Print](#oh_log_print)((type), LOG_INFO, LOG_DOMAIN, LOG_TAG, \_\_VA_ARGS__)) | INFO级别写日志，宏封装接口。 | 37| [OH_LOG_WARN](#oh_log_warn)(type, ...) ((void)[OH_LOG_Print](#oh_log_print)((type), LOG_WARN, LOG_DOMAIN, LOG_TAG, \_\_VA_ARGS__)) | WARN级别写日志，宏封装接口。 | 38| [OH_LOG_ERROR](#oh_log_error)(type, ...) ((void)[OH_LOG_Print](#oh_log_print)((type), LOG_ERROR, LOG_DOMAIN, LOG_TAG, \_\_VA_ARGS__)) | ERROR级别写日志，宏封装接口。 | 39| [OH_LOG_FATAL](#oh_log_fatal)(type, ...) ((void)HiLogPrint((type), LOG_FATAL, LOG_DOMAIN, LOG_TAG, \_\_VA_ARGS__)) | FATAL级别写日志，宏封装接口。 | 40 41 42### 枚举 43 44| 枚举名称 | 描述 | 45| -------- | -------- | 46| [LogType](#logtype) { LOG_APP= 0 } | 日志类型。 | 47| [LogLevel](#loglevel) { LOG_DEBUG = 3, LOG_INFO = 4, LOG_WARN = 5, LOG_ERROR = 6, LOG_FATAL =7 } | 日志级别。 | 48 49 50### 函数 51 52| 函数名称 | 描述 | 53| -------- | -------- | 54| [OH_LOG_Print](#oh_log_print) ([LogType](#logtype) type, [LogLevel](#loglevel) level, unsigned int domain, const char \*tag, const char \*fmt,...) \_\_attribute\_\_((\_\_format\_\_(os\_log, 5,6))) | 写日志接口。 | 55| [OH_LOG_IsLoggable](#oh_log_isloggable) (unsigned int domain, const char \*tag, [LogLevel](#loglevel) level) | 检查指定业务领域、TAG、级别的日志是否可以打印。 | 56 57 58## 详细描述 59 60 61## 宏定义说明 62 63 64### LOG_DOMAIN 65 66 67``` 68#define LOG_DOMAIN 0 69``` 70 71**描述：** 72 73日志所对应的业务领域，用于标识业务的子系统、模块。 74 7516进制整数，有效范围0x0~0xFFFF，超过自动截掉高位。 76 77**起始版本：** 78 798 80 81 82### LOG_TAG 83 84 85``` 86#define LOG_TAG NULL 87``` 88 89**描述：** 90 91字符串常量，标识调用所在的类或者业务。 92 93**起始版本：** 94 958 96 97 98### OH_LOG_DEBUG 99 100 101``` 102#define OH_LOG_DEBUG( type, ... ) ((void)OH_LOG_Print((type), LOG_DEBUG, LOG_DOMAIN, LOG_TAG, __VA_ARGS__)) 103``` 104 105**描述：** 106 107DEBUG级别写日志，宏封装接口。 108 109使用时需要先定义日志业务领域、日志TAG，一般在源文件起始处统一定义一次。 110 111**参数：** 112 113| 名称 | 描述 | 114| -------- | -------- | 115| type | 日志类型，三方应用日志类型为LOG_APP。 | 116| fmt | 格式化字符串，基于类printf格式的增强，支持隐私参数标识，即在格式字符串每个参数中符号后类型前增加{public}、{private}标识。 | 117| ... | 与格式字符串里参数类型对应的参数列表，参数数目、参数类型必须与格式字符串中的标识一一对应。 | 118 119**参见：** 120 121[OH_LOG_Print](#oh_log_print) 122 123**起始版本：** 124 1258 126 127 128### OH_LOG_ERROR 129 130 131``` 132#define OH_LOG_ERROR( type, ... ) ((void)OH_LOG_Print((type), LOG_ERROR, LOG_DOMAIN, LOG_TAG, __VA_ARGS__)) 133``` 134 135**描述：** 136 137ERROR级别写日志，宏封装接口。 138 139使用时需要先定义日志业务领域、日志TAG，一般在源文件起始处统一定义一次。 140 141**参数：** 142 143| 名称 | 描述 | 144| -------- | -------- | 145| type | 日志类型，三方应用日志类型为LOG_APP。 | 146| fmt | 格式化字符串，基于类printf格式的增强，支持隐私参数标识，即在格式字符串每个参数中符号后类型前增加{public}、{private}标识。 | 147| ... | 与格式字符串里参数类型对应的参数列表，参数数目、参数类型必须与格式字符串中的标识一一对应。 | 148 149**参见：** 150 151[OH_LOG_Print](#oh_log_print) 152 153**起始版本：** 154 1558 156 157 158### OH_LOG_FATAL 159 160 161``` 162#define OH_LOG_FATAL( type, ... ) ((void)HiLogPrint((type), LOG_FATAL, LOG_DOMAIN, LOG_TAG, __VA_ARGS__)) 163``` 164 165**描述：** 166 167FATAL级别写日志，宏封装接口。 168 169使用时需要先定义日志业务领域、日志TAG，一般在源文件起始处统一定义一次。 170 171**参数：** 172 173| 名称 | 描述 | 174| -------- | -------- | 175| type | 日志类型，三方应用日志类型为LOG_APP。 | 176| fmt | 格式化字符串，基于类printf格式的增强，支持隐私参数标识，即在格式字符串每个参数中符号后类型前增加{public}、{private}标识。 | 177| ... | 与格式字符串里参数类型对应的参数列表，参数数目、参数类型必须与格式字符串中的标识一一对应。 | 178 179**参见：** 180 181[OH_LOG_Print](#oh_log_print) 182 183**起始版本：** 184 1858 186 187 188### OH_LOG_INFO 189 190 191``` 192#define OH_LOG_INFO( type, ... ) ((void)OH_LOG_Print((type), LOG_INFO, LOG_DOMAIN, LOG_TAG, __VA_ARGS__)) 193``` 194 195**描述：** 196 197INFO级别写日志，宏封装接口。 198 199使用时需要先定义日志业务领域、日志TAG，一般在源文件起始处统一定义一次。 200 201**参数：** 202 203| 名称 | 描述 | 204| -------- | -------- | 205| type | 日志类型，三方应用日志类型为LOG_APP。 | 206| fmt | 格式化字符串，基于类printf格式的增强，支持隐私参数标识，即在格式字符串每个参数中符号后类型前增加{public}、{private}标识。 | 207| ... | 与格式字符串里参数类型对应的参数列表，参数数目、参数类型必须与格式字符串中的标识一一对应。 | 208 209**参见：** 210 211[OH_LOG_Print](#oh_log_print) 212 213**起始版本：** 214 2158 216 217 218### OH_LOG_WARN 219 220 221``` 222#define OH_LOG_WARN( type, ... ) ((void)OH_LOG_Print((type), LOG_WARN, LOG_DOMAIN, LOG_TAG, __VA_ARGS__)) 223``` 224 225**描述：** 226 227WARN级别写日志，宏封装接口。 228 229使用时需要先定义日志业务领域、日志TAG，一般在源文件起始处统一定义一次。 230 231**参数：** 232 233| 名称 | 描述 | 234| -------- | -------- | 235| type | 日志类型，三方应用日志类型为LOG_APP。 | 236| fmt | 格式化字符串，基于类printf格式的增强，支持隐私参数标识，即在格式字符串每个参数中符号后类型前增加{public}、{private}标识。 | 237| ... | 与格式字符串里参数类型对应的参数列表，参数数目、参数类型必须与格式字符串中的标识一一对应。 | 238 239**参见：** 240 241[OH_LOG_Print](#oh_log_print) 242 243**起始版本：** 244 2458 246 247 248## 枚举类型说明 249 250 251### LogLevel 252 253 254``` 255enum LogLevel 256``` 257 258**描述：** 259 260日志级别。 261 262该枚举类型用于定义日志级别。 263 264各级别建议使用方式： 265 266DEBUG：比INFO级别更详细的流程记录，通过该级别的日志可以更详细地分析业务流程和定位分析问题。DEBUG级别的日志在正式发布版本中默认不会被打印，只有在调试版本或打开调试开关的情况下才会打印。 267 268INFO：用来记录业务关键流程节点，可以还原业务的主要运行过程；用来记录非正常情况信息，但这些情况都是可以预期的(如无网络信号、登录失败等)。这些日志都应该由该业务内处于支配地位的模块来记录，避免在多个被调用的模块或低级函数中重复记录。 269 270WARN：发生了较为严重的非预期情况，但是对用户影响不大，程序可以自动恢复或通过简单的操作就可以恢复的问题。 271 272ERROR：程序或功能发生了错误，该错误会影响功能的正常运行或用户的正常使用，可以恢复但恢复代价较高，如重置数据等。 273 274FATAL：重大致命异常，表明程序或功能即将崩溃，故障无法恢复。 275 276| 枚举值 | 描述 | 277| -------- | -------- | 278| LOG_DEBUG | DEBUG日志级别，使用OH_LOG_DEBUG接口打印 | 279| LOG_INFO | INFO日志级别，使用OH_LOG_INFO接口打印 | 280| LOG_WARN | WARN日志级别，使用OH_LOG_WARN接口打印 | 281| LOG_ERROR | ERROR日志级别，使用OH_LOG_ERROR接口打印 | 282| LOG_FATAL | FATAL日志级别，使用OH_LOG_FATAL接口打印 | 283 284**起始版本：** 285 2868 287 288 289### LogType 290 291 292``` 293enum LogType 294``` 295 296**描述：** 297 298日志类型。 299 300该枚举类型用于定义应用开发者可以使用的日志类型。当前有应用日志LOG_APP。 301 302| 枚举值 | 描述 | 303| -------- | -------- | 304| LOG_APP | 应用日志 | 305 306**起始版本：** 307 3088 309 310 311## 函数说明 312 313 314### OH_LOG_IsLoggable() 315 316 317``` 318bool OH_LOG_IsLoggable (unsigned int domain, const char * tag, LogLevel level ) 319``` 320 321**描述：** 322 323检查指定业务领域、TAG、级别的日志是否可以打印。 324 325**参数：** 326 327| 名称 | 描述 | 328| -------- | -------- | 329| domain | 指定日志业务领域。 | 330| tag | 指定日志TAG。 | 331| level | 指定日志level。 | 332 333**返回：** 334 335如果指定domain、tag、level日志可以打印则返回true；否则返回false。 336 337**起始版本：** 338 3398 340 341 342### OH_LOG_Print() 343 344 345``` 346int OH_LOG_Print (LogType type, LogLevel level, unsigned int domain, const char * tag, const char * fmt, ... ) 347``` 348 349**描述：** 350 351写日志接口。 352 353指定日志类型、日志级别、业务领域、TAG，按照类printf格式类型和隐私指示确定需要输出的变参。 354 355**参数：** 356 357| 名称 | 描述 | 358| -------- | -------- | 359| type | 日志类型，三方应用日志类型为LOG_APP。 | 360| level | 日志级别，日志级别包括LOG_DEBUG、LOG_INFO、LOG_WARN、LOG_ERROR、LOG_FATAL。 | 361| domain | 日志业务领域，16进制整数，范围0x0~0xFFFF。 | 362| tag | 日志TAG，字符串，标识调用所在的类或者业务。 | 363| fmt | 格式化字符串，基于类printf格式的增强，支持隐私参数标识，即在格式字符串每个参数中符号后类型前增加{public}、{private}标识。 | 364| ... | 与格式字符串里参数类型对应的参数列表，参数数目、参数类型必须与格式字符串中的标识一一对应。 | 365 366**返回：** 367 368大于等于0表示成功；小于0表示失败。 369 370**起始版本：** 371 3728 373