一 SpringBoot默認日誌配置

SpringBoot爲Java Util Logging，Log4J2和Logback提供了默認配置。SpringBoot默認配置日誌輸出到控制檯，同時還提供可選文件輸出。
SpringBoot默認採用SLF4j（日誌抽象層）+ Logback（日誌實現）的組合。

1.1 日誌輸出實戰

新創建SpringBoot工程，起名爲spring-boot-logging

先直接運行程序，看控制檯的輸出

可以看到，在不做任何配置的情況下，控制檯已經有日誌輸出了。這也印證了我們前面所說的。

接下來在測試類中使用一下SpringBoot的日誌：

package com.yky.springboot;

import org.junit.jupiter.api.Test;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.boot.test.context.SpringBootTest;

@SpringBootTest
class SpringBootLoggingApplicationTests {

    private Logger logger = LoggerFactory.getLogger(getClass());
    @Test
    void contextLoads() {
        logger.info("這是info級別的日誌");
    }

}

注：這裏使用的Logger的全類名是org.slf4j.Logger

輸出結果

1.2 控制檯輸出

通過上面的驗證，可以得出結論：
SpringBoot的日誌記錄器，默認情況下在控制檯輸出以下項目：

日期和時間：毫秒精度，易於排序。
日誌級別：ERROR，WARN，INFO，DEBUG，或TRACE。
進程ID。
一個—分隔符來區分實際日誌消息的開始。
線程名稱：用方括號括起來（對於控制檯輸出可能會被截斷）。
記錄器名稱：這通常是源類名稱（通常縮寫）。
日誌消息。

1.3 文件輸出

SpringBoot默認情況下只在控制檯輸出日誌。要想讓它輸出日誌到文件，需要更改其默認配置，此時需要設置logging.file.name或logging.file.path的屬性值。

logging.file.name	logging.file.path	示例	描述
null	null		只在控制檯輸出
給定值	null	my.log	寫入指定的日誌文件。名稱可以是確切位置，也可以是相對於當前目錄的位置。
null	給定值	/var/log	寫入日誌到指定目錄，名稱可以是確切位置，也可以是相對於當前目錄的位置，文件名爲springboot.log
給定值	給定值		同時賦值，優先採用logging.file.name

SpringBoot默認配置單個日誌文件大小限定爲10M，當單個文件達到所設定的最大大小時，將會產生一個備份文件，並創建一個新的日誌文件重新記錄當前日誌。可以通過更改logging.file.max-size屬性更改大小限制。

注意：

與控制檯輸出一樣，默認情況下會記錄ERROR-level，WARN-level和INFO-level的日誌消息。
除非logging.file.max-history已設置屬性，否則將會無限期存檔。
日誌檔案的總大小可以通過設置logging.file.total-size-cap的值來限定。當日志歸檔的總大小超過該閾值時，將刪除備份。要在應用程序啓動時強制清除日誌存檔，請使用logging.file.clean-history-on-start屬性。

上面全是在講理論，接下來實踐一下，在resources目錄新創建application.yml文件並寫入以下內容：

logging:
  file:
    name: /Users/yky/springboot/log/my.log

運行測試程序看一下：

二常用日誌配置的修改

2.1 輸出級別

日誌記錄器包含以下級別（級別由低到高）：

級別	示例	說明
trace	logger.trace(“消息內容”)	跟蹤運行信息
debug	logger.debug(“消息內容”)	調試信息
info	logger.info(“消息內容”)	自定義信息
warn	logger.warn(“消息內容”)	警告信息
error	logger.error(“消息內容”)	錯誤信息

驗證一下：

		logger.trace("這是trace級別的日誌");
        logger.debug("這是debug級別的日誌");
        logger.info("這是info級別的日誌");
        logger.warn("這是warn級別的日誌");
        logger.error("這是error級別的日誌");

控制檯輸出結果：

日誌文件輸出結果：

