1 基本資訊

• SpringBoot版本2.2.5
• 日誌框架SLF4J
• 日誌框架的實現LockBack

2 輸出檔案的配置

2.1 logging.file.name

指定日誌檔案的位置。

2.1.1 例1

使用相對路徑，就會在專案根目錄下生成一個lab.log檔案

logging:
  file:
    name: lab.log

2.1.1 例2

在專案根目錄下生成一個logs資料夾，logs資料夾裡面生成一個lab.log檔案。

logging:
  file:
    name: logs/lab.log

2.1.1 例3

使用絕對路徑，這樣寫會在D盤下建立一個logs資料夾，logs資料夾裡面生成一個lab.log檔案。

logging:
  file:
    name: D:/logs/lab.log

2.2 logging.file.path

2.2.1 指定路徑時生成的檔名為spring.log

2.2.2 例1

使用相對路徑，會在專案根目錄下生成一個logs資料夾，logs資料夾會有一個spring.log檔案。

logging:
  file:
    path: logs

2.2.2 例2

使用絕對路徑，會在D盤下生成一個logs資料夾，logs資料夾會有一個spring.log檔案。

logging:
  file:
    name: D:/logs

2.3 注意

logging.file.name和logging.file.path不要同時指定，只需要指定一個。

相對路徑不指定碟符，直接在專案根目錄下生成

3 使用xml擴充套件

在resources目錄下建立logback-spring.xml配置檔案。

使用xml配置可以完成yml配置實現不了的功能，比如按天將日誌歸檔。

xml有多種命名形式，但官方推薦的命名是logback-spring.xml

<?xml version="1.0" encoding="UTF-8"?>
<configuration scan="true" scanPeriod="60 seconds" debug="false">
    <contextName>logback</contextName>

    <!--控制檯輸出內容的顏色轉換以及格式-->
    <substitutionProperty name="logging.pattern.console"
                          value="%clr(%d{${LOG_DATEFORMAT_PATTERN:-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}"/>
    <!--日誌檔案輸出內容的格式-->
    <substitutionProperty name="logging.pattern.file"
                          value="%d{${LOG_DATEFORMAT_PATTERN:-yyyy-MM-dd HH:mm:ss.SSS}} ${LOG_LEVEL_PATTERN:-%5p} ${PID:- } --- [%t] %-40.40logger{39} : %m%n${LOG_EXCEPTION_CONVERSION_WORD:-%wEx}"/>

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

    <!--輸出到控制檯-->
    <appender name="console" class="ch.qos.logback.core.ConsoleAppender">
        <!--控制檯使用layout節點-->
        <layout class="ch.qos.logback.classic.PatternLayout">
            <pattern>
                ${logging.pattern.console}
            </pattern>
        </layout>
    </appender>

    <!--按天生成日誌-->
    <appender name="file" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <Prudent>true</Prudent>
        <!--滾動策略，我配置了按天生成日誌檔案-->
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!--相對路徑，生成的檔案就在專案根目錄下-->
            <FileNamePattern>
                logs/%d{yyyy-MM}/%d{yyyy-MM-dd}.log
            </FileNamePattern>
            <!--注意超過365天的日誌檔案會被刪除，即使已經按天分開也會刪除-->
            <MaxHistory>365</MaxHistory>
        </rollingPolicy>
        <!--日誌檔案裡只儲存ERROR及以上級別的日誌-->
        <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
            <level>ERROR</level>
        </filter>
        <!--檔案使用encoder節點-->
        <encoder>
            <Pattern>
                ${logging.pattern.file}
            </Pattern>
        </encoder>
    </appender>

    <!--這個logger裡的配置相當於之前yml裡的logging.level.com.lpc: trace-->
    <!--additivity的作用-->
    <!--true，則子Logger不止會在自己的appender裡輸出，還會在root的logger的appender裡輸出-->
    <!--而這個logger裡沒配置appender，所以得交給root列印-->
    <!--所以com.lpc包裡的日誌從TRACE級別開始-->
    <!--其他包裡的日誌根據root的配置從INFO級別開始列印-->
    <logger name="com.lpc" level="TRACE" additivity="true">
    </logger>

    <root level="INFO">
        <appender-ref ref="console"/>
        <appender-ref ref="file"/>
    </root>

</configuration>
 

其中，兩個的value屬性是yml的logging.pattern.console和logging.pattern.file的預設值粘貼出來的。xml檔案放在了resources.config目錄下。日誌檔案輸出在專案根目錄下的logs資料夾下。

這個xml配置實現了：

1. 控制檯輸出日誌，同時將日誌儲存到檔案裡；
2. 保持控制檯日誌的彩色；
3. 按月建日誌資料夾，按天建日誌檔案；
4. com.lpc包下的日誌從TRACE級別開始輸出，其他包（比如tomcat的日誌，SpringSecurity的日誌）從INFO級別開始輸出。跟原來yml裡面配置logging.level.com.lpc: trace的輸出結果保持一致。

4 logging裡的預設值

logging.pattern.console

%clr(%d{${LOG_DATEFORMAT_PATTERN:-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}

logging.pattern.file

%d{${LOG_DATEFORMAT_PATTERN:-yyyy-MM-dd HH:mm:ss.SSS}} ${LOG_LEVEL_PATTERN:-%5p} ${PID:- } --- [%t] %-40.40logger{39} : %m%n${LOG_EXCEPTION_CONVERSION_WORD:-%wEx}

5 效果