Spring Boot 2 中的默認日志管理與 Logback 配置詳解

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就可以被成功輸出了，

自定義日志配置

由于日志服務一般都在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工程：

• Github：https://github.com/dyc87112/SpringBoot-Learning/
• Gitee：https://gitee.com/didispace/SpringBoot-Learning/

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

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

標籤：Java

上一篇：微服務 Spring Cloud 2020 重大變革

下一篇：【計題01組02號】LeetCode——佇列 & 堆疊