天啦擼！列印日誌竟然只曉得 Log4j？

空了的時候，我都會在群裡偷偷摸摸地潛水，對小夥伴們的一舉一動、一言一行篩查診斷。一副班主任的即時感，讓我感到非常的快樂，略微夾帶一絲絲的枯燥。

這不，我在戰國時代讀者群裡發現了這麼一串聊天記錄：

竟然有小夥伴不知道“打日誌”是什麼意思，不知道該怎麼學習，還有小夥伴回答說，只知道 Log4j！

有那麼一刻，我遭受到了一萬點暴擊，內心莫名的傷感，猶如一匹垂頭喪氣的狗。因為網路上總有一些不懷好意的人不停地攻擊我，說我寫的文章入門，毫無深度——他們就是我命中註定的黑子，不信你到脈脈上搜“沉默王二”，就能看到他們毫無新意的抨擊。

我就想問一下，怎麼了，入門的文章有入門的群體需要，而我恰好幫助了這麼一大批初學者，我應該受到褒獎好不好？

（說好的不在乎，怎麼在乎起來了呢？手動狗頭）

管他呢，我行我素吧，保持初心不改就對了！這篇文章就來說說 Log4j，這個列印日誌的鼻祖。Java 中的日誌列印其實是個藝術活，我保證，這句話絕不是忽悠。

事實證明，列印日誌絕逼會影響到程式的效能，這是不可否認的，畢竟多做了一項工作。尤其是在交易非常頻繁的程式裡，湧現大量的日誌確實會比較低效。

基於效能上的考量，小夥伴們很有必要認認真真地學習一下如何優雅地列印 Java 日誌。畢竟，效能是一個程式設計師優不優秀的重要考量。

01、為什麼需要在 Java 中列印日誌

System.out.println() 恐怕是我們在學習 Java 的時候，最常用的一種列印日誌的方式了，幾乎每個 Java 初學者都這樣幹過，甚至一些老鳥。

之所以這樣列印日誌，是因為很方便，上手難度很低，尤其是在 IDEA 的幫助下，只需在鍵盤上按下 so 兩個字母就可以調出 System.out.println()。

在本地環境下，使用 System.out.println() 列印日誌是沒問題的，可以在控制檯看到資訊。但如果是在生產環境下的話，System.out.println() 就變得毫無用處了。

控制檯列印出的資訊並沒有儲存到日誌檔案中，只能即時檢視，在一屏日誌的情況下還可以接受。如果日誌量非常大，控制檯根本就裝不下。所以就需要更高階的日誌記錄 API（比如 Log4j 和 java.util.logging）。

它們可以把大量的日誌資訊儲存到檔案中，並且控制每個檔案的大小，如果滿了，就儲存到下一個，方便查詢。

02、選擇不同日誌級別的重要性

使用 Java 日誌的時候，一定要注意日誌的級別，比如常見的 DEBUG、INFO、WARN 和 ERROR。

DEBUG 的級別最低，當需要列印除錯資訊的話，就用這個級別，不建議在生產環境下使用。

INFO 的級別高一些，當一些重要的資訊需要列印的時候，就用這個。

WARN，用來記錄一些警告類的資訊，比如說客戶端和服務端的連線斷開了，資料庫連線丟失了。

ERROR 比 WARN 的級別更高，用來記錄錯誤或者異常的資訊。

FATAL，當程式出現致命錯誤的時候使用，這意味著程式可能非正常中止了。

OFF，最高階別，意味著所有訊息都不會輸出了。

這個級別是基於 Log4j 的，和 java.util.logging 有所不同，後者提供了更多的日誌級別，比如說 SEVERE、FINER、FINEST。

03、錯誤的日誌記錄方式是如何影響效能的

為什麼說錯誤的日誌記錄方式會影響程式的效能呢？因為日誌記錄的次數越多，意味著執行檔案 IO 操作的次數就越多，這也就意味著會影響到程式的效能，能 get 吧？

雖然說普通硬碟升級到固態硬碟後，讀寫速度快了很多，但磁碟相對於記憶體和 CPU 來說，還是太慢了！就像馬車和賓士之間的速度差距。

