SpringBoot 實戰 (七) | 預設日誌配置

一個優秀的廢人發表於2019-02-18
Spring Boot

微信公眾號：一個優秀的廢人 如有問題或建議，請後臺留言，我會盡力解決你的問題。

前言

如題，今天介紹 springboot 預設日誌的配置。

預設日誌 Logback

預設情況下，Spring Boot 用 Logback 來記錄日誌，並用 INFO 級別輸出到控制檯。如果你在平常專案中用過 Spring Boot，你應該已經注意到很多 INFO 級別的日誌了。預設日誌長這樣：

2019-02-18 22:02:14.907  INFO 23384 --- [           main] org.hibernate.Version                    : HHH000412: Hibernate Core {5.3.7.Final}
2019-02-18 22:02:14.907  INFO 23384 --- [           main] org.hibernate.cfg.Environment            : HHH000206: hibernate.properties not found
2019-02-18 22:02:15.110  INFO 23384 --- [           main] o.hibernate.annotations.common.Version   : HCANN000001: Hibernate Commons Annotations {5.0.4.Final}
複製程式碼

從上面的日誌可以看到，日誌輸出內容元素具體如下：

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

日誌依賴

Logback 日誌框架依賴於 spring-boot-starter-logging 包，但我們並不需要在 maven 中加入這個依賴，因為 spring-boot-starter其中包含了 spring-boot-starter-logging，該依賴內容就是 Spring Boot 預設的日誌框架 logback。

控制檯輸出

在 Spring Boot 中預設配置了 ERROR、WARN 和 INFO 級別的日誌輸出到控制檯。

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

  • 在執行命令後加入 --debug 標誌，如：$ java -jar myapp.jar --debug
  • 在 application.properties 中配置 debug=true ，該屬性置為 true 的時候，核心 Logger（包含嵌入式容器、hibernate、spring）會輸出更多內容，但是你自己應用的日誌並不會輸出為 DEBUG 級別。

多彩輸出

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

  • NEVER：禁用 ANSI-colored 輸出（預設項）
  • DETECT：會檢查終端是否支援 ANSI，是的話就採用彩色輸出（推薦項）
  • ALWAYS：總是使用 ANSI-colored 格式輸出，若終端不支援的時候，會有很多干擾資訊，不推薦使用

檔案輸出

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

若要增加檔案輸出，需要在 application.properties 中配置 logging.file 或 logging.path屬性。

logging.file，設定檔案，可以是絕對路徑，也可以是相對路徑。如：logging.file=my.log logging.path，設定目錄，會在該目錄下建立spring.log檔案，並寫入日誌內容，如：logging.path=/var/log

注：二者不能同時使用，如若同時使用，則只有logging.file生效 預設情況下，日誌檔案的大小達到 10MB 時會切分一次，產生新的日誌檔案，預設級別為：ERROR、WARN、INFO

級別控制

在 Spring Boot 中只需要在 application.properties 中進行配置完成日誌記錄的級別控制。

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

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

舉例：

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

自定義日誌配置

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

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

Spring Boot 官方推薦優先使用帶有 -spring 的檔名作為你的日誌配置（如使用 logback-spring.xml，而不是 logback.xml），命名為 logback-spring.xml 的日誌配置檔案，spring boot 可以為它新增一些 spring boot 特有的配置項（下面會提到）。 預設的命名規則，並且放在 src/main/resources 下面即可

如果你即想完全掌控日誌配置，但又不想用 logback.xml 作為 Logback 配置的名字，application.yml 可以通過 logging.config 屬性指定自定義的名字：

logging.config=classpath:logging-config.xml
複製程式碼

雖然一般並不需要改變配置檔案的名字，但是如果你想針對不同執行時 Profile 使用不同的日誌配置，這個功能會很有用。

一般不需要這個屬性，而是直接在 logback-spring.xml 中使用 springProfile 配置，不需要 logging.config 指定不同環境使用不同配置檔案。springProfile 配置在下面介紹。

多環境日誌輸出

logback-spring.xml :

<configuration>
    ...

    <!-- 測試環境+開發環境. 多個使用逗號隔開. -->
    <springProfile name="test,dev">
        <logger name="com.example.demo.controller" level="DEBUG" additivity="false">
            <appender-ref ref="consoleLog"/>
        </logger>
    </springProfile>

    <!-- 生產環境. -->
    <springProfile name="prod">
        <logger name="com.example.demo.controller" level="INFO" additivity="false">
            <appender-ref ref="consoleLog"/>
        </logger>
    </springProfile>
</configuration>
複製程式碼

application.yml 增加環境選擇的配置 active: dev

spring:
  profiles:
    active: dev
  datasource:
    url: jdbc:mysql://localhost:3306/test?characterEncoding=utf8
    username: root
    password: 123456
複製程式碼

根據 active 的環境，自動採用上面配置的 springProfile 的 logger 日誌。

後語

以上 SpringBoot 預設日誌的配置教程。最後，對 Python 、Java 感興趣請長按二維碼關注一波，我會努力帶給你們價值，如果覺得本文對你哪怕有一丁點幫助，請幫忙點好看，讓更多人知道。

另外，關注之後在傳送 1024 可領取免費學習資料。資料內容詳情請看這篇舊文：Python、C++、Java、Linux、Go、前端、演算法資料分享

一個優秀的廢人

相關文章