1. 程式人生 > 實用技巧 >三、SpringBoot 日誌篇

三、SpringBoot 日誌篇


一、日誌框架分類和選擇

1.1、市面上的日誌框架

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

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

左邊選一個門面(抽象層)、右邊來選一個實現;

日誌門面: SLF4J;

日誌實現:Logback;

SpringBoot:底層是Spring框架,Spring 框架預設是用JCL;‘

SpringBoot選用 SLF4j和logback;


二、slf4J 使用原理

詳細參考:https://www.slf4j.org

2.1、如何在系統中使用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以後,配置檔案還是做成日誌實現框架自己本身的配置檔案;


三、其他日誌框架統一轉換為 slf4J

3.1、如何讓系統中所有的日誌都統一到 slf4j 介面 ?
  • 問題:
    a(slf4j+logback): Spring(commons-logging)、Hibernate(jboss-logging)、MyBatis、xxxx。
    統一日誌記錄,即使是別的框架和我一起統一使用slf4j進行輸出?


引入slf4j 相應的適配jar

  • 處理步驟

    1、將系統中其他日誌框架先排除出去
    2、用中間包來替換原有的日誌框架
    3、我們匯入slf4j其他的實現

四、SpringBoot 日誌關係

4.1、SpringBoot 日誌關係
  • 依賴引入:
<dependency>
	<groupId>org.springframework.boot</groupId>
	<artifactId>spring-boot-starter</artifactId>
</dependency>

<dependency>
	<groupId>org.springframework.boot</groupId>
	<artifactId>spring-boot-starter-logging</artifactId>
</dependency>
  • 底層依賴關係


統一日誌框架時的依賴關係

  • 總結
    • 1)、SpringBoot底層也是使用slf4j+logback的方式進行日誌記錄
    • 2)、SpringBoot也把其他的日誌都替換成了slf4j;
    • 3)、中間替換包?


中間替換包

4)、如果我們要引入其他框架?一定要把這個框架的預設日誌依賴移除掉?
例如:引入 spring 框架時用的是 commons-logging。一定要排除 日誌 jar 包的依賴。

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


五、SpringBoot 預設配置

5.1、預設配置
	//記錄器
	Logger logger = LoggerFactory.getLogger(getClass());
	@Test
	public void contextLoads() {
		//System.out.println();

		//日誌的級別;
		//由低到高   trace<debug<info<warn<error
		//可以調整輸出的日誌級別;日誌就只會在這個級別以以後的高級別生效
		logger.trace("這是trace日誌...");
		logger.debug("這是debug日誌...");
		//SpringBoot預設給我們使用的是info級別的,沒有指定級別的就用SpringBoot預設規定的級別;root級別
		logger.info("這是info日誌...");
		logger.warn("這是warn日誌...");
		logger.error("這是error日誌...");


	}
5.2、日誌輸出格式
日誌輸出格式:
		%d表示日期時間,
		%thread表示執行緒名,
		%-5level:級別從左顯示5個字元寬度
		%logger{50} 表示logger名字最長50個字元,否則按照句點分割。 
		%msg:日誌訊息,
		%n是換行符
    -->
    %d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n
5.3、修改日誌的預設配置
logging.level.com.atguigu=trace


#logging.path=
# 不指定路徑在當前專案下生成springboot.log日誌
# 可以指定完整的路徑;
#logging.file=G:/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

六、指定日誌檔案和日誌 Profile 功能

6.1、指定日誌配置檔案

給類路徑下放上每個日誌框架自己的配置檔案即可;SpringBoot就不使用他預設配置的了
詳細參考:https://blog.csdn.net/wangmx1993328/article/details/81044147


七、切換日誌框架

可以按照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>