2.2 打印方法的入?yún)⒊鰠?/h3>

我們并不需要打印很多很多日志，只需要打印可以快速定位問題的有效日志。有效的日志，是甩鍋的利器:

哪些算得的上有效關(guān)鍵的日志呢？比如說，方法進(jìn)來的時(shí)候，打印入?yún)?/strong>。再然后呢，在方法返回的時(shí)候，就是打印出參，返回值。入?yún)⒌脑?，一般就?strong>userId或者bizSeq這些關(guān)鍵信息。

2.3  遇到if條件時(shí)，每個(gè)分支都打印日志

當(dāng)你碰到if...else...或者switch這樣的條件時(shí)，可以在分支的首行就打印日志，這樣排查問題時(shí)，就可以通過日志，確定進(jìn)入了哪個(gè)分支，代碼邏輯更清晰，也更方便排查問題了。

if(user.isVip()){
  log.info("該用戶是會(huì)員,Id:{},開始處理會(huì)員邏輯",user,getUserId());
  //會(huì)員邏輯
}else{
  log.info("該用戶是非會(huì)員,Id:{},開始處理非會(huì)員邏輯",user,getUserId())
  //非會(huì)員邏輯
}

2.4 日志開關(guān)判斷

對(duì)于trace/debug這些比較低的日志級(jí)別，必須進(jìn)行日志級(jí)別的開關(guān)判斷。

User user = new User(666L, "公眾號(hào)", "撿田螺的小男孩");
if (log.isDebugEnabled()) {
    log.debug("userId is: {}", user.getId());
}

如果配置的日志級(jí)別是warn的話，上述日志不會(huì)打印，但是會(huì)執(zhí)行字符串拼接操作，如果symbol是對(duì)象， 還會(huì)執(zhí)行toString()方法，浪費(fèi)了系統(tǒng)資源，執(zhí)行了上述操作，最終日志卻沒有打印，因此建議加日志開關(guān)判斷。

2.5 建議使用日志框架SLF4J中的API

建議不要直接使用日志系統(tǒng)（Log4j、Logback）中的 API，而是使用日志框架SLF4J中的API。

SLF4J 是門面模式的日志框架，有利于維護(hù)和各個(gè)類的日志處理方式統(tǒng)一，并且可以在保證不修改代碼的情況下，很方便的實(shí)現(xiàn)底層日志框架的更換。

//使用 SLF4J：
import org.slf4j.Logger; 
import org.slf4j.LoggerFactory;
private static final Logger logger = LoggerFactory.getLogger(TianLuoBoy.class);

//使用 JCL：
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
private static final Log log = LogFactory.getLog(Test.class);

2.6  建議用參數(shù)占位{}代替“+拼接“

• 使用+操作符進(jìn)行字符串的拼接，有一定的性能損耗。
• 使用大括號(hào){}來作為日志中的占位符，比于使用+操作符，更加優(yōu)雅簡潔。并且，相對(duì)于反例，使用占位符僅是替換動(dòng)作，可以有效提升性能。

案例：

//反例
logger.info("Processing trade with id: " + id + " and symbol: " + symbol);

//正例
logger.info("Processing trade with id: {} and symbol : {} ", id, symbol); 

2.7 建議異步輸出日志

• 日志最終會(huì)輸出到文件或者其它輸出流中的，IO性能會(huì)有要求的。如果異步，就可以顯著提升IO性能。
• 除非有特殊要求，要不然建議使用異步的方式來輸出日志。以logback為例吧，要配置異步很簡單，使用AsyncAppender就行

如：

<appender name="FILE_ASYNC" class="ch.qos.logback.classic.AsyncAppender">
    <appender-ref ref="ASYNC"/>
</appender>

2.8 不要使用e.printStackTrace()

理由：

• e.printStackTrace()打印出的堆棧日志跟業(yè)務(wù)代碼日志是交錯(cuò)混合在一起的，通常排查異常日志不太方便。
• e.printStackTrace()語句產(chǎn)生的字符串記錄的是堆棧信息，如果信息太長太多，字符串常量池所在的內(nèi)存塊沒有空間了,即內(nèi)存滿了，那么，用戶的請(qǐng)求就卡住啦~

案例：

//正例

