聊聊日志打印規范問題


最近有兩個現場項目問題定位排查都跟加日志有關。這也是現在一個比較嚴重的問題之一,很多時候現場有問題找研發都是要臨時增加日志然后發現場替換文件定位問題。還有些研發日志打印很隨便,遇到問題日志很多但關鍵想用的沒多少,為此我覺得很有必要規范日志打印問題。

尤其是開發也要注意自己日志是否打印規范,做好打印日志這件小事是編碼人員的基本素養之一。為此開發人員應該做到以下幾點,

  1. 保證異常捕獲日志打印正確,禁止出現捕獲異常不做任何處理的行為,不能直接將異常打印到控制台。
  2. 在線程中run方法做異常捕獲並日志輸出,避免線程異常日志直接被輸出到控制台。
  3. 使用日志門面slf4j的接口API,而不是使用具體的日志實現框架API。使用占位符打印日志而非用字符串拼接的方式。
  4. 使用正確的日志級別打印日志,只對嚴重的程序邏輯異常問題使用error,在程序運行的關鍵節點輸出info日志,在接口函數調用處可打印debug日志。不在生產環境上使用debug日志,更不要在debug日志中輸出大對象文件,比如圖片文件等。
  5. 可以在接口調用或給第三方提供的接口中增加額外的日志文件,方便對接問題的排查。可以統一采用AOP模式來打印輸出函數接口調用日志。
  6. 對於線上已存在的頻繁打印的無用的調試日志,可以將相應類的日志輸出級別調高。避免輸出太多無用日志占用存儲空間。
  7. 學習並踐行公司內日志處理規范,可以學習阿里開發規約中異常日志規范部分。

作為開發團隊負責人,要注意重視推廣並落實日志規划,在開發代碼review時也要關注日志打印是否合規,是否在關鍵地方打印日志等。

 


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM