SpringBoot Logback日志配置

Logback的配置介紹:

1、Logger、appender及layout

Logger作為日志的記錄器，把它關聯到應用的對應的context上后，主要用於存放日志對象，也可以定義日志類型、級別。

Appender主要用於指定日志輸出的目的地，目的地可以是控制台、文件、遠程套接字服務器、 MySQL、 PostreSQL、 Oracle和其他數據庫、 JMS和遠程UNIX Syslog守護進程等。

Layout 負責把事件轉換成字符串，格式化的日志信息的輸出。

2、logger context

各個logger 都被關聯到一個 LoggerContext，LoggerContext負責制造logger，也負責以樹結構排列各 logger。其他所有logger也通過org.slf4j.LoggerFactory 類的靜態方法getLogger取得。 getLogger方法以 logger 名稱為參數。用同一名字調用LoggerFactory.getLogger 方法所得到的永遠都是同一個logger對象的引用。

3、有效級別及級別的繼承

Logger 可以被分配級別。級別包括：TRACE、DEBUG、INFO、WARN 和 ERROR，定義於 ch.qos.logback.classic.Level類。如果 logger沒有被分配級別，那么它將從有被分配級別的最近的祖先那里繼承級別。root logger 默認級別是 DEBUG。

4、打印方法與基本的選擇規則

打印方法決定記錄請求的級別。例如，如果 L 是一個 logger 實例，那么，語句 L.info("..")是一條級別為 INFO 的記錄語句。記錄請求的級別在高於或等於其 logger 的有效級別時被稱為被啟用，否則，稱為被禁用。記錄請求級別為 p，其logger的有效級別為 q，只有則當 p>=q時，該請求才會被執行。

該規則是 logback 的核心。級別排序為： ALL < TRACE < DEBUG < INFO < WARN < ERROR < FATAL < OFF。

All()，Trace()，Debug ()，Info ()，Warn ()，Error ()，Fatal ()，Off()的作用與區別

• All：最低等級的，用於打開所有日志記錄。
  
  
• Trace：很低的日志級別，一般不會使用。
  
  
• Debug：開發者在調試的時候輸出日志，可以理解是開發的時候才會使用到，實際用戶在run狀態下是看不到這個輸出信息的。
  
  
• Info：在運行狀態下輸出日志，最終用戶使用的，這個可以用於生產環境中輸出程序運行的一些重要信息。
  
  
• Warn：警告這個時候要進行一些修復性的工作，應該還可以把系統恢復到正常狀態中來，系統應該可以繼續運行下去。
  
  
• Error：錯誤，就是說可以進行一些修復性的工作，但無法確定系統會正常的工作下去，系統在以后的某個階段，很可能會因為當前的這個問題，導致一個無法修復的錯誤（例如宕機），但也可能一直工作到停止也不出現嚴重問題。
  
  
• Fatal：那就是相當嚴重的了，可以肯定這種錯誤已經無法修復，並且如果系統繼續運行下去的話，可以肯定必然會越來越亂。這時候采取的最好的措施不是試圖將系統狀態恢復到正常，而是盡可能地保留系統有效數據並停止運行。
  
  
• Off：最高等級的，用於關閉所有日志記錄。

logback的使用:

Logback的默認配置

如果配置文件 logback-test.xml 和 logback.xml 都不存在，那么 logback 默認地會調用BasicConfigurator ，創建一個最小化配置。最小化配置由一個關聯到根 logger 的ConsoleAppender 組成。輸出用模式為%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n 的 PatternLayoutEncoder 進行格式化。root logger 默認級別是 DEBUG。

1、Logback的配置文件

Logback 配置文件的語法非常靈活。正因為靈活，所以無法用 DTD 或 XML schema 進行定義。盡管如此，可以這樣描述配置文件的基本結構：以開頭，后面有零個或多個元素，有零個或多個元素，有最多一個元素。

2、Logback默認配置的步驟

(1). 嘗試在 classpath 下查找文件 logback-test.xml；

(2). 如果文件不存在，則查找文件 logback.xml；

(3). 如果兩個文件都不存在，logback 用 Bas icConfigurator 自動對自己進行配置，這會導致記錄輸出到控制台。

3、創建springboot項目 （這里不再詳細介紹，可以閱讀：（https://www.cnblogs.com/liyhbk/p/13572989.html）

4、添加 pom 依賴

<dependencies>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-test</artifactId>
        <scope>test</scope>
        <exclusions>
            <exclusion>
                <groupId>org.junit.vintage</groupId>
                <artifactId>junit-vintage-engine</artifactId>
            </exclusion>
        </exclusions>
    </dependency>
    <!--logback-->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-logging</artifactId>
    </dependency>
</dependencies>

5、創建 TestController

package com.liyh.controller;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

/**
 * @Author: liyh
 * @Date: 2020/9/1 17:32
 */
@RestController
public class TestController {

    Logger logger = LoggerFactory.getLogger(TestController.class);

