工作总结：日志打印的15个建议
前言
日志是快速定位問題的好幫手，是撕逼和甩鍋的利器！打印好日志非常重要。今天我們來聊聊日志打印的15個好建議~
1. 選擇恰當的日志級別
常見的日志級別有5種，分別是error、warn、info、debug、trace。日常開發中，我們需要選擇恰當的日志級別，不要反手就是打印info哈~
error：錯誤日志，指比較嚴重的錯誤，對正常業務有影響，需要運維配置監控的；
warn：警告日志，一般的錯誤，對業務影響不大，但是需要開發關注；
info：信息日志，記錄排查問題的關鍵信息，如調用時間、出參入參等等；
debug：用于開發DEBUG的，關鍵邏輯里面的運行時數據；
trace：最詳細的信息，一般這些信息只記錄到日志文件中。
2.日志要打印出方法的入參/出參
我們并不需要打印很多很多日志，只需要打印可以快速定位問題的有效日志。有效的日志，是甩鍋的利器！
哪些算得的上有效關鍵的日志呢？比如說，方法進來的時候，打印入參。再然后呢，在方法返回的時候，就是打印出參，返回值。入參的話，一般就是userId或者bizSeq這些關鍵信息。正例如下：
public?String?testLogMethod(Document?doc,?Mode?mode){log.debug(“method enter param：{}”,userId);String?id?=?"666";log.debug(“method?exit?param：{}”,id);return?id; }3. 選擇合適的日志格式
理想的日志格式，應當包括這些最基本的信息：如當前時間戳（一般毫秒精確度）、日志級別，線程名字等等。在logback日志里可以這么配置：
<appender?name="STDOUT"?class="ch.qos.logback.core.ConsoleAppender"><encoder><pattern>%d{HH:mm:ss.SSS}?%-5level?[%thread][%logger{0}]?%m%n</pattern></encoder> </appender>如果我們的日志格式，連當前時間都沒有記錄，那連請求的時間點都不知道了？
4. 遇到if...else...等條件時，每個分支首行都盡量打印日志
當你碰到if...else...或者switch這樣的條件時，可以在分支的首行就打印日志，這樣排查問題時，就可以通過日志，確定進入了哪個分支，代碼邏輯更清晰，也更方便排查問題了。
正例：
if(user.isVip()){log.info("該用戶是會員,Id:{},開始處理會員邏輯",user,getUserId());//會員邏輯 }else{log.info("該用戶是非會員,Id:{},開始處理非會員邏輯",user,getUserId())//非會員邏輯 }5.日志級別比較低時，進行日志開關判斷
對于trace/debug這些比較低的日志級別，必須進行日志級別的開關判斷。
正例：
User?user?=?new?User(666L,?"公眾號",?"撿田螺的小男孩"); if?(log.isDebugEnabled())?{log.debug("userId?is:?{}",?user.getId()); }因為當前有如下的日志代碼：
logger.debug("Processing?trade?with?id:?"?+?id?+?"?and?symbol:?"?+?symbol);如果配置的日志級別是warn的話，上述日志不會打印，但是會執行字符串拼接操作，如果symbol是對象， 還會執行toString()方法，浪費了系統資源，執行了上述操作，最終日志卻沒有打印，因此建議加日志開關判斷。
6. 不能直接使用日志系統（Log4j、Logback）中的 API，而是使用日志框架SLF4J中的API。
SLF4J 是門面模式的日志框架，有利于維護和各個類的日志處理方式統一，并且可以在保證不修改代碼的情況下，很方便的實現底層日志框架的更換。
正例：
import?org.slf4j.Logger;? import?org.slf4j.LoggerFactory;private?static?final?Logger?logger?=?LoggerFactory.getLogger(TianLuoBoy.class);7. 建議使用參數占位{}，而不是用+拼接。
反例：
logger.info("Processing?trade?with?id:?"?+?id?+?"?and?symbol:?"?+?symbol);上面的例子中，使用+操作符進行字符串的拼接，有一定的性能損耗。
正例如下：
logger.info("Processing?trade?with?id:?{}?and?symbol?:?{}?",?id,?symbol);我們使用了大括號{}來作為日志中的占位符，比于使用+操作符，更加優雅簡潔。并且，相對于反例，使用占位符僅是替換動作，可以有效提升性能。
8. 建議使用異步的方式來輸出日志。
日志最終會輸出到文件或者其它輸出流中的，IO性能會有要求的。如果異步，就可以顯著提升IO性能。
除非有特殊要求，要不然建議使用異步的方式來輸出日志。以logback為例吧，要配置異步很簡單，使用AsyncAppender就行
9. 不要使用e.printStackTrace()
反例：
try{//?業務代碼處理 }catch(Exception?e){e.printStackTrace(); }正例：
try{//?業務代碼處理 }catch(Exception?e){log.error("你的程序有異常啦",e); }理由：
e.printStackTrace()打印出的堆棧日志跟業務代碼日志是交錯混合在一起的，通常排查異常日志不太方便。
e.printStackTrace()語句產生的字符串記錄的是堆棧信息，如果信息太長太多，字符串常量池所在的內存塊沒有空間了,即內存滿了，那么，用戶的請求就卡住啦~
10. 異常日志不要只打一半，要輸出全部錯誤信息
反例1：
try?{//業務代碼處理 }?catch?(Exception?e)?{//?錯誤LOG.error('你的程序有異常啦'); }異常e都沒有打印出來，所以壓根不知道出了什么類型的異常。
反例2：
try?{//業務代碼處理 }?catch?(Exception?e)?{//?錯誤LOG.error('你的程序有異常啦',?e.getMessage()); }e.getMessage()不會記錄詳細的堆棧異常信息，只會記錄錯誤基本描述信息，不利于排查問題。
正例：
try?{//業務代碼處理 }?catch?(Exception?e)?{//?錯誤LOG.error('你的程序有異常啦',?e); }11. 禁止在線上環境開啟 debug
禁止在線上環境開啟debug，這一點非常重要。
因為一般系統的debug日志會很多，并且各種框架中也大量使用 debug的日志，線上開啟debug不久可能會打滿磁盤，影響業務系統的正常運行。
12.不要記錄了異常，又拋出異常
反例如下：
log.error("IO?exception",?e); throw?new?MyException(e);這樣實現的話，通常會把棧信息打印兩次。這是因為捕獲了MyException異常的地方，還會再打印一次。
這樣的日志記錄，或者包裝后再拋出去，不要同時使用！否則你的日志看起來會讓人很迷惑。
13.避免重復打印日志
避免重復打印日志，醬紫會浪費磁盤空間。如果你已經有一行日志清楚表達了意思，避免再冗余打印，反例如下：
if(user.isVip()){log.info("該用戶是會員,Id:{}",user,getUserId());//冗余，可以跟前面的日志合并一起log.info("開始處理會員邏輯,id:{}",user,getUserId());//會員邏輯 }else{//非會員邏輯 }如果你是使用log4j日志框架，務必在log4j.xml中設置 additivity=false，因為可以避免重復打印日志
正例：
<logger?name="com.taobao.dubbo.config"?additivity="false">14.日志文件分離
我們可以把不同類型的日志分離出去，比如access.log，或者error級別error.log，都可以單獨打印到一個文件里面。
當然，也可以根據不同的業務模塊，打印到不同的日志文件里，這樣我們排查問題和做數據統計的時候，都會比較方便啦。
15. 核心功能模塊，建議打印較完整的日志
我們日常開發中，如果核心或者邏輯復雜的代碼，建議添加詳細的注釋，以及較詳細的日志。
日志要多詳細呢？腦洞一下，如果你的核心程序哪一步出錯了，通過日志可以定位到，那就可以啦。
--?end--
40 個 SpringBoot 常用注解：讓生產力爆表！
聊聊Spring事務失效的12種場景，太坑了
SpringBoot 中 4 大核心組件，你了解多少？
總結
以上是生活随笔為你收集整理的工作总结：日志打印的15个建议的全部內容，希望文章能夠幫你解決所遇到的問題。
- 上一篇： Java日历的getMinimalDay
- 下一篇： kotlin获取属性_Kotlin程序|