開發(fā)|SpringBoot是如何實(shí)現(xiàn)日志的？

休息日閑著無聊看了下 Spring Boot 中的日志實(shí)現(xiàn)，把我的理解跟大家說下。

成都創(chuàng)新互聯(lián)公司是一家專注于成都網(wǎng)站制作、網(wǎng)站設(shè)計(jì)與策劃設(shè)計(jì),橫山網(wǎng)站建設(shè)哪家好?成都創(chuàng)新互聯(lián)公司做網(wǎng)站,專注于網(wǎng)站建設(shè)十載,網(wǎng)設(shè)計(jì)領(lǐng)域的專業(yè)建站公司;建站業(yè)務(wù)涵蓋:橫山等地區(qū)。橫山做網(wǎng)站價(jià)格咨詢:18980820575

門面模式

說到日志框架不得不說門面模式。門面模式，其核心為外部與一個(gè)子系統(tǒng)的通信必須通過一個(gè)統(tǒng)一的外觀對(duì)象進(jìn)行，使得子系統(tǒng)更易于使用。

用一張圖來表示門面模式的結(jié)構(gòu)為：

門面模式

簡單來說，該模式就是把一些復(fù)雜的流程封裝成一個(gè)接口供給外部用戶更簡單的使用。

這個(gè)模式中，涉及到三個(gè)角色：

門面角色：外觀模式的核心。它被客戶角色調(diào)用，熟悉子系統(tǒng)的功能。內(nèi)部根據(jù)客戶角色的需求預(yù)定了幾種功能的組合(模塊)。
子系統(tǒng)(模塊)角色：實(shí)現(xiàn)了子系統(tǒng)的功能。它對(duì)客戶角色和 Facade 是未知的。它內(nèi)部可以有系統(tǒng)內(nèi)的相互交互，也可以有供外界調(diào)用的接口。
客戶角色：通過調(diào)用 Facede 來完成要實(shí)現(xiàn)的功能。

市面上的日志框架

簡單說下，上表的日志門面對(duì)應(yīng)了門面模式中的 Facede 對(duì)象，它們只是一個(gè)接口層，并不提供日志實(shí)現(xiàn)。

而日志實(shí)現(xiàn)則對(duì)應(yīng)著各個(gè)子系統(tǒng)或者模塊，日志記錄的具體邏輯實(shí)現(xiàn)，就寫在這些右邊的框架里面;那我們的應(yīng)用程序就相當(dāng)于客戶端。

為什么要使用門面模式?

試想下我們開發(fā)系統(tǒng)的場景，需要用到很多包，而這些包又有自己的日志框架，于是就會(huì)出現(xiàn)這樣的情況：我們自己的系統(tǒng)中使用了 Logback 這個(gè)日志系統(tǒng)，我們的系統(tǒng)使用了 Hibernate。

Hibernate 中使用的日志系統(tǒng)為 jboss-logging，我們的系統(tǒng)又使用了 Spring，Spring 中使用的日志系統(tǒng)為 commons-logging。

這樣，我們的系統(tǒng)就不得不同時(shí)支持并維護(hù) Logback、jboss-logging、commons-logging 三種日志框架，非常不便。

解決這個(gè)問題的方式就是引入一個(gè)接口層，由接口層決定使用哪一種日志系統(tǒng)，而調(diào)用端只需要做的事情就是打印日志而不需要關(guān)心如何打印日志，而上表的日志門面就是這種接口層。

鑒于此，我們選擇日志時(shí)，就必須從上表左邊的日志門面和右邊的日志實(shí)現(xiàn)各選擇一個(gè)框架。

而 Spring Boot 底層默認(rèn)選用的就是 SLF4j 和 Logback 來實(shí)現(xiàn)日志輸出。

SLF4j 使用

官方文檔給出這樣一個(gè)例子：

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

為了理解 SLF4j 的工作原理，我翻了下它的官方文檔，看到這么一張圖：

SLF4J

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

