js-apis-hilog.md 7.0 KB
Newer Older
Z
zengyawen 已提交
1 2 3 4
# 日志打印

> **说明:**
>
Z
zengyawen 已提交
5
> 本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
Z
zengyawen 已提交
6 7 8

## 导入模块

L
lyj_love_code 已提交
9
```js
Z
zengyawen 已提交
10 11 12 13 14 15 16 17 18 19
import hilog from '@ohos.hilog';
```


## hilog.debug

debug(domain: number, tag: string, format: string, ...args: any[]) : void

debug日志输出,打印debug级别日志。

Z
zengyawen 已提交
20 21
**系统能力:** SystemCapability.HiviewDFX.HiLog

Z
zengyawen 已提交
22 23 24 25 26 27 28 29 30 31 32
**参数:**

| 参数名 | 类型           | 必填 | 说明                                                         |
| ------ | -------------- | ---- | ------------------------------------------------------------ |
| domain | number         | 是   | 业务领域。范围0x0~0xFFFFF。                                  |
| tag    | string         | 是   | 字符串常量,标识调用所在的类或者业务行为。                   |
| format | string         | 是   | 格式字符串,包含参数类型、隐私标识。未加隐私标识的缺省为隐私参数。 |
| args   | any[]          | 是   | 与格式字符串里参数类型对应的可变长度参数列表。参数数目、参数类型必须与格式字符串中的标识一一对应。 |

**示例:**

L
lyj_love_code 已提交
33
```js
Z
zengyawen 已提交
34 35 36 37 38 39 40 41 42
hilog.debug(0xFF00, "testTag", "%d: %{private}s World %{public}f", 1, "hello", 3.0);
```

**输出:**

```
09-08 12:49:35.941  1547  2452 D FF00/testTag: 1: hello World 3.0
```

Z
zengyawen 已提交
43
## hilog.info
Z
zengyawen 已提交
44 45 46 47 48

info(domain: number, tag: string, format: string, ...args: any[]) : void

info日志输出,打印info级别日志。

Z
zengyawen 已提交
49 50
**系统能力:** SystemCapability.HiviewDFX.HiLog

Z
zengyawen 已提交
51 52 53 54 55 56 57 58 59 60 61
**参数:**

| 参数名 | 类型           | 必填 | 说明                                                         |
| ------ | -------------- | ---- | ------------------------------------------------------------ |
| domain | number         | 是   | 业务领域。范围0x0~0xFFFFF。                                  |
| tag    | string         | 是   | 字符串常量,标识调用所在的类或者业务行为。                   |
| format | string         | 是   | 格式字符串,包含参数类型、隐私标识。未加隐私标识的缺省为隐私参数。 |
| args   | any[]  | 是   | 与格式字符串里参数类型对应的可变长度参数列表。参数数目、参数类型必须与格式字符串中的标识一一对应。 |

**示例:**

L
lyj_love_code 已提交
62
```js
Z
zengyawen 已提交
63 64 65 66 67 68 69 70 71 72 73 74 75 76 77
hilog.info(0xFF00, "testTag", "%d: %{private}s World %{public}f", 1, "hello", 3.0);
```

**输出:**

```
09-08 12:49:35.941  1547  2452 I FF00/testTag: 1: hello World 3.0
```

## hilog.warn

warn(domain: number, tag: string, format: string, ...args: any[]) : void

warn日志输出,打印warn级别日志。

Z
zengyawen 已提交
78 79
**系统能力:** SystemCapability.HiviewDFX.HiLog

Z
zengyawen 已提交
80 81 82 83 84 85 86 87 88 89 90
**参数:**

| 参数名 | 类型           | 必填 | 说明                                                         |
| ------ | -------------- | ---- | ------------------------------------------------------------ |
| domain | number         | 是   | 业务领域。范围0x0~0xFFFFF。                                  |
| tag    | string         | 是   | 字符串常量,标识调用所在的类或者业务行为。                   |
| format | string         | 是   | 格式字符串,包含参数类型、隐私标识。未加隐私标识的缺省为隐私参数。 |
| args   | any[]  | 是   | 与格式字符串里参数类型对应的可变长度参数列表。参数数目、参数类型必须与格式字符串中的标识一一对应。 |

**示例:**

L
lyj_love_code 已提交
91
```js
Z
zengyawen 已提交
92 93 94 95 96 97 98 99 100 101 102 103 104 105 106
hilog.warn(0xFF00, "testTag", "%d: %{private}s World %{public}f", 1, "hello", 3.0);
```

