日志打印
hilog日志系統,使應用/服務可以按照指定級別、標識和格式字符串輸出日志內容,幫助開發者了解應用/服務的運行狀態,更好地調試程序。
導入模塊
import hilog from '@ohos.hilog';
hilog.isLoggable
isLoggable(domain: number, tag: string, level: LogLevel) : boolean
在打印日志前調用該接口,用于檢查指定領域標識、日志標識和級別的日志是否可以打印。
系統能力: SystemCapability.HiviewDFX.HiLog
參數:
參數名 | 類型 | 必填 | 說明 |
---|---|---|---|
domain | number | 是 | 日志對應的領域標識,范圍是0x0~0xFFFF,開發者可根據需要自定義。 |
tag | string | 是 | 指定日志標識,可以為任意字符串,建議用于標識調用所在的類或者業務行為。 |
level | [LogLevel] | 是 | 日志級別。 |
返回值:
類型 | 說明 |
---|---|
boolean | 如果返回true,則該領域標識、日志標識和級別的日志可以打印,否則不能打印。 |
示例:
hilog.isLoggable(0x0001, "testTag", hilog.LogLevel.INFO);
LogLevel
日志級別。
系統能力: SystemCapability.HiviewDFX.HiLog
名稱 | 默認值 | 說明 |
---|---|---|
DEBUG | 3 | 詳細的流程記錄,通過該級別的日志可以更詳細地分析業務流程和定位分析問題。 |
INFO | 4 | 用于記錄業務關鍵流程節點,可以還原業務的主要運行過程; 用于記錄可預料的非正常情況信息,如無網絡信號、登錄失敗等。 這些日志都應該由該業務內處于支配地位的模塊來記錄,避免在多個被調用的模塊或低級函數中重復記錄。 |
WARN | 5 | 用于記錄較為嚴重的非預期情況,但是對用戶影響不大,應用可以自動恢復或通過簡單的操作就可以恢復的問題。 |
ERROR | 6 | 應用發生了錯誤,該錯誤會影響功能的正常運行或用戶的正常使用,可以恢復但恢復代價較高,如重置數據等。 |
FATAL | 7 | 重大致命異常,表明應用即將崩潰,故障無法恢復。 |
hilog.debug
debug(domain: number, tag: string, format: string, ...args: any[]) : void
打印DEBUG級別的日志。
DEBUG級別的日志在正式發布版本中默認不被打印,只有在調試版本或打開調試開關的情況下才會打印。
系統能力: SystemCapability.HiviewDFX.HiLog
參數:
參數名 | 類型 | 必填 | 說明 |
---|---|---|---|
domain | number | 是 | 日志對應的領域標識,范圍是0x0~0xFFFF,開發者可根據需要自定義。 |
tag | string | 是 | 指定日志標識,可以為任意字符串,建議用于標識調用所在的類或者業務行為。 |
format | string | 是 | 格式字符串,用于日志的格式化輸出。格式字符串中可以設置多個參數,參數需要包含參數類型、隱私標識。 隱私標識分為{public}和{private},缺省為{private}。標識{public}的內容明文輸出,標識{private}的內容以過濾回顯。 |
args | any[] | 是 | 與格式字符串format對應的可變長度參數列表。參數數目、參數類型必須與格式字符串中的標識一一對應。 |
示例:
輸出一條DEBUG信息,格式字符串為"%{public}s World %{private}d"
。其中變參%{public}s
為明文顯示的字符串;%{private}d
為隱私的整型數。
hilog.debug(0x0001, "testTag", "%{public}s World %{private}d", "hello", 3);
字符串"hello"
填入%{public}s
,整型數3
填入%{private}d
,輸出日志:
08-05 12:21:47.579 2695-2703/com.example.myapplication D 00001/testTag: hello World < private >
hilog.info
info(domain: number, tag: string, format: string, ...args: any[]) : void
打印INFO級別的日志。
系統能力: SystemCapability.HiviewDFX.HiLog
參數:
參數名 | 類型 | 必填 | 說明 |
---|---|---|---|
domain | number | 是 | 日志對應的領域標識,范圍是0x0~0xFFFF,開發者可根據需要自定義。 |
tag | string | 是 | 指定日志標識,可以為任意字符串,建議用于標識調用所在的類或者業務行為。 |
format | string | 是 | 格式字符串,用于日志的格式化輸出。格式字符串中可以設置多個參數,參數需要包含參數類型、隱私標識。 隱私標識分為{public}和{private},缺省為{private}。標識{public}的內容明文輸出,標識{private}的內容以過濾回顯。 |
args | any[] | 是 | 與格式字符串format對應的可變長度參數列表。參數數目、參數類型必須與格式字符串中的標識一一對應。 |
示例:
輸出一條INFO信息,格式字符串為"%{public}s World %{private}d"
。其中變參%{public}s
為明文顯示的字符串;%{private}d
為隱私的整型數。
hilog.info(0x0001, "testTag", "%{public}s World %{private}d", "hello", 3);
字符串"hello"
填入%{public}s
,整型數3
填入%{private}d
,輸出日志:
08-05 12:21:47.579 2695-2703/com.example.myapplication I 00001/testTag: hello World < private >
hilog.warn
warn(domain: number, tag: string, format: string, ...args: any[]) : void
打印WARN級別的日志。
系統能力: SystemCapability.HiviewDFX.HiLog
參數:
參數名 | 類型 | 必填 | 說明 |
---|---|---|---|
domain | number | 是 | 日志對應的領域標識,范圍是0x0~0xFFFF,開發者可根據需要自定義。 |
tag | string | 是 | 指定日志標識,可以為任意字符串,建議用于標識調用所在的類或者業務行為。 |
format | string | 是 | 格式字符串,用于日志的格式化輸出。格式字符串中可以設置多個參數,參數需要包含參數類型、隱私標識。 隱私標識分為{public}和{private},缺省為{private}。標識{public}的內容明文輸出,標識{private}的內容以過濾回顯。 |
args | any[] | 是 | 與格式字符串format對應的可變長度參數列表。參數數目、參數類型必須與格式字符串中的標識一一對應。 |
示例:
輸出一條WARN信息,格式字符串為"%{public}s World %{private}d"
。其中變參%{public}s
為明文顯示的字符串;%{private}d
為隱私的整型數。
hilog.warn(0x0001, "testTag", "%{public}s World %{private}d", "hello", 3);
字符串"hello"
填入%{public}s
,整型數3
填入%{private}d
,輸出日志:
08-05 12:21:47.579 2695-2703/com.example.myapplication W 00001/testTag: hello World < private >
hilog.error
error(domain: number, tag: string, format: string, ...args: any[]) : void
打印ERROR級別的日志。
系統能力: SystemCapability.HiviewDFX.HiLog
參數:
參數名 | 類型 | 必填 | 說明 |
---|---|---|---|
domain | number | 是 | 日志對應的領域標識,范圍是0x0~0xFFFF,開發者可根據需要自定義。 |
tag | string | 是 | 指定日志標識,可以為任意字符串,建議用于標識調用所在的類或者業務行為。 |
format | string | 是 | 格式字符串,用于日志的格式化輸出。格式字符串中可以設置多個參數,參數需要包含參數類型、隱私標識。 隱私標識分為{public}和{private},缺省為{private}。標識{public}的內容明文輸出,標識{private}的內容以過濾回顯。 |
args | any[] | 是 | 與格式字符串format對應的可變長度參數列表。參數數目、參數類型必須與格式字符串中的標識一一對應。 |
示例:
輸出一條ERROR信息,格式字符串為"%{public}s World %{private}d"
。其中變參%{public}s
為明文顯示的字符串;%{private}d
為隱私的整型數。
hilog.error(0x0001, "testTag", "%{public}s World %{private}d", "hello", 3);
字符串"hello"
填入%{public}s
,整型數3
填入%{private}d
,輸出日志:
08-05 12:21:47.579 2695-2703/com.example.myapplication E 00001/testTag: hello World < private >
hilog.fatal
fatal(domain: number, tag: string, format: string, ...args: any[]) : void
打印FATAL級別的日志。
系統能力: SystemCapability.HiviewDFX.HiLog
參數:
參數名 | 類型 | 必填 | 說明 |
---|---|---|---|
domain | number | 是 | 日志對應的領域標識,范圍是0x0~0xFFFF,開發者可根據需要自定義。 |
tag | string | 是 | 指定日志標識,可以為任意字符串,建議用于標識調用所在的類或者業務行為。 |
format | string | 是 | 格式字符串,用于日志的格式化輸出。格式字符串中可以設置多個參數,參數需要包含參數類型、隱私標識。 隱私標識分為{public}和{private},缺省為{private}。標識{public}的內容明文輸出,標識{private}的內容以過濾回顯。 |
args | any[] | 是 | 與格式字符串format對應的可變長度參數列表。參數數目、參數類型必須與格式字符串中的標識一一對應。 |
示例:
輸出一條FATAL信息,格式字符串為"%{public}s World %{private}d"
。其中變參%{public}s
為明文顯示的字符串;%{private}d
為隱私的整型數。
hilog.fatal(0x0001, "testTag", "%{public}s World %{private}d", "hello", 3);
字符串"hello"
填入%{public}s
,整型數3
填入%{private}d
,輸出日志:
08-05 12:21:47.579 2695-2703/com.example.myapplication F 00001/testTag: hello World < private >
審核編輯 黃宇
-
接口
+關注
關注
33文章
8691瀏覽量
151918 -
鴻蒙
+關注
關注
57文章
2392瀏覽量
43050
發布評論請先 登錄
相關推薦
評論