springboot集成logback日志快速使用

使用：

springboot 默認選用和集成的日志實現就是logback，所有我們使用的時候無需進行額外配置

只需要創建配置文件放在resources包下即可，默認生成位置在項目目錄下

創建文件：logback.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">
    <!-- 定義日志的根目錄為項目的根目錄,前面不要加"/",加了會默認會認為是根目錄,提示 classnotfond -->
    <property name="LOG_HOME" value="app/log"/>
    <!-- 定義日志文件名稱 -->
    <property name="appName" value="logbackBootText"/>

    <!-- ConsoleAppender 用於控制台輸出 -->
    <appender name="stdout" class="ch.qos.logback.core.ConsoleAppender">
        <!--
        日志輸出格式：
            %d表示日期時間,
            %thread表示線程名,
            %-5level：級別從左顯示5個字符寬度
            %logger{50} 表示logger名字最長50個字符,否則按照句點分割。
            %msg：日志消息,
            %n是換行符
        -->
        <layout class="ch.qos.logback.classic.PatternLayout">
            <!--springProfile可以指定某段配置只在某個環境下生效-->
            <!--如果使用logback.xml作為日志配置文件,還要使用profile功能,會有以下錯誤no applicable action for [springProfile]-->
            <springProfile name="dev">
                <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} ----> [%thread] ---> %-5level %logger{50} - %msg%n</pattern>
            </springProfile>
            <springProfile name="!dev">
                <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} ==== [%thread] ==== %-5level %logger{50} - %msg%n</pattern>
            </springProfile>
        </layout>
    </appender>

    <!-- 滾動記錄文件,先將日志記錄到指定文件,當符合某個條件時,將日志記錄到其他文件 -->
    <appender name="appLogAppender" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!--定義日志輸出的路徑和名稱-->
        <!-- 指定日志文件的名稱 -->
        <!--這里的scheduler.manager.server.home 沒有在上面的配置中設定,所以會使用java啟動時配置的值-->
        <!--比如通過 java -Dscheduler.manager.server.home=/path/to XXXX 配置該屬性-->
        <!--<file>${scheduler.manager.server.home}/${LOG_HOME}/${appName}.log</file>-->


        <!--當發生滾動時,決定 RollingFileAppender 的行為,涉及文件移動和重命名
            TimeBasedRollingPolicy： 最常用的滾動策略,它根據時間來制定滾動策略,既負責滾動也負責出發滾動。“%d”可以包含一個java.text.SimpleDateFormat指定的時間格式,-->
        <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>
            <!-- 該屬性在 1.1.6版本后 才開始支持,日志量最大20GB-->
            <totalSizeCap>20GB</totalSizeCap>

            <!--當日志文件超過maxFileSize指定的大小是,根據上面提到的%i進行日志文件滾動 注意此處配置 SizeBasedTriggeringPolicy 是無法實現按文件大小進行滾動的,必須配置 timeBasedFileNamingAndTriggeringPolicy-->
            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <maxFileSize>100MB</maxFileSize>
            </timeBasedFileNamingAndTriggeringPolicy>
        </rollingPolicy>
        <!-- 日志輸出格式： -->
        <layout class="ch.qos.logback.classic.PatternLayout">
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [ %thread ] ->> [ %-5level ] [ %logger{50} : %line ] ->> %msg%n
            </pattern>
        </layout>
    </appender>

    <!-- 滾動記錄文件,先將日志記錄到指定文件,當符合某個條件時,將日志記錄到其他文件 -->
    <appender name="appLogAppenderBoot" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">

            <fileNamePattern>${LOG_HOME}/boot-${appName}-%d{yyyy-MM-dd}-%i.log</fileNamePattern>

            <MaxHistory>365</MaxHistory>

            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <maxFileSize>100MB</maxFileSize>
            </timeBasedFileNamingAndTriggeringPolicy>
        </rollingPolicy>
        <layout class="ch.qos.logback.classic.PatternLayout">
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [ %thread ] -> [ %-5level ] [ %logger{50} : %line ] -> %msg%n</pattern>
        </layout>
    </appender>

    <!--root是默認的logger,root與logger是父子關系,沒有特別定義則默認為root,任何一個類只會和一個logger對應,
    要么是定義的logger,要么是root,判斷的關鍵在於找到這個logger,然后判斷這個logger的appender和level。 -->
    <root level="DEBUG">
        <!--定義了三個appender,日志會通過往這這些appender里面寫-->
        <appender-ref ref="stdout"/>
        <appender-ref ref="appLogAppender"/>
        <appender-ref ref="appLogAppenderBoot"/>
    </root>

    <!--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都有效-->
    <!--    Spring framework logger 記錄 spring 的日志 -->
    <logger name="org.springframework.boot" level="debug" additivity="false">
        <appender-ref ref="appLogAppenderBoot"/>
　　　　　<appender-ref ref="stdout"/>
    </logger>

    <!--通過 LoggerFactory.getLogger("mytest") 可以獲取到這個logger-->
    <!--由於這個logger自動繼承了root的appender，root中已經有stdout的appender了，自己這邊又引入了stdout的appender-->
    <!--如果沒有設置 additivity="false" ,就會導致一條日志在控制台輸出兩次的情況,原因是:沒有寫additivity會用 rootlogger 輸出日志,而它下面有三個appender,單appLogAppenderBoot經過自定義,不會輸出,stdout則會打印兩遍-->
    <!--additivity表示要不要使用rootLogger配置的appender進行輸出-->
    <logger name="com.tuniu" level="debug" additivity="false">
        <!--即輸出到appLogAppender,又輸出到stdout-->
        <appender-ref ref="appLogAppender"/>
        <appender-ref ref="stdout"/>
    </logger>


    <!--對於類路徑以 com.tuniu 開頭的Logger,輸出級別設置為 warn,-->
    <!--這個logger沒有指定appender，它會繼承root節點中定義的那些appender-->
    <!--注意,如果名稱相同,兩個 logger 會有屬性互補機制;而且以最后一個加載的屬性為准,可以理解為 boot的 bootstrap.properties與 application.yml-->
    <!--
        <logger name="com.tuniu" level="warn"/>
        如果將上面的這段配置放開,就如同寫了:
        <logger name="com.tuniu" level="warn" additivity="false">
            <appender-ref ref="appLogAppender"/>
        </logger>
    -->

    <!--由於設置了 additivity="false" ，所以輸出時不會使用rootLogger的appender-->
    <!--但是這個logger本身又沒有配置 appender，所以使用這個logger輸出日志的話就不會輸出到任何地方-->
<!--    <logger name="mytest2" level="info" additivity="false"/>-->

</configuration>

配置效果：

　　項目下回生成 app 文件夾，里面包含了日志文件 2 個：

　　　　boot-logbackBootText-2021-06-17-0.log ：記錄的是  springboot 的運行日志，級別是 debug

　　　　logbackBootText-2021-06-16-0.log：記錄的是項目運行中的 com.tuniu 目錄下的運行日志，級別是 debug

　　　　控制台也會輸出和logbackBootText-2021-06-16-0.log一樣的日志