**输出:**

```
09-08 12:49:35.941  1547  2452 W FF00/testTag: 1: hello World 3.0
```

## hilog.error

error(domain: number, tag: string, format: string, ...args: any[]) : void

error日志输出,打印error级别日志。

Z
zengyawen 已提交
107 108
**系统能力:** SystemCapability.HiviewDFX.HiLog

Z
zengyawen 已提交
109 110 111 112 113 114 115 116 117 118 119
**参数:**

| 参数名 | 类型           | 必填 | 说明                                                         |
| ------ | -------------- | ---- | ------------------------------------------------------------ |
| domain | number         | 是   | 业务领域。范围0x0~0xFFFFF。                                  |
| tag    | string         | 是   | 字符串常量,标识调用所在的类或者业务行为。                   |
| format | string         | 是   | 格式字符串,包含参数类型、隐私标识。未加隐私标识的缺省为隐私参数。 |
| args   | any[]  | 是   | 与格式字符串里参数类型对应的可变长度参数列表。参数数目、参数类型必须与格式字符串中的标识一一对应。 |

**示例:**

L
lyj_love_code 已提交
120
```js
Z
zengyawen 已提交
121 122 123 124 125 126 127 128 129 130 131 132 133 134 135
hilog.error(0xFF00, "testTag", "%d: %{private}s World %{public}f", 1, "hello", 3.0);
```

**输出:**

```
09-08 12:49:35.941  1547  2452 E FF00/testTag: 1: hello World 3.0
```

## hilog.fatal

fatal(domain: number, tag: string, format: string, ...args: any[]) : void

fatal日志输出,打印fatal级别日志。

Z
zengyawen 已提交
136 137
**系统能力:** SystemCapability.HiviewDFX.HiLog

Z
zengyawen 已提交
138 139 140 141 142 143 144 145 146 147 148
**参数:**

| 参数名 | 类型           | 必填 | 说明                                                         |
| ------ | -------------- | ---- | ------------------------------------------------------------ |
| domain | number         | 是   | 业务领域。范围0x0~0xFFFFF。                                  |
| tag    | string         | 是   | 字符串常量,标识调用所在的类或者业务行为。                   |
| format | string         | 是   | 格式字符串,包含参数类型、隐私标识。未加隐私标识的缺省为隐私参数。 |
| args   | any[]  | 是   | 与格式字符串里参数类型对应的可变长度参数列表。参数数目、参数类型必须与格式字符串中的标识一一对应。 |

**示例:**

L
lyj_love_code 已提交
149
```js
Z
zengyawen 已提交
150 151 152 153 154 155 156 157 158 159 160 161 162 163 164
hilog.fatal(0xFF00, "testTag", "%d: %{private}s World %{public}f", 1, "hello", 3.0);
```

**输出:**

```
09-08 12:49:35.941  1547  2452 F FF00/testTag: 1: hello World 3.0
```

## hilog.isLoggable

isLoggable(domain: number, tag: string, level: LogLevel) : boolean

检查一个domain、tag和日志级别是否被禁止打印日志。

Z
zengyawen 已提交
165 166
**系统能力:** SystemCapability.HiviewDFX.HiLog

Z
zengyawen 已提交
167 168 169 170 171 172 173 174 175 176
**参数:**

| 参数名 | 类型                  | 必填 | 说明                                       |
| ------ | --------------------- | ---- | ------------------------------------------ |
| domain | number                | 是   | 业务领域。范围0x0~0xFFFFF。                |
| tag    | string                | 是   | 字符串常量,标识调用所在的类或者业务行为。 |
| level  | [LogLevel](#loglevel) | 是   | 日志级别。                                 |

**示例:**

L
lyj_love_code 已提交
177
```js
Z
zengyawen 已提交
178 179 180 181 182 183 184
hilog.isLoggable(0xFF00, "testTag", hilog.DEBUG);
```

## LogLevel

用于表示事件类型。

Z
zengyawen 已提交
185 186
**系统能力:** 以下各项对应的系统能力均为SystemCapability.HiviewDFX.HiLog。

Z
zengyawen 已提交
187 188 189 190 191 192 193
| 名称  | 默认值 | 说明        |
| ----- | ------ | ----------- |
| DEBUG | 3      | DEBUG级别。 |
| INFO  | 4      | INFO级别。  |
| WARN  | 5      | WARN级别。  |
| ERROR | 6      | ERROR级别。 |
| FATAL | 7      | FATAL级别。 |