Spring Boot是如何實現日誌的?

休息日閒著無聊看了下 Spring Boot 中的日誌實現,把我的理解跟大家說下。


開發 | Spring Boot是如何實現日誌的?


門面模式

說到日誌框架不得不說門面模式。門面模式,其核心為外部與一個子系統的通信必須通過一個統一的外觀對象進行,使得子系統更易於使用。

用一張圖來表示門面模式的結構為:


開發 | Spring Boot是如何實現日誌的?


門面模式

簡單來說,該模式就是把一些複雜的流程封裝成一個接口供給外部用戶更簡單的使用。

這個模式中,涉及到三個角色:

  • 門面角色:外觀模式的核心。它被客戶角色調用,熟悉子系統的功能。內部根據客戶角色的需求預定了幾種功能的組合(模塊)。
  • 子系統(模塊)角色:實現了子系統的功能。它對客戶角色和 Facade 是未知的。它內部可以有系統內的相互交互,也可以有供外界調用的接口。
  • 客戶角色:通過調用 Facede 來完成要實現的功能。

市面上的日誌框架


開發 | Spring Boot是如何實現日誌的?


簡單說下,上表的日誌門面對應了門面模式中的 Facede 對象,它們只是一個接口層,並不提供日誌實現。

而日誌實現則對應著各個子系統或者模塊,日誌記錄的具體邏輯實現,就寫在這些右邊的框架裡面;那我們的應用程序就相當於客戶端。

為什麼要使用門面模式?

試想下我們開發系統的場景,需要用到很多包,而這些包又有自己的日誌框架,於是就會出現這樣的情況:我們自己的系統中使用了 Logback 這個日誌系統,我們的系統使用了 Hibernate。

Hibernate 中使用的日誌系統為 jboss-logging,我們的系統又使用了 Spring,Spring 中使用的日誌系統為 commons-logging。

這樣,我們的系統就不得不同時支持並維護 Logback、jboss-logging、commons-logging 三種日誌框架,非常不便。

解決這個問題的方式就是引入一個接口層,由接口層決定使用哪一種日誌系統,而調用端只需要做的事情就是打印日誌而不需要關心如何打印日誌,而上表的日誌門面就是這種接口層。

鑑於此,我們選擇日誌時,就必須從上表左邊的日誌門面和右邊的日誌實現各選擇一個框架。

而 Spring Boot 底層默認選用的就是 SLF4j 和 Logback 來實現日誌輸出。

SLF4j 使用

官方文檔給出這樣一個例子:

import org.slf4j.Logger; 
import org.slf4j.LoggerFactory;

public class HelloWorld {
public static void main(String[] args) {
// HelloWorld.class 就是你要打印的指定類的日誌,
// 如果你想在其它類中打印,那就把 HelloWorld.class 替換成目標類名.class 即可。
Logger logger = LoggerFactory.getLogger(HelloWorld.class);
logger.info("Hello World");
}
}

為了理解 SLF4j 的工作原理,我翻了下它的官方文檔,看到這麼一張圖:


開發 | Spring Boot是如何實現日誌的?


SLF4J

簡單解釋一下,上圖 SLF4J 有六種用法,一共五種角色,Application 不用說,就是我們的系統。

SLF4J API 就是日誌接口層(門面);藍色和最下面灰色的就是具體日誌實現(子系統);而 Adaptation 就是適配層。

解釋下,上圖第二,第三種用法。其中第二種就是 Spring Boot 的默認用法;而為什麼會出現第三種?

因為 Log4J 出現得比較早,它根本不知道後面會有 SLF4J 這東西。Log4J 不能直接作為 SLF4J 的日誌實現,所以中間就出現了適配層。第四種同理。

這裡提醒下,每一個日誌的實現框架都有自己的配置文件。使用 SLF4J 以後,**配置文件還是做成日誌實現框架自己本身的配置文件。比如,Logback 就使用 logback.xml、Log4J 就使用 Log4j.xml 文件。

如何讓系統中所有的日誌都統一到 SLF4J?

我繼續瀏覽了下官網,看見這麼一張圖:


開發 | Spring Boot是如何實現日誌的?


Legacy

由上圖可以看出,讓系統中所有的日誌都統一到 SLF4J 的做法是:

  • 將系統中其他日誌框架先排除出去。
  • 用中間包來替換原有的日誌框架。
  • 我們導入 SLF4J 其他的實現。

Spring Boot 中的日誌關係

Spring Boot 使用以下依賴實現日誌功能:

<dependency> 
<groupid>org.springframework.boot/<groupid>
<artifactid>spring-boot-starter-logging/<artifactid>
<version>2.1.3.RELEASE/<version>
<scope>compile/<scope>
/<dependency>

spring-boot-starter-logging 有這麼一張關係圖:


開發 | Spring Boot是如何實現日誌的?


日誌底層依賴

由上圖可見:

  • Spring Boot2.x 底層也是使用 slf4j+logback 或 Log4J 的方式進行日誌記錄。
  • Spring Boot 引入中間替換包把其他的日誌都替換成了 SLF4J。
  • 如果我們要引入其他框架、可以把這個框架的默認日誌依賴移除掉。

比如 Spring 使用的是 commons-logging 框架,我們可以這樣移除:

<dependency> 
<groupid>org.springframework/<groupid>
<artifactid>spring-core/<artifactid>
<exclusions>
<exclusion>
<groupid>commons-logging/<groupid>
<artifactid>commons-logging/<artifactid>
/<exclusion>
/<exclusions>
/<dependency>

