Spring Boot 2 中的預設日誌管理與 Logback 配置詳解

程式猿DD發表於2021-12-30
Spring Boot

Spring Boot在所有內部日誌中使用Commons Logging，但是對底層日誌的實現是開放的。在Spring Boot生態中，為Java Util Logging 、Log4J2 和Logback 這些常見的日誌框架都提供了自動化配置元件，每種Logger都可以通過配置在控制檯或者檔案中輸出日誌內容。預設情況下，當我們使用各種Starter的時候，會使用Logback來實現日誌管理。

如何記日誌

在介紹寫日誌的方式有很多，這裡就不對各種方式做羅列了，只講DD用得最多的方式！

首先，在程式碼層面，我們不糾結到底用預設的Logback還是Log4j，而是直接用：Slf4j。

為什麼不用管具體用Logback還是Log4j就可以去寫程式碼呢？這個就是使用Slf4j好處，為什麼是Slf4j？英文全稱：Simple Logging Facade for Java，即：簡單日誌門面，它並不是一個具體的日誌解決方案，實際工作的還是Logback或Log4j這樣的日誌框架。Slf4j就是23種設計模式中門面模式的典型應用案例。通過Slf4j這樣一個門面的抽象存在，讓我們在寫程式碼的之後，只依賴這個抽象的日誌操作，而具體的實現會在Slf4j門面呼叫的時候委託給具體的實現。

比如下面的就是一個簡單的日誌記錄例子：

@Slf4j
@SpringBootApplication
public class Application {

    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);

        log.error("Hello World");
        log.warn("Hello World");
        log.info("Hello World");
        log.debug("Hello World");
        log.trace("Hello World");
    }

}

注意：這裡我們通過在pom.xml中引入了Lombok，然後使用@Slf4j宣告引入Slf4j的log日誌記錄物件，之後就可以輕鬆的用它來日誌了。而這個日誌具體是如何寫到控制檯或者檔案的，則有Spring Boot專案中引入了什麼具體的日誌框架決定，預設情況下就是Logback。

日誌元素

啟動任意一個Spring Boot專案，我們都可以在控制檯看到很多日誌資訊，比如下面這樣的一條日誌：

日誌的輸出內容中一共有7種元素，具體如下：

  1. 時間日期：精確到毫秒
  2. 日誌級別：ERROR, WARN, INFO, DEBUG or TRACE
  3. 程式ID
  4. 分隔符：--- 標識實際日誌的開始
  5. 執行緒名：方括號括起來（可能會截斷控制檯輸出）
  6. Logger名：通常使用原始碼的類名
  7. 日誌內容

日誌輸出

在Spring Boot應用中，日誌會預設會輸出到控制檯中，預設的輸出日誌級別包含：ERROR、WARN和INFO，我們可以幫上面寫的Hello World例子跑起來，就可以驗證這樣的預設設定：

2021-12-28 17:37:25.578  INFO 65136 --- [           main] com.didispace.chapter81.Application      : Started Application in 2.695 seconds (JVM running for 3.957)
2021-12-28 17:37:25.579 ERROR 65136 --- [           main] com.didispace.chapter81.Application      : Hello World
2021-12-28 17:37:25.579  WARN 65136 --- [           main] com.didispace.chapter81.Application      : Hello World
2021-12-28 17:37:25.579  INFO 65136 --- [           main] com.didispace.chapter81.Application      : Hello World

開啟DEBUG日誌

我們可以通過兩種方式切換至DEBUG級別：

第一種：在執行命令後加入--debug標誌，如：$ java -jar myapp.jar --debug

第二種：在配置檔案application.properties中配置debug=true

這裡開啟的DEBUG日誌，僅影響核心Logger，包含嵌入式容器、hibernate、spring等這些框架層面的會輸出更多內容，但是你自己應用的日誌並不會輸出為DEBUG級別，從下面的截圖中我們就可以看到，我們自己編寫的debug級別的Hello
World並沒有輸出。

日誌配置

下面介紹一些常用的日誌配置，以幫助我們更好的管理好日誌內容。

多彩輸出

