SpringBoot實現日志的方法

小編給大家分享一下SpringBoot實現日志的方法，希望大家閱讀完這篇文章之后都有所收獲，下面讓我們一起去探討吧！

門面模式

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

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

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

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

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

市面上的日志框架

簡單說下，上表的日志門面對應了門面模式中的 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.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>

看完了這篇文章，相信你對“SpringBoot實現日志的方法”有了一定的了解，如果想了解更多相關知識，歡迎關注億速云行業資訊頻道，感謝各位的閱讀！