Spring Boot:(七)預設日誌logback配置解析
前言
今天來介紹下Spring Boot如何配置日誌logback,我們帶著下面幾個問題來學習。
- 如何引入日誌?
- 日誌輸出格式以及輸出方式如何配置?
- 程式碼中如何使用?
正文
Spring Boot在所有內部日誌中使用Commons Logging,但是預設配置也提供了對常用日誌的支援,如:Java Util Logging,Log4J, Log4J2和Logback。每種Logger都可以通過配置使用控制檯或者檔案輸出日誌內容。
預設日誌Logback
SLF4J——Simple Logging Facade For Java,它是一個針對於各類Java日誌框架的統一Facade抽象。Java日誌框架眾多——常用的有java.util.logging
log4j
, logback
,commons-logging
, Spring框架使用的是Jakarta Commons Logging API (JCL)。而SLF4J定義了統一的日誌抽象介面,而真正的日誌實現則是在執行時決定的——它提供了各類日誌框架的binding。Logback是log4j框架的作者開發的新一代日誌框架,它效率更高、能夠適應諸多的執行環境,同時天然支援SLF4J。
預設情況下,Spring Boot會用Logback來記錄日誌,並用INFO級別輸出到控制檯。在執行應用程式和其他例子時,你應該已經看到很多INFO級別的日誌了。
從上圖可以看到,日誌輸出內容元素具體如下:
- 時間日期:精確到毫秒
- 日誌級別:ERROR, WARN, INFO, DEBUG or TRACE
- 程序ID
- 分隔符:
---
標識實際日誌的開始 - 執行緒名:方括號括起來(可能會截斷控制檯輸出)
- Logger名:通常使用原始碼的類名
- 日誌內容
新增日誌依賴
假如maven依賴中添加了spring-boot-starter-logging:
1 2 3 4 | <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-logging</artifactId |
那麼,我們的Spring Boot應用將自動使用logback作為應用日誌框架,Spring Boot啟動的時候,由org.springframework.boot.logging.Logging-Application-Listener根據情況初始化並使用。
但是呢,實際開發中我們不需要直接新增該依賴,你會發現spring-boot-starter其中包含了 spring-boot-starter-logging,該依賴內容就是 Spring Boot 預設的日誌框架 logback。而博主這次專案的例子是基於上一篇的,工程中有用到了Thymeleaf,而Thymeleaf依賴包含了spring-boot-starter,最終我只要引入Thymeleaf即可。
1 2 3 4 | <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-thymeleaf</artifactId> </dependency> |
預設配置屬性支援
Spring Boot為我們提供了很多預設的日誌配置,所以,只要將spring-boot-starter-logging作為依賴加入到當前應用的classpath,則“開箱即用”。
下面介紹幾種在application.properties就可以配置的日誌相關屬性。
控制檯輸出
日誌級別從低到高分為TRACE < DEBUG < INFO < WARN < ERROR < FATAL,如果設定為WARN,則低於WARN的資訊都不會輸出。
Spring Boot中預設配置ERROR
、WARN
和INFO
級別的日誌輸出到控制檯。您還可以通過啟動您的應用程式–debug標誌來啟用“除錯”模式(開發的時候推薦開啟),以下兩種方式皆可:
- 在執行命令後加入
--debug
標誌,如:$ java -jar springTest.jar --debug
- 在
application.properties
中配置debug=true
,該屬性置為true的時候,核心Logger(包含嵌入式容器、hibernate、spring)會輸出更多內容,但是你自己應用的日誌並不會輸出為DEBUG級別。
檔案輸出
預設情況下,Spring Boot將日誌輸出到控制檯,不會寫到日誌檔案。如果要編寫除控制檯輸出之外的日誌檔案,則需在application.properties中設定logging.file或logging.path屬性。
- logging.file,設定檔案,可以是絕對路徑,也可以是相對路徑。如:
logging.file=my.log
- logging.path,設定目錄,會在該目錄下建立spring.log檔案,並寫入日誌內容,如:
logging.path=/var/log
如果只配置 logging.file,會在專案的當前路徑下生成一個 xxx.log 日誌檔案。
如果只配置 logging.path,在 /var/log資料夾生成一個日誌檔案為 spring.log
注:二者不能同時使用,如若同時使用,則只有logging.file生效
預設情況下,日誌檔案的大小達到10MB時會切分一次,產生新的日誌檔案,預設級別為:ERROR、WARN、INFO
級別控制
所有支援的日誌記錄系統都可以在Spring環境中設定記錄級別(例如在application.properties中)
格式為:’logging.level.* = LEVEL’
logging.level
:日誌級別控制字首,*
為包名或Logger名LEVEL
:選項TRACE, DEBUG, INFO, WARN, ERROR, FATAL, OFF
舉例:
logging.level.com.dudu=DEBUG
:com.dudu
包下所有class以DEBUG級別輸出logging.level.root=WARN
:root日誌以WARN級別輸出
自定義日誌配置
由於日誌服務一般都在ApplicationContext建立前就初始化了,它並不是必須通過Spring的配置檔案控制。因此通過系統屬性和傳統的Spring Boot外部配置檔案依然可以很好的支援日誌控制和管理。
根據不同的日誌系統,你可以按如下規則組織配置檔名,就能被正確載入:
- 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.properties
配置檔案裡面通過logging.config屬性指定自定義的名字:
1
| logging.config=classpath:logging-config.xml
|
雖然一般並不需要改變配置檔案的名字,但是如果你想針對不同執行時Profile使用不同的日
志配置,這個功能會很有用。
下面我們來看看一個普通的logback-spring.xml例子
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 | <?xml version="1.0" encoding="UTF-8"?> <configuration scan="true" scanPeriod="60 seconds" debug="false"> <contextName>logback</contextName> <property name="log.path" value="/Users/tengjun/Documents/log" /> <!--輸出到控制檯--> <appender name="console" class="ch.qos.logback.core.ConsoleAppender"> <!-- <filter class="ch.qos.logback.classic.filter.ThresholdFilter"> <level>ERROR</level> </filter>--> <encoder> <pattern>%d{HH:mm:ss.SSS} %co |