如果你的終端支援ANSI，設定彩色輸出會讓日誌更具可讀性。通過在application.properties中設定spring.output.ansi.enabled引數來支援，該引數有三個選項：

  • NEVER：禁用ANSI-colored輸出
  • DETECT：會檢查終端是否支援ANSI，是的話就採用彩色輸出（預設項）
  • ALWAYS：總是使用ANSI-colored格式輸出，若終端不支援的時候，會有很多干擾資訊，不推薦使用
注意：Spring Boot 1.x的時候，預設值為NEVER，2.x之後預設為DETECT，所以看我們上面的截圖，預設就已經帶有顏色了。所以如果是Spring Boot 2.x版本使用者的話，這個基本就不用去修改了。

檔案輸出

Spring Boot預設配置只會輸出到控制檯，並不會記錄到檔案中，但是我們通常生產環境使用時都需要以檔案方式記錄。

若要增加檔案輸出，需要在配置檔案application.properties配置幾個引數，比如這樣：

logging.file.name=run.log
logging.file.path=./
  • logging.file.name：設定檔名
  • logging.file.path：設定檔案路徑
注意：這裡跟1.x版本有區別，1.x的時候分別對應的引數為logging.file和logging.path。

檔案滾動

一直把日誌輸出在一個檔案裡顯然是不合適的，任何一個日誌框架都會為此準備日誌檔案的滾動配置。由於本篇將預設配置，所以就是Logback的配置，具體有這幾個：

  • logging.logback.rollingpolicy.file-name-pattern：用於建立日誌檔案的檔名模式。
  • logging.logback.rollingpolicy.clean-history-on-start：應用程式啟動時是否對進行日誌歸檔清理，預設為false，不清理
  • logging.logback.rollingpolicy.max-history：要保留的最大歸檔日誌檔案數量，預設為7個
  • logging.logback.rollingpolicy.max-file-size：歸檔前日誌檔案的最大尺寸，預設為10MB
  • logging.logback.rollingpolicy.total-size-cap：日誌檔案在被刪除前的最大容量，預設為0B

級別控制

如果要對各個Logger做一些簡單的輸出級別控制，那麼只需要在application.properties中進行配置就能完成。

配置格式：logging.level.*=LEVEL

  • logging.level：日誌級別控制字首，*為包名或Logger名
  • LEVEL：選項TRACE, DEBUG, INFO, WARN, ERROR, FATAL, OFF

舉例：

  • logging.level.com.didispace=DEBUG：com.didispace包下所有class以DEBUG級別輸出
  • logging.level.root=WARN：root日誌以WARN級別輸出

做了這樣的配置之後，可以再執行下上面的程式，原本debug級別的Hello World就可以被成功輸出了。

logging.level.com.didispace=DEBUG

自定義日誌配置

由於日誌服務一般都在ApplicationContext建立前就初始化了，它並不是必須通過Spring的配置檔案控制。因此通過系統屬性和傳統的Spring Boot外部配置檔案依然可以很好的支援日誌控制和管理。

根據不同的日誌系統，你可以按如下規則組織配置檔名，就能被正確載入：

  • Logback：logback-spring.xml, logback-spring.groovy, logback.xml, logback.groovy
  • Log4j2：log4j2-spring.xml, log4j2.xml
  • JDK (Java Util Logging)：logging.properties

Spring Boot官方推薦優先使用帶有-spring的檔名作為你的日誌配置（如使用logback-spring.xml，而不是logback.xml）

自定義輸出格式

在Spring Boot中可以通過在application.properties配置如下引數控制輸出格式：

  • logging.pattern.console：定義輸出到控制檯的樣式（不支援JDK Logger）
  • logging.pattern.file：定義輸出到檔案的樣式（不支援JDK Logger）

好了，今天的學習就到這裡！如果您學習過程中如遇困難？可以加入我們超高質量的Spring技術交流群，參與交流與討論，更好的學習與進步！彙總頁面《Spring Boot基礎教程》可以點選直達！，歡迎收藏與轉發支援！

程式碼示例

本文的完整工程可以檢視下面倉庫中2.x目錄下的chapter8-1工程：

如果您覺得本文不錯，歡迎Star支援，您的關注是我堅持的動力！

歡迎關注我的公眾號：程式猿DD。第一時間瞭解前沿行業訊息、分享深度技術乾貨、獲取優質學習資源

相關文章