這也就是為什麼要選擇日誌級別的重要性。對於程式來說，記錄日誌是必選項，所以能控制的就是日誌的級別，以及在這個級別上列印的日誌。

對於 DEBUG 級別的日誌來說，一定要使用下面的方式來記錄：

if(logger.isDebugEnabled()){ 
    logger.debug("DEBUG 是開啟的"); 
} 

當 DEBUG 級別是開啟的時候再列印日誌，這種方式在你看很多原始碼的時候就可以發現，很常見。

切記，在生產環境下，一定不要開啟 DEBUG 級別的日誌，否則程式在大量記錄日誌的時候會變很慢，還有可能在你不注意的情況下，悄悄地把磁碟空間撐爆。

04、為什麼選擇 Log4j 而不是 java.util.logging

java.util.logging 屬於原生的日誌 API，Log4j 屬於第三方類庫，但我建議使用 Log4j，因為 Log4j 更好用。java.util.logging 的日誌級別比 Log4j 更多，但用不著，就變成了多餘。

Log4j 的另外一個好處就是，不需要重新啟動 Java 程式就可以調整日誌的記錄級別，非常靈活。可以通過 log4j.properties 檔案來配置 Log4j 的日誌級別、輸出環境、日誌檔案的記錄方式。

Log4j 還是執行緒安全的，可以在多執行緒的環境下放心使用。

先來看一下 java.util.logging 的使用方式：

package com.itwanger;

import java.io.IOException;
import java.util.logging.FileHandler;
import java.util.logging.Logger;
import java.util.logging.SimpleFormatter;

/**
 * @author 微信搜「沉默王二」，回覆關鍵字 PDF
 */
public class JavaUtilLoggingDemo {
    public static void main(String[] args) throws IOException {
        Logger logger = Logger.getLogger("test");
        FileHandler fileHandler = new FileHandler("javautillog.txt");
        fileHandler.setFormatter(new SimpleFormatter());
        logger.addHandler(fileHandler);
        logger.info("細小的資訊");
    }
}

程式執行後會在 target 目錄下生成一個名叫 javautillog.txt 的檔案，內容如下所示：

再來看一下 Log4j 的使用方式。

第一步，在 pom.xml 檔案中引入 Log4j 包：

<dependency>
    <groupId>log4j</groupId>
    <artifactId>log4j</artifactId>
    <version>1.2.17</version>
</dependency>

第二步，在 resources 目錄下建立 log4j.properties 檔案，內容如下所示：

### 設定###
log4j.rootLogger = debug,stdout,D,E

### 輸出資訊到控制檯 ###
log4j.appender.stdout = org.apache.log4j.ConsoleAppender
log4j.appender.stdout.Target = System.out
log4j.appender.stdout.layout = org.apache.log4j.PatternLayout
log4j.appender.stdout.layout.ConversionPattern = [%-5p] %d{yyyy-MM-dd HH:mm:ss,SSS} method:%l%n%m%n

### 輸出DEBUG 級別以上的日誌到=debug.log ###
log4j.appender.D = org.apache.log4j.DailyRollingFileAppender
log4j.appender.D.File = debug.log
log4j.appender.D.Append = true
log4j.appender.D.Threshold = DEBUG 
log4j.appender.D.layout = org.apache.log4j.PatternLayout
log4j.appender.D.layout.ConversionPattern = %d{yyyy-MM-dd HH:mm:ss}  [ %t:%r ] - [ %p ]  %m%n

### 輸出ERROR 級別以上的日誌到=error.log ###
log4j.appender.E = org.apache.log4j.DailyRollingFileAppender
log4j.appender.E.File =error.log 
log4j.appender.E.Append = true
log4j.appender.E.Threshold = ERROR 
log4j.appender.E.layout = org.apache.log4j.PatternLayout
log4j.appender.E.layout.ConversionPattern = %d{yyyy-MM-dd HH:mm:ss}  [ %t:%r ] - [ %p ]  %m%n

1）配置根 Logger，語法如下所示：

log4j.rootLogger = [ level ] , appenderName, appenderName, …

