Spring Boot |SpringBoot的日誌框架及配置

---

一、常用的日誌框架

市場上存在非常多的日誌框架，分爲日誌門面(日誌的抽象層)和日誌實現。

1.1 日誌門面

• JUL（java.util.logging)
• JCL（ApacheCommons Logging) (JCL最後一次更新是2014年)
• SLF4j
• jboss-logging (jboss只在特定的框架使用)。

1.2 日誌實現

• Log4j
• Log4j2
• Logback

使用日誌框架需要選擇一個日誌門面(抽象層)、一個日誌實現，搭配使用。

1.3 Spring Boot的日誌框架選擇

Spring Boot在框架內容部使用JCL，spring-boot-starter-logging採用了slf4j+logback的形式，Spring Boot也能自動適配（jul、log4j2、logback） 並簡化配置。

二、SLF4j的使用

2.1 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以後，配置文件還是做成日誌實現框架自己本身的配置文件；

2.2 統一日誌管理

實際開始時問題會變得更復雜，假設開發A系統使用的是slf4j+logback選型，但A系統需要依賴Spring框架、Hibernate框架、Mybatis框架…這些框架底層使用的日誌框架可能各不相同。

• A系統：slf4j+logback
• • Spring框架：commons-logging
• • Hibernate框架：jboss-logging

此時就需要統一日誌記錄，將系統中所有的日誌都統一到slf4j：

第一步：將系統中其他日誌框架先排除出去。
第二步：用中間替換包來替換原有的日誌框架。
第三步：導入slf4j其他的實現。

中間替換包：

三、SpringBoot日誌關係

在項目的pom.xml文件內，右鍵選擇Diagrams的show Dependencies可以查看項目的依賴關係。

spring-boot-starter是一個基本的啓動器，它依賴了spring-boot-starter-logging。

   <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter</artifactId>
   </dependency>

SpringBoot中的日誌都是由spring-boot-starter-logging完成的。

    <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-logging</artifactId>
    </dependency>

SpringBoot日誌關係總結：

1）、SpringBoot底層使用了slf4j+logback的方式進行日誌記錄。
2）、SpringBoot使用中間替換包把其他的日誌都替換成了slf4j。
3）、如果我們要引入其他框架，一定要把這個框架的默認日誌依賴移除掉，否則容易產生jar包衝突。

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

四、SpringBoot日誌使用

詳細日誌使用參照官網。

4.1 默認設置

SpringBoot默認已經幫我們配置好了日誌，可以直接使用。

• 日誌的級別由低到高:是trance<debug<info<warn<error。
• SpringBoot默認爲我們提供的是info級別的，即root級別。

@SpringBootTest
class SpringBoot03LoggingApplicationTests {
    //獲得記錄器
    Logger logger = LoggerFactory.getLogger(getClass());

    @Test
    void contextLoads() {
        //日誌的級別由低到高:這是trance<debug<info<warn<error
        logger.trace("這是trance日誌...");
        logger.debug("這是debug日誌...");
        //SpringBoot默認爲我們提供的是info級別的,即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

修改默認設置

# 設置日誌級別
logging.level.com.gql=info
#當前項目下生成springboot.log日誌,也可以指定完整的路徑
#logging.file.name=D:/AAA/springboot.log
#在當前磁盤的根路徑下創建spring文件夾和log文件夾,此文件夾默認生成spring.log日誌文件
logging.file.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

4.2 指定配置

如果自己編寫了日誌文件，放在類路徑下即可，此時SpringBoot就不使用其默認的配置了。

• 不同的抽象類，防止不同的xml配置文件。
  

Profile高級特性

如果自定義的日誌文件名爲logback.xml，直接就被日誌框架識別了；如果使用logback-spring.xml，日誌框架就不直接加載日誌的配置項，而是由SpringBoot解析日誌配置，此時可以使用SpringBoot的高級Profile功能。

• 使用Profile可以指定某段配置只在某個環境下生效。

	   <springProfile name="dev">
	       <!--  configuration to be enabled when the "staging" profile is active -->
	       <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} ----->[%thread] %-5level %logger{50} - %msg%n</pattern>
	   </springProfile>

4.3 切換日誌框架(不推薦)

SpringBoot框架採用了slf4j+logback的日誌選型，如果仍然希望使用slf4j+log4j的技術選型，需要進行日誌框架的切換，可以按照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>
		<exclusion>
			<artifactId>log4j‐over‐slf4j</artifactId>
			<groupId>org.slf4j</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>