SpringBoot輸出日志到文件

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

本文由博客群發一文多發等運營工具平台 OpenWrite 發布