level 就是日誌的優先順序，從高到低依次是 ERROR、WARN、INFO、DEBUG。如果這裡定義的是 INFO，那麼低階別的 DEBUG 日誌資訊將不會列印出來。

appenderName 就是指把日誌資訊輸出到什麼地方，可以指定多個地方，當前的配置檔案中有 3 個地方，分別是 stdout、D、E。

2）配置日誌輸出的目的地，語法如下所示：

log4j.appender.appenderName = fully.qualified.name.of.appender.class  
log4j.appender.appenderName.option1 = value1  
…  
log4j.appender.appenderName.option = valueN

Log4j 提供的目的地有下面 5 種：

• org.apache.log4j.ConsoleAppender：控制檯
• org.apache.log4j.FileAppender：檔案
• org.apache.log4j.DailyRollingFileAppender：每天產生一個檔案
• org.apache.log4j.RollingFileAppender：檔案大小超過閾值時產生一個新檔案
• org.apache.log4j.WriterAppender：將日誌資訊以流格式傳送到任意指定的地方

3）配置日誌資訊的格式，語法如下所示：

log4j.appender.appenderName.layout = fully.qualified.name.of.layout.class  
log4j.appender.appenderName.layout.option1 = value1  
…  
log4j.appender.appenderName.layout.option = valueN

Log4j 提供的格式有下面 4 種：

• org.apache.log4j.HTMLLayout：HTML 表格
• org.apache.log4j.PatternLayout：自定義
• org.apache.log4j.SimpleLayout：包含日誌資訊的級別和資訊字串
• org.apache.log4j.TTCCLayout：包含日誌產生的時間、執行緒、類別等等資訊

自定義格式的引數如下所示：

• %m：輸出程式碼中指定的訊息
• %p：輸出優先順序
• %r：輸出應用啟動到輸出該日誌資訊時花費的毫秒數
• %c：輸出所在類的全名
• %t：輸出該日誌所在的執行緒名
• %n：輸出一個回車換行符
• %d：輸出日誌的時間點
• %l：輸出日誌的發生位置，包括類名、執行緒名、方法名、程式碼行數，比如：method:com.itwanger.Log4jDemo.main(Log4jDemo.java:14)

第三步，寫個使用 Demo：

package com.itwanger;

import org.apache.log4j.LogManager;
import org.apache.log4j.Logger;

/**
 * @author 微信搜「沉默王二」，回覆關鍵字 PDF
 */
public class Log4jDemo {
    private static final Logger logger = LogManager.getLogger(Log4jDemo.class);

    public static void main(String[] args) {
        // 記錄debug級別的資訊
        logger.debug("debug.");

        // 記錄info級別的資訊
        logger.info("info.");

        // 記錄error級別的資訊
        logger.error("error.");
    }
}

1）獲取 Logger 物件

要使用 Log4j 的話，需要先獲取到 Logger 物件，它用來負責日誌資訊的列印。通常的格式如下所示：

private static final Logger logger = LogManager.getLogger(Log4jDemo.class);

2）列印日誌

有了 Logger 物件後，就可以按照不同的優先順序列印日誌了。常見的有以下 4 種：

Logger.debug() ;  
Logger.info() ;  
Logger.warn() ;  
Logger.error() ;

程式執行後會在 target 目錄下生成兩個檔案，一個名叫 debug.log，內容如下所示：

2020-10-20 20:53:27  [ main:0 ] - [ DEBUG ]  debug.
2020-10-20 20:53:27  [ main:3 ] - [ INFO ]  info.
2020-10-20 20:53:27  [ main:3 ] - [ ERROR ]  error.

另外一個名叫 error.log，內容如下所示：

2020-10-20 20:53:27  [ main:3 ] - [ ERROR ]  error.

05、列印日誌的 8 個小技巧

1）在列印 DEBUG 級別的日誌時，切記要使用 isDebugEnabled()！那小夥伴們肯定非常好奇，為什麼要這樣做呢？