可以看到，無論是控制檯還是文件，都只輸出了高於等於INFO級別的日誌，這是因爲SpringBoot默認配置的日誌輸出級別是INFO級別。若想修改日誌輸出級別可以通過設置“logging.level.root”屬性設置全局日誌輸出級別，還可以通過設置“logging.level.包名”設置某個包下的日誌輸出級別。

logging:
  file:
    name: /Users/yky/springboot/log/my.log
  level:
    root: debug

在設置了全局日誌輸出級別爲DEBUG後，可以看到高於等於DEBUG級別的日誌被打印了出來：

還可以針對某個包，設置其日誌級別，比如設定com.yky.springboot包下的日誌記錄器的日誌輸出級別爲trace：

logging:
  file:
    name: /Users/yky/springboot/log/my.log
  level:
    root: info
    com.yky.springboot: trace

控制檯輸出結果：

文件輸出結果：

從這裏可以看出，當logging.level.root和logging.level.包名屬性同時被設置時，前者不會覆蓋掉後者。

2.2 修改日誌輸出格式

可以通過設置logging.pattern.console和logging.pattern.file分別配置日誌輸出到控制檯以及輸出到文件的格式。

logging:
  file:
    name: /Users/yky/springboot/log/my.log
  level:
    com.yky.springboot: trace
    root: info
  pattern:
    console: "%d{yyyy-MM-dd HH:mm:ss.SSS} >>> [%thread] >>> %-5level >>> %logger{50} >>> %msg%n"
    file: "%d{yyyy-MM-dd HH:mm:ss.SSS} --- [%thread] --- %-5level --- %logger{50} --- %msg%n"

%d{yyyy-MM-dd HH:mm:ss.SSS}——日誌輸出時間
%thread——輸出日誌的進程名字
%-5level——日誌級別，並且使用5個字符靠左對齊
%logger——日誌全類名長度限定爲50
%msg——日誌消息
%n——平臺的換行符

控制檯輸出效果：

文件輸出效果：

2.3 日誌滾動輸出

和日誌滾動輸出有關的屬性有下面這幾個：

logging.file.max-size:單個日誌文件的最大大小(大於此大小時，保留日誌存檔，並創建一個新的日誌文件)，默認10M
logging.file.max-history:設置最大存檔數，如果不設置此項，則會無限存檔(SpringBoot 2.1+默認爲7)。
logging.file.total-size-cap:配置日誌的總大小，超過此大小將刪除備份

上面的屬性介紹完了，接下來實戰一下。爲了方便看到效果，設置logging.file.max-size爲10KB，設置logging.file.max-history爲3，並清空之前的日誌文件：

logging:
  file:
    name: /Users/yky/springboot/log/my.log
    max-history: 3
    max-size: 10KB
  level:
    com.yky.springboot: trace
    root: info
  pattern:
    console: "%d{yyyy-MM-dd HH:mm:ss.SSS} >>> [%thread] >>> %-5level >>> %logger{50} >>> %msg%n"
    file: "%d{yyyy-MM-dd HH:mm:ss.SSS} --- [%thread] --- %-5level --- %logger{50} --- %msg%n"

運行幾次程序後看一下效果:

可以看到，在日誌大小達到特定大小時，SpringBoot會將當前存檔壓縮備份，並新創建一個log文件，重新存儲當前日誌。

解壓一下壓縮文件，看一看壓縮前的大小，正是我們所期望的(當存儲完某一條日誌後發現文件大小超出了10KB，此時才觸發滾動輸出操作，所以在這裏看到的大小比10KB大一點點):

2.4 總結

SpringBoot官方文檔對日誌配置這一塊兒給出了很詳細的說明：

文檔鏈接：SpringBoot日誌配置

三自定義日誌配置

3.1 爲什麼要自定義日誌配置