SLF4J API 就是日志接口層(門面);藍(lán)色和最下面灰色的就是具體日志實(shí)現(xiàn)(子系統(tǒng));而 Adaptation 就是適配層。

解釋下，上圖第二，第三種用法。其中第二種就是 Spring Boot 的默認(rèn)用法;而為什么會(huì)出現(xiàn)第三種?

因?yàn)?Log4J 出現(xiàn)得比較早，它根本不知道后面會(huì)有 SLF4J 這東西。Log4J 不能直接作為 SLF4J 的日志實(shí)現(xiàn)，所以中間就出現(xiàn)了適配層。第四種同理。

這里提醒下，每一個(gè)日志的實(shí)現(xiàn)框架都有自己的配置文件。使用 SLF4J 以后，**配置文件還是做成日志實(shí)現(xiàn)框架自己本身的配置文件。比如，Logback 就使用 logback.xml、Log4J 就使用 Log4j.xml 文件。

如何讓系統(tǒng)中所有的日志都統(tǒng)一到 SLF4J?

我繼續(xù)瀏覽了下官網(wǎng)，看見這么一張圖：

Legacy

由上圖可以看出，讓系統(tǒng)中所有的日志都統(tǒng)一到 SLF4J 的做法是：

將系統(tǒng)中其他日志框架先排除出去。
用中間包來替換原有的日志框架。
我們導(dǎo)入 SLF4J 其他的實(shí)現(xiàn)。

Spring Boot 中的日志關(guān)系

Spring Boot 使用以下依賴實(shí)現(xiàn)日志功能：

 
 
 
 
  
  
  
     
  
  
        org.springframework.boot   
  
  
        spring-boot-starter-logging   
  
  
        2.1.3.RELEASE   
  
  
        compile

spring-boot-starter-logging 有這么一張關(guān)系圖：

日志底層依賴

由上圖可見：

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

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

 
 
 
 
  
  
  
     
  
  
      org.springframework   
  
  
          spring-core   
  
  
                 
  
  
                     
  
  
                      commons-logging   
  
  
                          commons-logging

Spring Boot 能自動(dòng)適配所有的日志，而且底層使用 slf4j+logback 的方式記錄日志，引入其他框架的時(shí)候，只需要把這個(gè)框架依賴的日志框架排除掉即可。

日志使用

①默認(rèn)配置(以 Log4J 框架為例)，Spring Boot 默認(rèn)幫我們配置好了日志：

 
 
 
 
  
  
  
  //記錄器   
  
  
     Logger logger = LoggerFactory.getLogger(getClass());   
  
  
     @Test   
  
  
     public void contextLoads() {   
  
  
         //日志的級(jí)別；   
  
  
         //由低到高   trace  
  
  
  
       //可以調(diào)整輸出的日志級(jí)別；日志就只會(huì)在這個(gè)級(jí)別以以后的高級(jí)別生效   
  
  
         logger.trace("這是trace日志...");   
  
  
         logger.debug("這是debug日志...");   
  
  
         // SpringBoot 默認(rèn)給我們使用的是 info 級(jí)別的，沒有指定級(jí)別的就用SpringBoot 默認(rèn)規(guī)定的級(jí)別；root 級(jí)別   
  
  
         logger.info("這是info日志...");   
  
  
         logger.warn("這是warn日志...");   
  
  
         logger.error("這是error日志...");   
  
  
     }

②log4j.properties 修改日志默認(rèn)配置：

 
 
 
 
  
  
  
  logging.level.com.nasus=debug   
  
  
     
  
  
  #logging.path=   
  
  
  # 不指定路徑在當(dāng)前項(xiàng)目下生成 springboot.log 日志   
  
  
  # 可以指定完整的路徑；   
  
  
  #logging.file=Z:/springboot.log   
  
  
     
  
  
  # 在當(dāng)前磁盤的根路徑下創(chuàng)建 spring 文件夾和里面的 log 文件夾；使用 spring.log 作為默認(rèn)文件   
  
  
  logging.path=/spring/log   
  
  
     
  
  
  #  在控制臺(tái)輸出的日志的格式   
  
  
  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 會(huì)自動(dòng)加載類路徑下對(duì)應(yīng)框架的配置文件，所以我們只需給類路徑下放上每個(gè)日志框架自己的配置文件即可，Spring Boot 就不會(huì)使用默認(rèn)配置了。