先來看一下 isDebugEnabled() 方法的原始碼：

  public
  boolean isDebugEnabled() {
    if(repository.isDisabled( Level.DEBUG_INT))
      return false;
    return Level.DEBUG.isGreaterOrEqual(this.getEffectiveLevel());
  }

內部使用了 isDisabled() 方法進行了日誌級別的判斷，如果 DEBUG 是禁用的話，就 return false 了。

再來看一下 debug() 方法的原始碼：

  public
  void debug(Object message) {
    if(repository.isDisabled(Level.DEBUG_INT))
      return;
    if(Level.DEBUG.isGreaterOrEqual(this.getEffectiveLevel())) {
      forcedLog(FQCN, Level.DEBUG, message, null);
    }
  }

咦，不是也用 isDisabled() 方法判斷嗎？難道使用 isDebugEnabled()不是畫蛇添足嗎？直接用 logger.debug() 不香嗎？我來給小夥伴們解釋下。

如果我們在列印日誌資訊的時候需要附帶一個方法去獲取引數值，就像下面這樣：

logger.debug("使用者名稱是：" + getName());

假如 getName() 方法需要耗費的時間長達 6 秒，那完了！儘管配置檔案裡的日誌級別定義的是 INFO，getName() 方法仍然會倔強地執行 6 秒，完事後再 debug()，這就很崩了！

明明 INFO 的時候 debug() 是不執行的，意味著 getName() 也不需要執行的，偏偏就執行了 6 秒，是不是很傻？

if(logger.isDebugEnabled()) {
    logger.debug("使用者名稱是：" + getName());
}

換成上面這種方式，那確定此時 getName() 是不執行的，對吧？

為了程式效能上的考量，isDebugEnabled() 就變得很有必要了！假如說 debug() 的時候沒有傳參，確實是不需要判斷 DEBUG 是否啟用的。

2）慎重選擇日誌資訊的列印級別，因為這太重要了！如果只能通過日誌檢視程式發生了什麼問題，那必要的資訊是必須要列印的，但列印得太多，又會影響到程式的效能。

所以，該 INFO 的 info()，該 DEBUG 的 debug()，不要隨便用。

3）使用 Log4j 而不是 System.out、System.err 或者 e.printStackTrace() 來列印日誌，原因之前講過了，就不再贅述了。

4）使用 log4j.properties 檔案來配置日誌，儘管它不是必須項，使用該檔案會讓程式變得更靈活，有一種我的地盤我做主的味道。

5）不要忘記在列印日誌的時候帶上類的全名和執行緒名，在多執行緒環境下，這點尤為重要，否則定位問題的時候就太難了。

6）列印日誌資訊的時候儘量要完整，不要太過於預設，尤其是在遇到異常或者錯誤的時候（資訊要保留兩類：案發現場資訊和異常堆疊資訊，如果不做處理，通過 throws 關鍵字往上拋），免得在找問題的時候都是一些無用的日誌資訊。

7）要對日誌資訊加以區分，把某一類的日誌資訊在輸出的時候加上字首，比如說所有資料庫級別的日誌裡新增 DB_LOG，這樣的日誌非常大的時候可以通過 grep 這樣的 Linux 命令快速定位。

8）不要在日誌檔案中列印密碼、銀行賬號等敏感資訊。

06、 總結

列印日誌真的是一種藝術活，搞不好會嚴重影響伺服器的效能。最可怕的是，記錄了日誌，但最後發現屁用沒有，那簡直是蒼了個天啊！尤其是在生產環境下，問題沒有記錄下來，但重現有一定的隨機性，到那時候，真的是叫天天不應，叫地地不靈啊！

嗯哼，其實我已經寫完了整個日誌系統，包括 Log4j、 SLF4J、Logback、Log4j 它弟 Log4j 2，但我覺得分開來發的話，更利於 SEO（瞧我這為了流量的心機，手動狗頭）。如果你確實需要看完整版的話，我也貼心地為你準備了，點選下面的連結就可以下載 PDF：

https://pan.baidu.com/s/1dPwsQhT5OMVapE7hGi7vww 提取碼:fxxy

碼字不易，日常求個贊吧，動一動金手指，bug 少一個（逃。