    @RequestMapping("/")
    public String query() {
        logger.debug("這個是debug測試來的數據");
        logger.info("這個是info測試來的數據");
        logger.warn("這個是warn測試來的數據");
        logger.error("這個是error測試來的數據");
        return "Hello Liyh";
    }

}

6、application.yml 文件

server:
  port: 8080

#打印sql
logging:
  level:
    com.mapper: debug

7、Logback.xml 文件

在src/main/resources下添加Logback.xml，目錄如下：

 

 內容如下：

<?xml version="1.0" encoding="UTF-8"?>
<configuration debug="false">
    <!--定義日志文件的存儲地址 勿在 LogBack 的配置中使用相對路徑-->
    <property name="LOG_HOME" value="/logs"/>

    <!-- 彩色日志 -->
    <!-- 彩色日志依賴的渲染類 -->
    <conversionRule conversionWord="clr" converterClass="org.springframework.boot.logging.logback.ColorConverter"/>
    <conversionRule conversionWord="wex"
                    converterClass="org.springframework.boot.logging.logback.WhitespaceThrowableProxyConverter"/>
    <conversionRule conversionWord="wEx"
                    converterClass="org.springframework.boot.logging.logback.ExtendedWhitespaceThrowableProxyConverter"/>
    <!-- 彩色日志格式 -->
    <property name="CONSOLE_LOG_PATTERN"
              value="${CONSOLE_LOG_PATTERN:-%clr(%d{yyyy-MM-dd HH:mm:ss.SSS}){faint} %clr(${LOG_LEVEL_PATTERN:-%5p}) %clr(${PID:- }){magenta} %clr(---){faint} %clr([%15.15t]){faint} %clr(%-40.40logger{39}){cyan} %clr(:){faint} %m%n${LOG_EXCEPTION_CONVERSION_WORD:-%wEx}}"/>
    <!-- Console 輸出設置 -->
    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <pattern>${CONSOLE_LOG_PATTERN}</pattern>
            <charset>utf8</charset>
        </encoder>
    </appender>

    <!-- 不用彩色控制台輸出 -->
    <!--<appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            &lt;!&ndash;格式化輸出：%d表示日期，%thread表示線程名，%-5level：級別從左顯示5個字符寬度%msg：日志消息，%n是換行符&ndash;&gt;
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
        </encoder>
    </appender>-->

    <!-- 按照每天生成日志文件 -->
    <appender name="DAYINFO" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!--日志文件輸出的文件名-->
            <FileNamePattern>${LOG_HOME}/InfoLog.%d{yyyy-MM-dd}.log</FileNamePattern>
            <!--日志文件保留天數-->
            <MaxHistory>30</MaxHistory>
        </rollingPolicy>
        <!--過濾info級別日志-->
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>info</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <!--格式化輸出：%d表示日期，%thread表示線程名，%-5level：級別從左顯示5個字符寬度%msg：日志消息，%n是換行符-->
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
        </encoder>
        <!--日志文件最大的大小-->
        <triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
            <MaxFileSize>10MB</MaxFileSize>
        </triggeringPolicy>
    </appender>

    <appender name="DAYWARN"  class="ch.qos.logback.core.rolling.RollingFileAppender">
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!--日志文件輸出的文件名-->
            <FileNamePattern>${LOG_HOME}/WarnLog.%d{yyyy-MM-dd}.log</FileNamePattern>
            <!--日志文件保留天數-->
            <MaxHistory>30</MaxHistory>
        </rollingPolicy>
        <!--過濾warn級別日志-->
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>warn</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <!--格式化輸出：%d表示日期，%thread表示線程名，%-5level：級別從左顯示5個字符寬度%msg：日志消息，%n是換行符-->
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
        </encoder>
        <!--日志文件最大的大小-->
        <triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
            <MaxFileSize>10MB</MaxFileSize>
        </triggeringPolicy>
    </appender>

    <appender name="DAYERROR"  class="ch.qos.logback.core.rolling.RollingFileAppender">
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!--日志文件輸出的文件名-->
            <FileNamePattern>${LOG_HOME}/ErrorLog.%d{yyyy-MM-dd}.log</FileNamePattern>
            <!--日志文件保留天數-->
            <MaxHistory>30</MaxHistory>
        </rollingPolicy>
        <!--過濾error級別日志-->
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>error</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <!--格式化輸出：%d表示日期，%thread表示線程名，%-5level：級別從左顯示5個字符寬度%msg：日志消息，%n是換行符-->
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
        </encoder>
        <!--日志文件最大的大小-->
        <triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
            <MaxFileSize>10MB</MaxFileSize>
        </triggeringPolicy>
    </appender>


    <!-- 日志輸出級別 -->
    <root level="INFO">
        <appender-ref ref="STDOUT"/>
        <appender-ref ref="DAYINFO"/>
        <appender-ref ref="DAYWARN"/>
        <appender-ref ref="DAYERROR" />
    </root>
</configuration>

8、通過運行程序並訪問：http://localhost:8080，可以獲得下面的日志輸出：

  

 

SpringBoot整合logback的使用完成:

項目地址：https://gitee.com/liyhGitee/springboot