SpringBoot（三）——日誌

SpringBoot系列文章

• Spring 註解開發
• SpringBoot（一）——入門
• SpringBoot（二）——配置

1. 日誌框架

日誌在開發中是必不可少的，目前，項目中使用日誌的方式是給項目導入一個日誌門面（日誌的一個抽象接口），再給項目中導入具體的日誌實現就行了，這樣，只需要面向接口編程，如果需要改變日誌框架的話，只需要改變日誌實現，不需要改其他代碼。

1.1 市面上的日誌框架

JUL、JCL、Jboss-logging、logback、log4j、log4j2、slf4j…

日誌門面 （日誌的抽象層）	日誌實現
JCL(Jakarta Commons Logging) SLF4j(Simple Logging Facade for Java）jboss-logging	JUL(java.util.logging）Log4j Log4j2 Logback

日誌門面中最常用的就是SLF4j，JCL和jboss-logging 目前很少使用，SLF4J和Log4j、Logback都是出自同一個人，適配性很好
使用的時候左邊選一個日誌門面，右邊選一個實現，通常選用的是

• 日誌門面：SEL4J
• 日誌實現：Logback

SpringBoot選用的就是SELF4J和Logback

1.2 SLF4j的使用

開發的時候，日誌記錄方法的調用，不應該來直接調用日誌的實現類中的方法，而是調用日誌抽象層裏面的方法。slf4j官方文檔

給系統裏面導入slf4j的jar和logback的實現jar。使用方式:

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

public class HelloWorld {
  public static void main(String[] args) {
    Logger logger = LoggerFactory.getLogger(HelloWorld.class);
    logger.info("Hello World");
  }
}

• 從圖中可以看出，如果只導入slf4j的話，會輸出到一個空的位置，因爲沒有任何實現（左邊第一列）
• 左邊第二列是正確的用法，slf4j和logback一起使用
• 如果門面使用slf4j，實現使用log4j的話，中間需要加一個適配層，這個適配層上面實現了slf4j，調用的是log4j中的方法。如果使用JUL實現的話，也需要加一個適配層（左邊第三列、第四列）。

每一個日誌的實現框架都有自己的配置文件。使用slf4j以後，配置文件還是做成日誌實現框架本身的配置文件。

1.3 遺留問題

項目中依賴的框架可能使用不同的日誌：
Spring（commons-logging）、Hibernate（jboss-logging）、MyBatis、xxxx
當一個項目使用多種日誌框架時，可以統一適配到slf4，中間使用SLF4J或者第三方提供的日誌適配器適配到SLF4J，SLF4J在底層用開發者想用的一個日誌實現框架來進行日誌系統的實現，從而達到了多種日誌的統一實現。

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

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

比如一個項目中想要用slf4+logback的方式實現日誌系統，但是其他的框架用的是Commons logging、log4j、java.util.logging，可以不導入這兩個jar包，而是導入jcl-over-slf4j.jar、log4j-over-slf4j.jar、jul-to-slf4j.jar來替換，這樣，其他框架也是使用slf4j+logback的實現方式了。

2. SpringBoot日誌關係

每一個啓動器中都有一個spring-boot-starter依賴

<dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter</artifactId>
      <version>2.3.1.RELEASE</version>
      <scope>compile</scope>
    </dependency>

spring-boot-starter中使用spring-boot-starter-logging來做日誌功能

<dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-logging</artifactId>
      <version>2.3.1.RELEASE</version>
      <scope>compile</scope>
    </dependency>

底層依賴關係

總結：

• SpringBoot底層也是使用slf4j+logback的方式進行日誌記錄
• SpringBoot也把其他的日誌都替換成了slf4j’
• 中間替換包，名字還是和被替換的一樣，只不過用的是slf4j的LogFactory
• 如果我們要引入其他框架，一定要把這個框架的默認日誌依賴移除掉

1.5.10版本中排除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的方式記錄日誌，引入其他框架的時候，只需要把這個框架依賴的日誌框架排除掉即可；

2.1 日誌的使用

SpringBoot默認幫我們配置好了日誌

//創建記錄器
Logger logger = LoggerFactory.getLogger(getClass());
/*日誌的級別
由低到高：trace<debug<info<warn<error
可以調整輸出的日誌級別，日誌就只會在這個級別以及以後的高級級別生效（輸出）
 */
@Test
public void contextLoads() {
   logger.trace("這是trace日誌");
   logger.debug("這是debug日誌");
   //SpringBoot默認使用的是info級別，也可以自己指定級別，沒有指定級別的話就使
    // 用springboot默認使用的級別，也叫root級別
   logger.info("這是info日誌");
   logger.warn("這是warn日誌");
   logger.error("這是error日誌");
    }

日誌輸出格式

日誌輸出格式：
        %d表示日期時間，
        %thread表示線程名，
        %-5level：級別從左顯示5個字符寬度
        %logger{50} 表示logger名字最長50個字符，否則按照句點分割。 
        %msg：日誌消息，
        %n是換行符
    -->
    %d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50}  %msg%n

3.3 修改默認配置

#指定日誌的級別,也可以指定一個包路徑 logging.level.com.xxx=error
logging.level.root=error
#使用logging.file.name不指定路徑的話，會在項目下生成指定的日誌文件
#指定路徑的話，會在指定的路徑下生成對應的日誌文件
#logging.file.name=G://log//springBoot.log

#會在當前磁盤的根路徑下創建spring文件夾和裏面的log文件夾，使用spring.log作爲默認文件
logging.file.path=/spring/log

#指定在控制檯輸出的格式
logging.pattern.console=%d{yyy-MM-dd} {%thread} %-5level  %logger{50}  %msg%n

#指定在文件中的輸出格式
logging.pattern.file=%d{yyy-MM-dd}==={%thread}===%-5level===%logger{50}===%msg%n

3.4 指定配置

當使用日誌的高級功能時，可能需要自己來寫日誌的配置文件。給類路徑下放上每個日誌框架自己的配置文件，SpringBoot就不使用他默認配置的了，而是使用自己的配置

Logging System	Customization
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">
</springProfile>

<appender name="stdout" class="ch.qos.logback.core.ConsoleAppender">
  
        <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>

3.5 切換日誌實現框架

可以按照1.2中的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>
    <exclusion>
      <artifactId>log4j-over-slf4j</artifactId>
      <groupId>org.slf4j</groupId>
    </exclusion>
  </exclusions>
</dependency>

<dependency>
  <groupId>org.slf4j</groupId>
  <artifactId>slf4j-log4j12</artifactId>
</dependency>

如果想要切換爲log4j2，可以將spring-boot-starter-logging依賴換成spring-boot-starter-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>