try{
  // 業(yè)務(wù)代碼處理
}catch(Exception e){
  log.error("你的程序有異常啦",e);
}


//反例
try{
  // 業(yè)務(wù)代碼處理
}catch(Exception e){
  e.printStackTrace();
}

2.9  異常日志要打印全面

反例1：

try {
 ? ?//業(yè)務(wù)代碼處理
} catch (Exception e) {
 ? ?// 錯(cuò)誤
 ? ?LOG.error('你的程序有異常啦');
} 

• 異常e都沒有打印出來，所以壓根不知道出了什么類型的異常。

反例2：

try {
 ? ?//業(yè)務(wù)代碼處理
} catch (Exception e) {
 ? ?// 錯(cuò)誤
 ? ?LOG.error('你的程序有異常啦：{}', e.getMessage());
} 

• e.getMessage()不會(huì)記錄詳細(xì)的堆棧異常信息，只會(huì)記錄錯(cuò)誤基本描述信息，不利于排查問題。

正例：

try {
 ? ?//業(yè)務(wù)代碼處理
} catch (Exception e) {
 ? ?// 錯(cuò)誤
 ? ?LOG.error('你的程序有異常啦:{}', e.getMessage());
} 

2.10 禁止在線上環(huán)境開啟 debug

因?yàn)橐话阆到y(tǒng)的debug日志會(huì)很多，并且各種框架中也大量使用 debug的日志，線上開啟debug不久可能會(huì)打滿磁盤，影響業(yè)務(wù)系統(tǒng)的正常運(yùn)行。

2.11 選擇合適的日志格式

在排查問題的時(shí)候，除了根據(jù)打印日志的關(guān)鍵字排查外，還有一個(gè)重要的信息就是時(shí)間節(jié)點(diǎn)。

理想的日志格式，應(yīng)當(dāng)包括這些最基本的信息：如當(dāng)前時(shí)間戳（一般毫秒精確度）、日志級(jí)別，線程名字等等。在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> 

2.12 不要打印又拋出相同異常信息

反例如下：

log.error("IO exception", e);
throw new MyException(e);

• 這樣實(shí)現(xiàn)的話，通常會(huì)把棧信息打印兩次。這是因?yàn)椴东@了MyException異常的地方，還會(huì)再打印一次。
• 這樣的日志記錄，或者包裝后再拋出去，不要同時(shí)使用！否則你的日志看起來會(huì)讓人很迷惑

2.13 避免重復(fù)打印日志

避免重復(fù)打印日志，醬紫會(huì)浪費(fèi)磁盤空間。如果你已經(jīng)有一行日志清楚表達(dá)了意思，避免再冗余打印，反例如下：

if(user.isVip()){
  log.info("該用戶是會(huì)員,Id:{}",user,getUserId());
  //冗余，可以跟前面的日志合并一起
  log.info("開始處理會(huì)員邏輯,id:{}",user,getUserId());
  //會(huì)員邏輯
}else{
  //非會(huì)員邏輯
}

如果你是使用log4j日志框架，務(wù)必在log4j.xml中設(shè)置 additivity=false，因?yàn)榭梢员苊庵貜?fù)打印日志。

2.14 日志文件分離

• 我們可以把不同類型的日志分離出去，比如access.log，或者error級(jí)別error.log，都可以單獨(dú)fen打印到一個(gè)文件里面。
• 當(dāng)然，也可以根據(jù)不同的業(yè)務(wù)模塊，打印到不同的日志文件里，這樣我們排查問題和做數(shù)據(jù)統(tǒng)計(jì)的時(shí)候，都會(huì)比較方便啦。

2.15 打印時(shí)禁止直接用 JSON 工具轉(zhuǎn)換對(duì)象

說明：如果對(duì)象里某些 get 方法被覆寫，存在拋出異常的情況，則可能會(huì)因?yàn)榇蛴∪罩径绊懻I(yè)務(wù)流程的執(zhí)行。

正例：打印日志時(shí)僅打印出業(yè)務(wù)相關(guān)屬性值或者調(diào)用其對(duì)象的 toString() 方法。

以上就是Java實(shí)現(xiàn)日志打印的15條新手建議的詳細(xì)內(nèi)容，更多關(guān)于Java日志打印建議的資料請(qǐng)關(guān)注腳本之家其它相關(guān)文章！