OpenHarmony eTS通用日志組件,寫日志快一點
OpenHarmony eTS通用日志組件
在開發的過程中總要通過日志輸出來完成一些調試工作,所以寫日志是避免不了的,日志記錄的功能并不復雜,卻是必要的、重復的,每個頁面要引入日志工具類,還要定義一個TAG常量,在記錄日志的時候將TAG變量傳遞給日志工具類,大概需要三步:
1.導入日志工具類—2.定義TAG常量(每個頁面定義一遍)—3.編寫記錄日志代碼行。
想了一下,完全可以傳遞this對象到日志工具類,由工具類獲取當前頁面名稱來完成日志的記錄,無需每個頁面定義TAG。
一、能做什么
1.支持按照tag和module兩層,分級記錄日志。
2.支持自動獲取頁面類名稱作為module,支持查看某個頁面或整個項目的日志。
3.配合 DevEco Studio自動提示功能,達到快速記錄日志效果。
二、使用步驟
1、npm安裝組件。
命令行進入entry目錄,執行下面命令。
npm install git+https://gitee.com/butingyou/ohos-clogger.git
2、頁面導入CommonLog。
import { CommonLog as logger } from '@ohos/ohos_clogger'
3、修改CommonLog 文件中 tag名為項目名稱,方便區分。
按住CTRL+ 鼠標左鍵點擊CommonLog,進入index.ets,再點一次,進入 CommonLog.ets 文件,就可以修改了,整個項目只需要修改一次。
/**
* 日志管理類
*/
export default class CommonLog {
private tag: string = "OhosCpt" //修改為項目名稱
private static module: string = "Log"
4、編寫日志行。
logger.getInstance(this).debug(`this.notice:${this.notice}`)
5、還可以更快一點。
配合 IDE 的代碼生成功能,一鍵生成日志代碼行,只需要關心要輸出的內容。
File—Settings—Live Templates—添加3個快捷生成代碼模板。
可以快樂的記錄日志了 O(∩_∩)O~~
日志效果: