[[443186]]

 Spring Boot在所有內(nèi)部日志中使用Commons Logging，但是對底層日志的實現(xiàn)是開放的。在Spring Boot生態(tài)中，為Java Util Logging 、Log4J2 和Logback 這些常見的日志框架都提供了自動化配置組件，每種Logger都可以通過配置在控制臺或者文件中輸出日志內(nèi)容。默認(rèn)情況下，當(dāng)我們使用各種Starter的時候，會使用Logback來實現(xiàn)日志管理。

如何記日志

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

首先，在代碼層面，我們不糾結(jié)到底用默認(rèn)的Logback還是Log4j，而是直接用：Slf4j。

為什么不用管具體用Logback還是Log4j就可以去寫代碼呢?這個就是使用Slf4j好處!那么什么是Slf4j?英文全稱：Simple Logging Facade for Java，即：簡單日志門面，它并不是一個具體的日志解決方案，實際工作的還是Logback或Log4j這樣的日志框架。Slf4j是23種設(shè)計模式中門面模式的典型應(yīng)用案例，通過Slf4j這樣一個門面的抽象，讓我們在寫代碼的記錄日志的時候，只依賴這個抽象的操作，而具體實現(xiàn)會在Slf4j門面調(diào)用的時候委托給具體的實現(xiàn)日志記錄的框架。

比如：下面的就是一個簡單的使用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項目中引入了什么具體的日志框架決定，默認(rèn)情況下就是Logback。

日志元素

啟動任意一個Spring Boot項目，我們都可以在控制臺看到很多日志信息，比如下面這樣的一條日志：

日志的輸出內(nèi)容中一共有7種元素，具體如下：

• 時間日期：精確到毫秒
• 日志級別：ERROR, WARN, INFO, DEBUG or TRACE
• 進(jìn)程ID
• 分隔符：--- 標(biāo)識實際日志的開始
• 線程名：方括號括起來(可能會截斷控制臺輸出)
• Logger名：通常使用源代碼的類名
• 日志內(nèi)容

日志輸出

在Spring Boot應(yīng)用中，日志會默認(rèn)會輸出到控制臺中，默認(rèn)的輸出日志級別包含：ERROR、WARN和INFO，我們可以幫上面寫的Hello World例子跑起來，就可以驗證這樣的默認(rèn)設(shè)定：

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級別：

第一種：在運(yùn)行命令后加入--debug標(biāo)志，如：$ java -jar myapp.jar --debug

第二種：在配置文件application.properties中配置debug=true

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

日志配置

下面介紹一些常用的日志配置，以幫助我們更好的管理好日志內(nèi)容。

多彩輸出

如果你的終端支持ANSI，設(shè)置彩色輸出會讓日志更具可讀性。通過在application.properties中設(shè)置spring.output.ansi.enabled參數(shù)來支持，該參數(shù)有三個選項：

• NEVER：禁用ANSI-colored輸出
• DETECT：會檢查終端是否支持ANSI，是的話就采用彩色輸出(默認(rèn)項)
• ALWAYS：總是使用ANSI-colored格式輸出，若終端不支持的時候，會有很多干擾信息，不推薦使用

注意：Spring Boot 1.x的時候，默認(rèn)值為NEVER，2.x之后默認(rèn)為DETECT，所以看我們上面的截圖，默認(rèn)就已經(jīng)帶有顏色了。所以如果是Spring Boot 2.x版本用戶的話，這個基本就不用去修改了。

文件輸出

Spring Boot默認(rèn)配置只會輸出到控制臺，并不會記錄到文件中，但是我們通常生產(chǎn)環(huán)境使用時都需要以文件方式記錄。

若要增加文件輸出，需要在配置文件application.properties配置幾個參數(shù)，比如這樣：

logging.file.name=run.log 
logging.file.path=./ 

• logging.file.name：設(shè)置文件名
• logging.file.path：設(shè)置文件路徑

注意：這里跟1.x版本有區(qū)別，1.x的時候分別對應(yīng)的參數(shù)為logging.file和logging.path。

文件滾動

一直把日志輸出在一個文件里顯然是不合適的，任何一個日志框架都會為此準(zhǔn)備日志文件的滾動配置。由于本篇將默認(rèn)配置，所以就是Logback的配置，具體有這幾個：

• logging.logback.rollingpolicy.file-name-pattern：用于創(chuàng)建日志檔案的文件名模式。
• logging.logback.rollingpolicy.clean-history-on-start：應(yīng)用程序啟動時是否對進(jìn)行日志歸檔清理，默認(rèn)為false，不清理
• logging.logback.rollingpolicy.max-history：要保留的最大歸檔日志文件數(shù)量，默認(rèn)為7個
• logging.logback.rollingpolicy.max-file-size：歸檔前日志文件的最大尺寸，默認(rèn)為10MB
• logging.logback.rollingpolicy.total-size-cap：日志檔案在被刪除前的最大容量，默認(rèn)為0B

級別控制

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

配置格式：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級別輸出

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

logging.level.com.didispace=DEBUG

自定義日志配置

由于日志服務(wù)一般都在ApplicationContext創(chuàng)建前就初始化了，它并不是必須通過Spring的配置文件控制。因此通過系統(tǒng)屬性和傳統(tǒng)的Spring Boot外部配置文件依然可以很好的支持日志控制和管理。

根據(jù)不同的日志系統(tǒng)，你可以按如下規(guī)則組織配置文件名，就能被正確加載：

• 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官方推薦優(yōu)先使用帶有-spring的文件名作為你的日志配置(如使用logback-spring.xml，而不是logback.xml)

自定義輸出格式

在Spring Boot中可以通過在application.properties配置如下參數(shù)控制輸出格式：

• logging.pattern.console：定義輸出到控制臺的樣式(不支持JDK Logger)
• logging.pattern.file：定義輸出到文件的樣式(不支持JDK Logger)

本文的完整工程可以查看下面?zhèn)}庫中2.x目錄下的chapter8-1工程：

Github：https://github.com/dyc87112/SpringBoot-Learning/

Gitee：https://gitee.com/didispace/SpringBoot-Learning/