SpringBoot | SpringBoot 是如何實現日誌的？

SpringBoot · 發表 2019-03-24 18:34:15

摘要：微信公眾號：一個優秀的廢人。如有問題，請後臺留言，反正我也不會聽。前言休息日閒著無聊看了下 SpringBoot 中的日誌實現，把我的理解跟大家說下。門面模式說到日誌框架不得不說門面模式。門面模式，其核心為外部與一個子系統的通訊必須通過一個統一的外觀物件進行，使得子系統...

微信公眾號：一個優秀的廢人。如有問題，請後臺留言，反正我也不會聽。

前言

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

門面模式

說到日誌框架不得不說門面模式。門面模式，其核心為外部與一個子系統的通訊必須通過一個統一的外觀物件進行，使得子系統更易於使用。用一張圖來表示門面模式的結構為：

簡單來說，該模式就是把一些複雜的流程封裝成一個介面供給外部使用者更簡單的使用。這個模式中，設計到3個角色。

1）.門面角色：外觀模式的核心。它被客戶角色呼叫，它熟悉子系統的功能。內部根據客戶角色的需求預定了幾種功能的組合（模組）。

2）.子系統（模組）角色：實現了子系統的功能。它對客戶角色和 Facade 是未知的。它內部可以有系統內的相互互動，也可以由供外界呼叫的介面。

3）.客戶角色：通過呼叫 Facede 來完成要實現的功能。

市面上的日誌框架

日誌門面	日誌實現
JCL（Jakarta Commons Logging）、SLF4j（Simple Logging Facade for Java）、 jboss-logging	Log4j 、JUL（java.util.logging）、Log4j2 、 Logback

簡單說下，上表的日誌門面對應了門面模式中的 Facede 物件，它們只是一個介面層，並不提供日誌實現；而日誌實現則對應著各個子系統或者模組，日誌記錄的具體邏輯實現，就寫在這些右邊的框架裡面；那我們的應用程式就相當於客戶端。

為什麼要使用門面模式？

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

這樣，我們的系統就不得不同時支援並維護 Logback、jboss-logging、commons-logging 三種日誌框架，非常不便。解決這個問題的方式就是引入一個介面層，由介面層決定使用哪一種日誌系統，而呼叫端只需要做的事情就是列印日誌而不需要關心如何列印日誌，而上表的日誌門面就是這種介面層。

鑑於此，我們選擇日誌時，就必須從上表左邊的日誌門面和右邊的日誌實現各選擇一個框架，而 SpringBoot 底層預設選用的就是 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 的工作原理，我翻了下它的官方文件，看到這麼一張圖：

簡單解釋一下，上圖 slf4j 有六種用法，一共五種角色，application 不用說，就是我們的系統；SLF4J API 就是日誌介面層（門面）；藍色和最下面灰色的就是具體日誌實現（子系統）；而 Adaptation 就是適配層。

解釋下，上圖第二，第三種用法。其中第二種就是 SpringBoot 的預設用法；而為什麼會出現第三種？因為 Log4J 出現得比較早，它根本不知道後面會有 SLF4J 這東西。Log4J 不能直接作為 SLF4J 的日誌實現，所以中間就出現了適配層。第四種同理。

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

如何讓系統中所有的日誌都統一到 slf4j ？

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

由上圖可以看出，讓系統中所有的日誌都統一到 slf4j 的做法是：

1、將系統中其他日誌框架先排除出去

2、用中間包來替換原有的日誌框架

3、我們匯入 slf4j 其他的實現

SpringBoot 中的日誌關係

SpringBoot 使用以下依賴實現日誌功能：

<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 有這麼一張關係圖：

可見，

1、SpringBoot2.x 底層也是使用 slf4j+logback 或 log4j 的方式進行日誌記錄；

2、SpringBoot 引入中間替換包把其他的日誌都替換成了 slf4j；

3、如果我們要引入其他框架、可以把這個框架的預設日誌依賴移除掉。

比如 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>

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

日誌使用

1、預設配置（以 Log4j 框架為例），SpringBoot 預設幫我們配置好了日誌：

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

2、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

3、指定配置

SpringBoot 會自動載入類路徑下對應框架的配置檔案，所以我們只需給類路徑下放上每個日誌框架自己的配置檔案即可，SpringBoot 就不會使用預設配置了。

