前言
大家好，日志是快速定位問題的好幫手，是撕逼和甩鍋的利器！列印好日志非常重要。今天我們來聊聊日志列印的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就行
<appender name="FILE_ASYNC" class="ch.qos.logback.classic.AsyncAppender">
<appender-ref ref="ASYNC"/>
</appender> 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異常的地方，還會再列印一次。
- 這樣的日志記錄，或者包裝後再抛出去，不要同時使用！否則你的日志看起來會讓人很迷惑。
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. 核心功能子產品，建議列印較完整的日志
- 我們日常開發中，如果核心或者邏輯複雜的代碼，建議添加詳細的注釋，以及較詳細的日志。
- 日志要多詳細呢？腦洞一下，如果你的核心程式哪一步出錯了，通過日志可以定位到，那就可以啦。