Spring Boot 能自動適配所有的日誌,而且底層使用 slf4j+logback 的方式記錄日誌,引入其他框架的時候,只需要把這個框架依賴的日誌框架排除掉即可。

日誌使用

①默認配置(以 Log4J 框架為例),Spring Boot 默認幫我們配置好了日誌:

//記錄器 
Logger logger = LoggerFactory.getLogger(getClass());
@Test
public void contextLoads() {
//日誌的級別;
//由低到高 trace<debug> //可以調整輸出的日誌級別;日誌就只會在這個級別以以後的高級別生效
logger.trace("這是trace日誌...");
logger.debug("這是debug日誌...");
// SpringBoot 默認給我們使用的是 info 級別的,沒有指定級別的就用SpringBoot 默認規定的級別;root 級別
logger.info("這是info日誌...");
logger.warn("這是warn日誌...");
logger.error("這是error日誌...");
}
/<debug>

②log4j.properties 修改日誌默認配置:

logging.level.com.nasus=debug 

#logging.path=
# 不指定路徑在當前項目下生成 springboot.log 日誌
# 可以指定完整的路徑;
#logging.file=Z:/springboot.log

# 在當前磁盤的根路徑下創建 spring 文件夾和裡面的 log 文件夾;使用 spring.log 作為默認文件
logging.path=/spring/log

# 在控制檯輸出的日誌的格式

logging.pattern.console=%d{yyyy-MM-dd} [%thread] %-5level %logger{50} - %msg%n
# 指定文件中日誌輸出的格式
logging.pattern.file=%d{yyyy-MM-dd} === [%thread] === %-5level === %logger{50} ==== %msg%n


開發 | Spring Boot是如何實現日誌的?


配置解釋

③指定配置。Spring Boot 會自動加載類路徑下對應框架的配置文件,所以我們只需給類路徑下放上每個日誌框架自己的配置文件即可,Spring Boot 就不會使用默認配置了。


開發 | Spring Boot是如何實現日誌的?


logback.xml:直接就被日誌框架識別了。

logback-spring.xml:日誌框架就不直接加載日誌的配置項,由 Spring Boot 解析日誌配置,可以使用 Spring Boot 的高級 Profile 功能。

<springprofile> 

可以指定某段配置只在某個環境下生效

/<springprofile>

例子 (以 Logback 框架為例):

<appender> 

<layout>

<springprofile>
<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} ----> [%thread] ---> %-5level %logger{50} - %msg%n/<pattern>
/<springprofile>

<springprofile>
<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} ==== [%thread] ==== %-5level %logger{50} - %msg%n/<pattern>
/<springprofile>
/<layout>
/<appender>

如果使用 logback.xml 作為日誌配置文件,而不是 logback-spring.xml,還要使用 Profile 功能,會有以下錯誤:

no applicable action for [springProfile] 

切換日誌框架

瞭解了 Spring Boot 的底層日誌依賴關係,我們就可以按照 SLF4J 的日誌適配圖,進行相關的切換。

例如,切換成 SLF4J+Log4J ,可以這樣做:

<dependency> 
<groupid>org.springframework.boot/<groupid>
<artifactid>spring-boot-starter-web/<artifactid>
<exclusions>
<exclusion>
<artifactid>logback-classic/<artifactid>
<groupid>ch.qos.logback/<groupid>
/<exclusion>
/<exclusions>
/<dependency>

<dependency>
<groupid>org.slf4j/<groupid>
<artifactid>slf4j-log4j12/<artifactid>
/<dependency>

切換成 log4j2 ,就可以這樣做:

<dependency> 
<groupid>org.springframework.boot/<groupid>
<artifactid>spring-boot-starter-web/<artifactid>
<exclusions>
<exclusion>
<artifactid>spring-boot-starter-logging/<artifactid>
<groupid>org.springframework.boot/<groupid>
/<exclusion>
/<exclusions>
/<dependency>

<dependency>
<groupid>org.springframework.boot/<groupid>
<artifactid>spring-boot-starter-log4j2/<artifactid>
/<dependency>

最後放上 logback-spring.xml 的詳細配置,大家在自己項目可以參考配置:

 

<configuration>

<property>

<property>

<appender>

<layout>
<springprofile>
<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} ----> [%thread] ---> %-5level %logger{50} - %msg%n/<pattern>
/<springprofile>
<springprofile>
<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} ==== [%thread] ==== %-5level %logger{50} - %msg%n/<pattern>
/<springprofile>
/<layout>
/<appender>


<appender>

<file>${LOG_HOME}/${appName}.log/<file>

<rollingpolicy>

<filenamepattern>${LOG_HOME}/${appName}-%d{yyyy-MM-dd}-%i.log/<filenamepattern>

<maxhistory>365/<maxhistory>

<timebasedfilenamingandtriggeringpolicy>
<maxfilesize>100MB/<maxfilesize>
/<timebasedfilenamingandtriggeringpolicy>
/<rollingpolicy>

<layout>
<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [ %thread ] - [ %-5level ] [ %logger{50} : %line ] - %msg%n/<pattern>
/<layout>
/<appender>



<logger>

<logger>




<root>
<appender-ref>
<appender-ref>
/<root>
/<configuration>

參考文獻:

http://www.importnew.com/28494.html

https://www.cnblogs.com/lthIU/p/5860607.html


分享到:


相關文章: