[[376361]]

最近在做新項目，一直在加班，期間遇到很多問題，我把一部分歸類為設計原則的問題，當然，這里的設計原則不是特指那個SOLID五大原則，這里是指更廣義的設計原則，不喜勿噴。

今天，我們來看第一個問題: 日志到底該如何打印?

咋一看，這個問題很簡單，其實不然，我隨手寫幾個，您看看。

log.error("xxxxx"); 
 
log.error(e.getMessage()); 
 
log.error("xxxxx", e.getMessage()); 
 
log.error("xxxxx {}", e.message()); 
 
log.error("xxxxx {}", e); 

好了，就隨便寫這么多，地鐵上打字不太方便，您認為上面那些日志打印方式哪些是正確的?

實話說，沒有正確的，全是錯的。怎么樣，是不是踩坑了，是不是給別人埋過這樣的坑。

那么，怎么打印日志才是正確的呢?

如果您使用的是slf4j，那么，只有下面這一種是正確的:

log.error("xxxxx, userId={}, xxParam={}", userId, xxParam, e);

首先，打印日志必須帶上上下文信息，比如，用戶ID，關鍵參數，同時，如果是捕獲異常里面打印的日志，必須把原來的e打印出來，否則，排查日志想死的心都有了。

比如，我最近就遇到一個同學，他把遠程調用用一個try catch包著，并在catch中捕獲了異常，打印了日志"遠程調用錯誤xxx"，呵呵，有一次請求失敗，非要說遠程調用失敗，對方出錯了，對方說我沒收到請求呀，兩人撕逼，最后找到我，我一看這代碼，說了一句，把e打印出來再重新調用，結果可想而知，他自己空指針了，呵呵了。

再說回上面的打印方式，有的同學可能會質疑，前面引號里明明是兩個大括號，后面卻出現3個變量，確定這個e能打印出來?

你是在懷疑我嗎?自己看源碼去。源碼中已經明確寫了如果最后一個參數是Exception類型，就不會參與字符串格式化，會單獨拿出來打印，同時，可以打印出堆棧信息。看源碼去吧，我在地鐵上，就不截圖了。

你以為本篇文章就結束了嗎?那你就錯了。

有沒有更優雅的日志打印方式呢?

我認為，最好的日志是以解決問題的方式打印日志。

怎么理解呢?

我們以服務注冊為例，當注冊中心地址不通的時候，我們能不能這樣打印呢?

"從 112.112.112.112 到注冊中心 113.113.113.113的網絡不通，請檢查注冊中心是否啟動，網絡防火墻是否暢通，balabala"。

這樣的方式就比較好，給使用者提供解決方案，你只要按著給出的方案排查一下，大概率就能解決了你的問題，這才是最優雅的打印姿勢。

好了，今天的內容就到這里，嗐，差點坐過站。

本文轉載自微信公眾號「 彤哥讀源碼  」，可以通過以下二維碼關注。轉載本文請聯系 彤哥讀源碼  公眾號。