springboot六：logback日誌功能的實現

 在開發中，我們需要對一些信息進行日誌記錄，方便我們後期查找問題。springboot已經集合了一些日誌的基本功能，所以我們也不需要額外增加新的依賴，我們啓動的時候控制檯都可以看到一堆日誌文件。日誌的常用級別是TRACE<DEBUG<INFO<WARN<ERROR。

接下來我們用一個測試類來測試Springboot的日誌功能。

@ActiveProfiles("dev")
@SpringBootTest(classes = Application.class)
@RunWith(SpringRunner.class)
@Slf4j
public class LogTest {

    @Test
    public void logger(){
        log.debug("this is debug msg 1");
        log.info("this is info msg 1");
        log.warn("this is warn msg 1");
        log.error("this is error msg 1");
    }
}

 我們在控制檯打印出來的結果是

Springboot默認的日誌級別是info，即只會打印info及其級別以上的消息。

我們如果想要把日誌記錄到文件，就需要使用配置了。在resource目錄下新建一個logback-spring.xml的文件（logback.xml也可以，不過帶spring後綴我們可以使用springProfile這個節點）。

<?xml version="1.0" encoding="UTF-8"?>
<configuration>

    <!--可以被調用的定義變量，用${}調用-->
    <property name="LOG_HOME" value="/logs"/>
    <property name="APP_NAME" value="spring-compete"/>

    <!-- appender是configuration的子節點，是負責寫日誌的組件。 -->
    <!-- ConsoleAppender：把日誌輸出到控制檯 -->
    <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <!--設置日誌格式,%d時間，%thread線程，%-5level日誌級別，%logger{50}日誌所在的類，%msg日誌信息，%n換行-->
            <pattern>
                %d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n
            </pattern>
        </encoder>
    </appender>

    <!--滾動記錄文件 info級別-->
    <!-- RollingFileAppender：滾動記錄文件，先將日誌記錄到指定文件，當符合某個條件時，將日誌記錄到其他文件 -->
    <appender name="INFO" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!-- 日誌記錄器的滾動策略，按日期，按大小記錄，會根據日期和大小生成1個或多個文件 -->
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <fileNamePattern>${LOG_HOME}/${APP_NAME}.%d{yyyy-MM-dd}.info.%i.log</fileNamePattern>
            <!-- 日誌保留天數 -->
            <maxHistory>30</maxHistory>
            <timeBasedFileNamingAndTriggeringPolicy  class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <!-- maxFileSize:這是活動文件的大小，默認值是10MB，測試時可以改爲10KB看看分割 -->
                <maxFileSize>1MB</maxFileSize>
            </timeBasedFileNamingAndTriggeringPolicy>
        </rollingPolicy>
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <pattern>
                %d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n
            </pattern>
            <charset>UTF-8</charset>
        </encoder>
        <!--設置記錄的日誌級別-->
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>INFO</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>
    </appender>

    <!--滾動記錄文件 warn級別-->
    <appender name="WARN" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <fileNamePattern>${LOG_HOME}/${APP_NAME}.%d{yyyy-MM-dd}.warn.%i.log</fileNamePattern>
            <!-- 每產生一個日誌文件，該日誌文件的保存期限爲30天 -->
            <maxHistory>30</maxHistory>
            <timeBasedFileNamingAndTriggeringPolicy  class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <!-- maxFileSize:這是活動文件的大小，默認值是10MB -->
                <maxFileSize>1MB</maxFileSize>
            </timeBasedFileNamingAndTriggeringPolicy>
        </rollingPolicy>
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <pattern>
                %d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n
            </pattern>
            <charset>UTF-8</charset>
        </encoder>
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>WARN</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>
    </appender>

    <!--滾動記錄文件 error級別-->
    <appender name="ERROR" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <fileNamePattern>${LOG_HOME}/${APP_NAME}.%d{yyyy-MM-dd}.error.%i.log</fileNamePattern>
            <!-- 每產生一個日誌文件，該日誌文件的保存期限爲30天 -->
            <maxHistory>30</maxHistory>
            <timeBasedFileNamingAndTriggeringPolicy  class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <!-- maxFileSize:這是活動文件的大小，默認值是10MB -->
                <maxFileSize>1MB</maxFileSize>
            </timeBasedFileNamingAndTriggeringPolicy>
        </rollingPolicy>
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <pattern>
                %d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n
            </pattern>
            <charset>UTF-8</charset>
        </encoder>
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>ERROR</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>
    </appender>

    <root level="INFO">
        <appender-ref ref="CONSOLE" />
        <appender-ref ref="INFO" />
        <appender-ref ref="WARN" />
        <appender-ref ref="ERROR" />
    </root>

    <!--springProfile用於切換環境-->
    <!--開發環境  -->
    <springProfile name="dev">
        <logger name="com.demo" level="debug" additivity="false">
            <appender-ref ref="CONSOLE" />
            <appender-ref ref="INFO" />
            <appender-ref ref="WARN" />
            <appender-ref ref="ERROR" />
        </logger>
    </springProfile>
</configuration>

啓動測試類生產的文件，下面的測試的時候做了50kb分割，多次測試日誌加起來大於50KB。

我們對不同環境的日誌配置可能有不同的需求，我們可以對上面的做一下修改，首先在配置文件application-dev.yml增加配置

log:
  rootPath: /data/logs/compete

    <!--可以取到yml文件中的值-->
    <springProperty name="LOG_HOME" source="log.rootPath" scope="context"/>

    <!--springProfile用於切換環境-->
    <!--開發環境  -->
    <springProfile name="dev">
        <logger name="com.demo" level="debug" additivity="false">
            <appender-ref ref="CONSOLE" />
            <appender-ref ref="INFO" />
            <appender-ref ref="WARN" />
            <appender-ref ref="ERROR" />
        </logger>
        <!--root節點可以放在外面或者每個環境下面-->
        <root level="INFO">
            <appender-ref ref="CONSOLE" />
            <appender-ref ref="INFO" />
            <appender-ref ref="WARN" />
            <appender-ref ref="ERROR" />
        </root>
    </springProfile>

可以看到日誌文件的位置已經換了，和配置結果裏一樣