個人認為,如果公司一些基礎類庫不做約束,很可能“埋坑”,形成技術債務,最終為此付出代價。本文講解一個最基本的日志打印規范。
1. 日志打印組件
日志組件有很多,日志門面的選擇有:Slf4j、Apache Commons Logging等。
日志的實現更多,有:log4j、logback、log4j2、JAVA util logging、jboss logging等等。
目前,我們使用slf4j作為日志門面,log4j2作為日志實現。
2. 日志級別
日志的級別有很多,我們一般只用四個。日志級別由低到高debug-->info-->warn-->error
DEBUG(調試)
開發調試日志。一般來說,在系統實際運行過程中,不會輸出該級別的日志。因此,開發人員可以打印任何自己覺得有利于開發查問題的任何log。
INFO(通知)
INFO日志級別主要用于記錄系統運行狀態等關聯信息。該日志級別,常用于反饋系統當前狀態給最終用戶。所以,在這里輸出的信息,應該對最終用戶具有實際意義,也就是最終用戶要能夠看得明白是什么意思才行。
WARN(警告)
WARN日志常用來表示系統模塊發生問題,但并不影響系統運行。 此時,進行一些修復性的工作,還能把系統恢復到正常的狀態。
ERROR(錯誤)
此信息輸出后,主體系統核心模塊正常工作,需要修復才能正常工作。 就是說可以進行一些修復性的工作,但無法確定系統會正常的工作下去,系統在以后的某個階段,很可能會因為當前的這個問題,導致一個無法修復的錯誤(例如宕機),但也可能一直工作到停止也不出現嚴重問題。
3. 日志打印場景
在我們的系統中,不同的日志級別的打印場景大致如下
DEBUG 調試日志。目前管理相對寬松,我們暫時沒有嚴格要求。
INFO 業務日志。我們用來記錄業務的主流程的走向。
WARN 警告日志。一般來說,發生對整個系統沒什么影響的異常時,可以打印該級別的日志。
ERROR 錯誤日志。級別比較高,如果發生一些異常,并且任何時候都需要打印時使用。
4. 日志使用方式
示例代碼
private static final Logger logger = LoggerFactory.getLogger(TestController.class);
我們使用的日志門面是slf4j,使用時應面向接口編程,LOGGER/LoggerFactory應該都是slf4j的API。
嚴禁直接使用日志實現包。原因大致有兩點
1、是面向接口編程更優雅,這點不必說明;
2、舉個例子,因為log4j已經幾年不更新,老的項目可能使用了log4j,現在想要換用logback或者log4j2,如直接使用log4j的API,不利于選型更換與API的統一。
禁止字符串拼接
例如:
logger.debug("當前用戶是:" + user + ",傳入參數是:" + userId);
嚴禁使用字符串拼接的方式打印日志,可讀性、可維護性都比較差。
建議的寫法如下:
logger.debug("當前用戶是:{},傳入參數是:{},返回值是:{},用戶信息:{}", a,b new Object[]{token, userId, userInfo, authcInfo});
因為我們使用的是slf4j,slf4j有占位符填充的功能。多個占位符可放在Object數組中。