框架	命名方式
Logback	`logback-spring.xml` , `logback-spring.groovy` , `logback.xml` or `logback.groovy`
Log4j2	`log4j2-spring.xml` or `log4j2.xml`
JDK (Java Util Logging)	`logging.properties

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

logback-spring.xml：日誌框架就不直接載入日誌的配置項，由 SpringBoot 解析日誌配置，可以使用 SpringBoot 的高階 Profile 功能。

<springProfile name="staging">
<!-- configuration to be enabled when the "staging" profile is active -->
可以指定某段配置只在某個環境下生效
</springProfile>

例子（以 Logback 框架為例）：

<appender name="stdout" class="ch.qos.logback.core.ConsoleAppender">
<!--
日誌輸出格式：
%d表示日期時間，
%thread表示執行緒名，
%-5level：級別從左顯示5個字元寬度
%logger{50} 表示logger名字最長50個字元，否則按照句點分割。 
%msg：日誌訊息，
%n是換行符
-->
<layout class="ch.qos.logback.classic.PatternLayout">
<!--指定在 dev 環境下，控制檯使用該格式輸出日誌-->
<springProfile name="dev">
<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} ----> [%thread] ---> %-5level %logger{50} - %msg%n</pattern>
</springProfile>
<!--指定在非 dev 環境下，控制檯使用該格式輸出日誌-->
<springProfile name="!dev">
<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]

切換日誌框架

瞭解了 SpringBoot 的底層日誌依賴關係，我們就可以按照 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 的詳細配置，大家在自己專案可以參考配置。

<?xml version="1.0" encoding="UTF-8"?>
<!--
scan：當此屬性設定為true時，配置檔案如果發生改變，將會被重新載入，預設值為true。
scanPeriod：設定監測配置檔案是否有修改的時間間隔，如果沒有給出時間單位，預設單位是毫秒當scan為true時，此屬性生效。預設的時間間隔為1分鐘。
debug：當此屬性設定為true時，將打印出logback內部日誌資訊，實時檢視logback執行狀態。預設值為false。
-->
<configuration scan="false" scanPeriod="60 seconds" debug="false">
<!-- 定義日誌的根目錄 -->
<property name="LOG_HOME" value="/app/log" />
<!-- 定義日誌檔名稱 -->
<property name="appName" value="nasus-springboot"></property>
<!-- ch.qos.logback.core.ConsoleAppender 表示控制檯輸出 -->
<appender name="stdout" class="ch.qos.logback.core.ConsoleAppender">
<!--
日誌輸出格式：
%d表示日期時間，
%thread表示執行緒名，
%-5level：級別從左顯示5個字元寬度
%logger{50} 表示logger名字最長50個字元，否則按照句點分割。 
%msg：日誌訊息，
%n是換行符
-->
<layout class="ch.qos.logback.classic.PatternLayout">
<springProfile name="dev">
<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} ----> [%thread] ---> %-5level %logger{50} - %msg%n</pattern>
</springProfile>
<springProfile name="!dev">
<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} ==== [%thread] ==== %-5level %logger{50} - %msg%n</pattern>
</springProfile>
</layout>
</appender>

<!-- 滾動記錄檔案，先將日誌記錄到指定檔案，當符合某個條件時，將日誌記錄到其他檔案 -->
<appender name="appLogAppender" class="ch.qos.logback.core.rolling.RollingFileAppender">
<!-- 指定日誌檔案的名稱 -->
<file>${LOG_HOME}/${appName}.log</file>
<!--
當發生滾動時，決定 RollingFileAppender 的行為，涉及檔案移動和重新命名
TimeBasedRollingPolicy： 最常用的滾動策略，它根據時間來制定滾動策略，既負責滾動也負責出發滾動。
-->
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<!--
滾動時產生的檔案的存放位置及檔名稱 %d{yyyy-MM-dd}：按天進行日誌滾動 
%i：當檔案大小超過maxFileSize時，按照i進行檔案滾動
-->
<fileNamePattern>${LOG_HOME}/${appName}-%d{yyyy-MM-dd}-%i.log</fileNamePattern>
<!-- 
可選節點，控制保留的歸檔檔案的最大數量，超出數量就刪除舊檔案。假設設定每天滾動，
且maxHistory是365，則只儲存最近365天的檔案，刪除之前的舊檔案。注意，刪除舊檔案是，
那些為了歸檔而建立的目錄也會被刪除。
-->
<MaxHistory>365</MaxHistory>
<!-- 
當日志文件超過maxFileSize指定的大小是，根據上面提到的%i進行日誌檔案滾動 注意此處配置SizeBasedTriggeringPolicy是無法實現按檔案大小進行滾動的，必須配置timeBasedFileNamingAndTriggeringPolicy
-->
<timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
<maxFileSize>100MB</maxFileSize>
</timeBasedFileNamingAndTriggeringPolicy>
</rollingPolicy>
<!-- 日誌輸出格式： -->
<layout class="ch.qos.logback.classic.PatternLayout">
<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [ %thread ] - [ %-5level ] [ %logger{50} : %line ] - %msg%n</pattern>
</layout>
</appender>

<!-- 
logger主要用於存放日誌物件，也可以定義日誌型別、級別
name：表示匹配的logger型別字首，也就是包的前半部分
level：要記錄的日誌級別，包括 TRACE < DEBUG < INFO < WARN < ERROR
additivity：作用在於children-logger是否使用 rootLogger配置的appender進行輸出，
false：表示只用當前logger的appender-ref，true：
表示當前logger的appender-ref和rootLogger的appender-ref都有效
-->
<!-- hibernate logger -->
<logger name="com.nasus" level="debug" />
<!-- Spring framework logger -->
<logger name="org.springframework" level="debug" additivity="false"></logger>



<!-- 
root 與 logger 是父子關係，沒有特別定義則預設為root，任何一個類只會和一個logger對應，
要麼是定義的logger，要麼是root，判斷的關鍵在於找到這個logger，然後判斷這個logger的appender和level。 
-->
<root level="info">
<appender-ref ref="stdout" />
<appender-ref ref="appLogAppender" />
</root>
</configuration>

參考文獻

http://www.importnew.com/2849...

https://www.cnblogs.com/lthIU...

後語

如果本文對你哪怕有一丁點幫助，請幫忙點好看。你的好看是我堅持寫作的動力。

另外，關注之後在傳送 1024 可領取免費學習資料。

資料詳情請看這篇舊文： Python、C++、Java、Linux、Go、前端、演算法資料分享