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

時間 2019-12-05

標籤 springboot 如何實現日誌欄目 Spring 简体版

原文原文鏈接

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

前言

休息日閒着無聊看了下 SpringBoot 中的日誌實現，把個人理解跟你們說下。html

門面模式

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

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

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

　　2）.子系統（模塊）角色：實現了子系統的功能。它對客戶角色和 Facade 是未知的。它內部能夠有系統內的相互交互，也能夠由供外界調用的接口。算法

　　3）.客戶角色：經過調用 Facede 來完成要實現的功能。spring

市面上的日誌框架

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

簡單說下，上表的日誌門面對應了門面模式中的 Facede 對象，它們只是一個接口層，並不提供日誌實現；而日誌實現則對應着各個子系統或者模塊，日誌記錄的具體邏輯實現，就寫在這些右邊的框架裏面；那咱們的應用程序就至關於客戶端。springboot

爲何要使用門面模式？

試想下咱們開發系統的場景，須要用到不少包，而這些包又有本身的日誌框架，因而就會出現這樣的狀況：咱們本身的系統中使用了 Logback 這個日誌系統，咱們的系統使用了 Hibernate，Hibernate 中使用的日誌系統爲 jboss-logging，咱們的系統又使用了 Spring ，Spring 中使用的日誌系統爲 commons-logging。微信

這樣，咱們的系統就不得不一樣時支持並維護 Logback、jboss-logging、commons-logging 三種日誌框架，很是不便。解決這個問題的方式就是引入一個接口層，由接口層決定使用哪種日誌系統，而調用端只須要作的事情就是打印日誌而不須要關心如何打印日誌，而上表的日誌門面就是這種接口層。app

鑑於此，咱們選擇日誌時，就必須從上表左邊的日誌門面和右邊的日誌實現各選擇一個框架，而 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 的作法是：

一、將系統中其餘日誌框架先排除出去

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

三、咱們導入 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 有這麼一張關係圖：

可見，
一、SpringBoot2.x 底層也是使用 slf4j+logback 或 log4j 的方式進行日誌記錄；
二、SpringBoot 引入中間替換包把其餘的日誌都替換成了 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>

SpringBoot 能自動適配全部的日誌，並且底層使用 slf4j+logback 的方式記錄日誌，引入其餘框架的時候，只須要把這個框架依賴的日誌框架排除掉便可。

日誌使用

一、默認配置（以 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日誌...");
    }

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

三、指定配置

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>