logback.xml：直接就被日志框架識(shí)別了。

logback-spring.xml：日志框架就不直接加載日志的配置項(xiàng)，由 Spring Boot 解析日志配置，可以使用 Spring Boot 的高級(jí) Profile 功能。

 
 
 
 
  
  
  
     
  
  
         
  
  
        可以指定某段配置只在某個(gè)環(huán)境下生效

例子 (以 Logback 框架為例)：

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

如果使用 logback.xml 作為日志配置文件，而不是 logback-spring.xml，還要使用 Profile 功能，會(huì)有以下錯(cuò)誤：

 
 
 
 
  
  
  
  no applicable action for [springProfile]

切換日志框架

了解了 Spring Boot 的底層日志依賴關(guān)系，我們就可以按照 SLF4J 的日志適配圖，進(jìn)行相關(guān)的切換。

例如，切換成 SLF4J+Log4J ，可以這樣做：

 
 
 
 
  
  
  
     
  
  
    org.springframework.boot   
  
  
    spring-boot-starter-web   
  
  
       
  
  
         
  
  
        logback-classic   
  
  
        ch.qos.logback   
  
  
         
  
  
       
  
  
     
  
  
     
  
  
     
  
  
    org.slf4j   
  
  
    slf4j-log4j12

切換成 log4j2 ，就可以這樣做：

 
 
 
 
  
  
  
     
  
  
        org.springframework.boot   
  
  
        spring-boot-starter-web   
  
  
                 
  
  
                     
  
  
                      spring-boot-starter-logging   
  
  
                      org.springframework.boot   
  
  
                     
  
  
                 
  
  
     
  
  
     
  
  
     
  
  
    org.springframework.boot   
  
  
    spring-boot-starter-log4j2

***放上 logback-spring.xml 的詳細(xì)配置，大家在自己項(xiàng)目可以參考配置：

 
 
 
 
  
  
  
     
  
  
     
  
  
     
  
  
         
  
  
         
  
  
         
  
  
         
  
  
         
  
  
         
  
  
             
  
  
             
  
  
                 
  
  
                  %d{yyyy-MM-dd HH:mm:ss.SSS} ----> [%thread] ---> %-5level %logger{50} - %msg%n   
  
  
                 
  
  
                 
  
  
                  %d{yyyy-MM-dd HH:mm:ss.SSS} ==== [%thread] ==== %-5level %logger{50} - %msg%n   
  
  
                 
  
  
             
  
  
         
  
  
     
  
  
           
  
  
         
  
  
             
  
  
          ${LOG_HOME}/${appName}.log   
  
  
             
  
  
             
  
  
                 
  
  
              ${LOG_HOME}/${appName}-%d{yyyy-MM-dd}-%i.log   
  
  
                 
  
  
              365   
  
  
                 
  
  
                 
  
  
                  100MB   
  
  
                 
  
  
             
  
  
                  
  
  
             
  
  
              %d{yyyy-MM-dd HH:mm:ss.SSS} [ %thread ] - [ %-5level ] [ %logger{50} : %line ] - %msg%n

參考文獻(xiàn)：

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

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

當(dāng)前名稱：開發(fā)|SpringBoot是如何實(shí)現(xiàn)日志的？
轉(zhuǎn)載源于：http://m.jiaotiyi.com/article/ccehsdc.html

網(wǎng)站建設(shè)知識(shí)

開發(fā)|SpringBoot是如何實(shí)現(xiàn)日志的？

其他資訊

網(wǎng)站建設(shè)知識(shí)

開發(fā)|SpringBoot是如何實(shí)現(xiàn)日志的？

其他資訊

開發(fā)|SpringBoot是如何實(shí)現(xiàn)日志的？