爲什麼要用到SpringBoot的自定義日誌配置？在開始之前肯定要先搞清楚這一點。
原因很簡單：當SpringBoot提供的日誌功能滿足不了我們的需求時，就需要用到自定義日誌配置了（比如高併發環境下，爲了儘可能的不讓日誌拖慢程序運行速度，需要將Logback配置成異步日誌記錄器）。

3.2 自定義日誌配置

SpringBoot支持自定義日誌配置，正如官方文檔裏所說：

如果想要使用自動義配置文件（當使用Logback作爲日誌實現時），只需要在配置文件目錄下給出logback-spring.xml, logback-spring.groovy, logback.xml, or logback.groovy這幾個文件中的某一個配置文件即可。

在這裏推薦使用logback-spring.xml文件作爲自定義配置文件的文件名：因爲在使用logback-spring.xxxx時，會先將配置送由SpringBoot進行解析（比如要想支持Profile特殊配置，必須命名爲logback-spring.xxxx這種形式），而在使用logback.xml時，配置文件將直接被日誌框架加載。使用logback-spring.xxxx將使SpringBoot得到完全控制權。
在resources目錄下創建logback-spring.xml並寫入以下內容：

<?xml version="1.0" encoding="UTF-8"?>
<!--
scan：當此屬性設置爲true時，配置文件如果發生改變，將會被重新加載，默認值爲true。
scanPeriod：設置監測配置文件是否有修改的時間間隔，如果沒有給出時間單位，默認單位是毫秒當scan爲true時，此屬性生效。默認的時間間隔爲1分鐘。
debug：當此屬性設置爲true時，將打印出logback內部日誌信息，實時查看logback運行狀態。默認值爲false。
-->
<configuration scan="false" scanPeriod="60 seconds" debug="false">
    <!-- 定義日誌的根目錄 -->
    <property name="LOG_HOME" value="/Users/yky/springboot/log" />
    <!-- 定義日誌文件名稱 -->
    <property name="appName" value="my-log"></property>
    <!-- ch.qos.logback.core.ConsoleAppender 表示控制檯輸出 -->
    <appender name="stdout" class="ch.qos.logback.core.ConsoleAppender">
        <!--
			日誌輸出格式說明：
				    %d 		輸出日期時間
				    %thread 輸出當前線程名
				    %-5level  	輸出日誌級別，左對齊5個字符寬度
				    %logger{50} 輸出全類名最長50個字符，超過按照句點分割
				    %msg  	日誌信息
				    %n    	換行符
        -->
        <layout class="ch.qos.logback.classic.PatternLayout">
