spring-boot-route（十六）使用logback生產日志文件

本文轉載自查看原文 2020-10-15 12:30 446 spring-boot-route

日志是一個系統非常重要的一部分，我們經常需要通過查看日志來定位問題，今天我們一起來學習一下Spring Boot的日志系統。有很多同學習慣性的在生產代碼中使用System.out來輸出日志，這是不推薦的一種做法，因為System.out是一個同步操作，會在一定程度上影響系統性能，而Logger是一個異步操作。

Spring Boot默認的日志系統是logback，當然我們並不需要去引用logback的依賴，因為在spring-boot-starter中已經應用了logback的依賴。

一、控制台日志信息介紹

1.1 日志級別

日志級別從高到低為：TRACE < DEBUG < INFO < WARN < ERROR < ALL < OFF。

如果日志設置為ERROR，那么低於ERROR級別的日志將不會輸出。

如果我們想要設置某個包的日志級別，則在pom文件中加入下面這行配置：

logging:
  level:
  	# 包名
    com.javatrip: warn

如果想修改Spring Boot默認級別，則將包名改為root。

logging:
  level:
    root: warn

1.2 控制台日志介紹

默認情況下，Spring Boot會將INFO級別的日志輸出到控制台。控制台輸出信息如下：

日志輸出內容具體含義如下：

時間日期：精確到毫秒
日志級別：ERROR, WARN, INFO, DEBUG or TRACE
進程ID
分隔符：--- 標識實際日志的開始
線程名：方括號括起來（可能會截斷控制台輸出）
Logger名：通常使用源代碼的類名
日志內容

二、日志文件輸出

在實際項目中，我們需要將日志輸出為文件，以便快速定位問題。Spring Boot關於日志文件的信息可以參考官網https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#boot-features-logging。

Because the standard logback.xml configuration file is loaded too early, you cannot use extensions in it. You need to either use logback-spring.xml or define a logging.config property.

這句話的意思大概就是：由於標准的logback.xml配置文件加載得太早，因此您不能在其中使用擴展名。您需要使用logback-spring.xml或定義logging.config屬性。

因此我們來定義一個logback-spring.xml的文件來進行日志信息的配置。

logback-spring.xml文件定義及注釋：

<?xml version="1.0" encoding="UTF-8"?>
<configuration>
    <!-- 日志文件名 -->
    <property name="LOG_FILE" value="myLog" />
    <!-- 日志文件路徑 -->
    <property name="LOG_PATH" value="D://log//dev" />
    <!-- 控制台日志輸出格式 -->
    <property name="LOG_PATTERN_CONSOLE" value="%d{yyyy-MM-dd HH:mm:ss} [%thread] %-5level %logger{50} --> %msg%n" />
    <!-- 文件日志輸出格式 -->
    <property name="LOG_PATTERN_FILE" value="%d{yyyy-MM-dd HH:mm:ss} [%thread] %-5level %logger{50} --> %msg%n" />
    <!--- 設置控制台日志 -->
    <appender name="consoleLog" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <pattern>${LOG_PATTERN_CONSOLE}</pattern>
        </encoder>
    </appender>
    <!-- 設置日志文件 -->
    <appender name="fileLog" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <encoder>
            <pattern>${LOG_PATTERN_FILE}</pattern>
        </encoder>
		<!-- 總文件日志 -->
        <file>${LOG_PATH}/${LOG_FILE}.log</file>
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!-- 每天的文件日志 -->
            <fileNamePattern>${LOG_PATH}/${LOG_FILE}-%d{yyyy-MM-dd}.log</fileNamePattern>
            <!-- 日志文件保存7天，超過7天的自動刪除 -->
            <maxHistory>7</maxHistory>
        </rollingPolicy>
    </appender>

    <!-- 設置日志級別，及需要記錄日志的類 -->
    <root level="INFO">
        <appender-ref ref="consoleLog" />
        <appender-ref ref="fileLog" />
    </root>
</configuration>

啟動項目后，在D:\log\dev中會生產我們的日志文件myLog.log，加入我們系統一直運行，則在我們的文件目錄下會生成一個myLog.log文件和7個最近日志的文件myLog-某年-某月-某日.log。