【SpringBoot】整合日志框架

• 一、日志框架概述
  • 1.1 日志框架的產生
  • 1.2 市面上的日志框架
• 二、SLF4j 使用與整合
  • 2.1 如何在系統中使用SLF4j
  • 2.2 如何整合日志框架
  • 2.3 SpringBoot中的日志關系
• 三、日志使用
  • 3.1 默認配置
  • 3.2 日志格式
  • 3.2 指定配置
• 四、切換日志框架

一、日志框架概述

1.1 日志框架的產生

• 假想，你是某一公司的大型系統的項目經歷，你想要記錄系統運行是的一些信息：
  • 首先想到的是利用 System.out.println("") 將關鍵數據打印在控制台，但是這樣着實是太麻煩，
  • 於是你就想將其日志信息輸入到文件中，於是開發了一個框架來記錄系統的一些運行時信息，這就是初代的日志框架zhanglogging.jar;
  • 后來你又想為其加入幾個高級功能（異步模式、自動歸檔等等）zhanglogging-good.jar，於是第二代框架開發完畢但是由於系統用了初代的日志框架，將以前框架卸下來的話，換上新的框架，但是這樣會有很大的工作量。
  • 為了以后框架的靈活性，於是你又重新修改之前相關API;這時想到了JDBC 數據庫驅動的設計思路，設計出了 zhanglogging-prefect.jar;

1.2 市面上的日志框架

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



• 左邊選一個門面(抽象層)、右邊來選一個實現。
  • 日志門面: SLF4J;
  • 日志實現: Logback;
• SpringBoot:底層是Spring框架，Spring框架默認是用JCL;
• SpringBoot 選用SLF4j和logback;

二、SLF4j 使用與整合

2.1 如何在系統中使用SLF4j

官網地址

• 以后開發的時候,日志記錄方法的調用，不應該來直接調用日志的實現類，而是調用日志抽象層里面的方法; 給系統里面導入slf4j的jar和 logback的實現jar



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

2.2 如何整合日志框架

• SpringBoot中默認使用的日志框架slf4j+logback ，但是 Spring 中默認用commons-logging、Hibernate默認用jboss-logging ... ，
• SpringBoot中 如何 統一日志記錄，即使是別的框架和我一起統一使用slf4j進行輸出?
• 從下圖可以看出，要將原來的日志框架替換成與其相對應的sf4j日志轉換包就可以了。圖片來源



• 如何讓系統中所有的日志都統一到slf4j;
• 1、將系統中其他日志框架先排除出去;
• 2、用中間包來替換原有的日志框架;
• 3、我們導入slf4j其他的實現

2.3 SpringBoot中的日志關系

<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;

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

三、日志使用

3.1 默認配置

• SpringBoot默認幫我們配置好了日志;

Logger logger = LoggerFactory.getLogger(getClass());
    
    @Test
    public void logTest1() {
        //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日志...");
    }

3.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

SpringBoot修改日志的默認配置

# 不指定路徑在當前項目下生成springboot.log日志
logging.path=
# 可以指定完整的路徑；
# 使用 spring.log 作為默認文件
#logging.file=G:/springboot.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.2 指定配置

• 給類路徑下放上每個日志框架自己的配置文件即可;SpringBoot就不使用他默認配置的了



• logback.xml:直接就被日志框架識別了;
• logback-spring.xml:日志框架就不直接加載日志的配置項，由SpringBoot解析日志配置，可以使用SpringBoot的高級Profile功能。
• 如，下面可以可以指定某段配置只在某個環境下生效

 <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>

• 如果使用logback.xml作為日志配置文件的名稱，還要使用profile功能，會有以下錯誤
• no applicable action for [springProfile]

四、切換日志框架

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