<!--            支持根據不同的環境做選擇-->
            <springProfile name="dev">
                <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [ %thread ] - [ %-5level ] [ %logger{50} : %line ] - %msg%n</pattern>
            </springProfile>
            <springProfile name="!dev">
                <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [ %thread ] >>> [ %-5level ] [ %logger{50} : %line ] >>> %msg%n</pattern>
            </springProfile>
        </layout>
    </appender>

    <!-- 滾動記錄文件，先將日誌記錄到指定文件，當符合某個條件時，將日誌記錄到其他文件 -->  
    <appender name="appLogAppender" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!-- 指定日誌文件的名稱 -->
        <file>${LOG_HOME}/${appName}.log</file>
        <!--
        當發生滾動時，決定 RollingFileAppender 的行爲，涉及文件移動和重命名
        TimeBasedRollingPolicy： 最常用的滾動策略，它根據時間來制定滾動策略，既負責滾動也負責出發滾動。
        -->
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!--
				滾動時產生的文件的存放位置及文件名稱 %d{yyyy-MM-dd}：按天進行日誌滾動 
				%i：當文件大小超過maxFileSize時，按照i進行文件滾動
            -->
            <fileNamePattern>${LOG_HOME}/${appName}-%d{yyyy-MM-dd}-%i.log</fileNamePattern>
            <!-- 
            可選節點，控制保留的歸檔文件的最大數量，超出數量就刪除舊文件。
			假設設置每天滾動，且maxHistory是365，則只保存最近365天的文件，刪除之前的舊文件。
			注意，刪除舊文件是，那些爲了歸檔而創建的目錄也會被刪除。
            -->
            <MaxHistory>365</MaxHistory>
            <!-- 
            當日志文件超過maxFileSize指定的大小是，根據上面提到的%i進行日誌文件滾動 注意此處配置SizeBasedTriggeringPolicy是無法實現按文件大小進行滾動的，必須配置timeBasedFileNamingAndTriggeringPolicy
            -->
            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <maxFileSize>100MB</maxFileSize>
            </timeBasedFileNamingAndTriggeringPolicy>
        </rollingPolicy>
        <!-- 日誌輸出格式： -->     
        <layout class="ch.qos.logback.classic.PatternLayout">
            <springProfile name="dev">
                <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [ %thread ] - [ %-5level ] [ %logger{50} : %line ] - %msg%n</pattern>
            </springProfile>
            <springProfile name="!dev">
                <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [ %thread ] >>> [ %-5level ] [ %logger{50} : %line ] >>> %msg%n</pattern>
            </springProfile>
        </layout>
    </appender>

    <!-- 
		logger主要用於存放日誌對象，也可以定義日誌類型、級別
		name：表示匹配的logger類型前綴，也就是包的前半部分
		level：要記錄的日誌級別，包括 TRACE < DEBUG < INFO < WARN < ERROR
		additivity：作用在於children-logger是否使用 rootLogger配置的appender進行輸出，
		false：表示只用當前logger的appender-ref，true：
		表示當前logger的appender-ref和rootLogger的appender-ref都有效
    -->
    <!-- hibernate logger -->
    <logger name="com.yky" level="debug"/>
    <!-- Spring framework logger -->
    <logger name="org.springframework" level="debug" additivity="false"></logger>


    <!-- 
    root與logger是父子關係，沒有特別定義則默認爲root，任何一個類只會和一個logger對應，
    要麼是定義的logger，要麼是root，判斷的關鍵在於找到這個logger，然後判斷這個logger的appender和level。 
    -->
    <root level="info">
        <appender-ref ref="stdout" />
        <appender-ref ref="appLogAppender" />
    </root>
</configuration>

在上面的配置中，還用到了Profile特殊配置。使用Profile特殊配置，可根據不同的環境激活不同的日誌配置：

生產環境下的日誌輸出：

開發環境下的日誌輸出：

關於SpringBoot的日誌配置就寫到這裏，如果有什麼紕漏，歡迎在評論區指出。

SpringBoot學習篇2[日誌配置]

目錄

一 SpringBoot默認日誌配置

1.1 日誌輸出實戰

1.2 控制檯輸出

1.3 文件輸出

二常用日誌配置的修改

2.1 輸出級別

2.2 修改日誌輸出格式

2.3 日誌滾動輸出

2.4 總結

三自定義日誌配置

3.1 爲什麼要自定義日誌配置

3.2 自定義日誌配置

換個姿勢聊一聊CRUD

教你如何使用IDEA + Maven 搭建SSM Web項目(超詳細)

Qt之QTimer(定時器)

SpringBoot學習篇2[日誌配置]

MyBatis教程[4]----分頁原理及實現

https://yachay.unat.edu.pe/blog/index.php?comment_area=format_blog&comment_component=blog&comment_co

linux以太網驅動總結

SpringBoot學習篇2[日誌配置]

目錄

一 SpringBoot默認日誌配置

1.1 日誌輸出實戰

1.2 控制檯輸出

1.3 文件輸出

二 常用日誌配置的修改

2.1 輸出級別

2.2 修改日誌輸出格式

2.3 日誌滾動輸出

2.4 總結

三 自定義日誌配置

3.1 爲什麼要自定義日誌配置

3.2 自定義日誌配置

二常用日誌配置的修改

三自定義日誌配置