logback.xml/logback-spring.xml模板詳解(帶註釋)

前言:springboot2.x默認使用的日誌是logback,不再是log4j,但是我們的項目由log4j更換爲logback成本並不大,只需要將pom中依賴的jar換爲logback(springboot核心starter默認就有),然後在根目錄放置logback.xml或logback-spring.xml命名的配置文件即可

下圖是slf4j日誌門面,log4j,log4j2,logback調用的關係圖

在項目中使用日誌時通過slf4j-api日誌門面的loggerFactory來獲取產生日誌的類就可以根據你項目中引入的jar和配置來獲取相關的logger.代碼如下

private static final Logger logger = LoggerFactory.getLogger(LoginController.class);
logger.debug(strErrCode+"03 用戶登錄日誌添加成功。");

logback.xml的配置詳解如下:

<?xml version="1.0" encoding="UTF-8"?>
<!-- 日誌級別從低到高分爲TRACE < DEBUG < INFO < WARN < ERROR < FATAL,如果設置爲WARN,則低於WARN的信息都不會輸出 -->
<!-- scan:當此屬性設置爲true時,配置文件如果發生改變,將會被重新加載,默認值爲true -->
<!-- scanPeriod:設置監測配置文件是否有修改的時間間隔,如果沒有給出時間單位,默認單位是毫秒。當scan爲true時,此屬性生效。默認的時間間隔爲1分鐘。 -->
<!-- debug:當此屬性設置爲true時,將打印出logback內部日誌信息,實時查看logback運行狀態。默認值爲false。 -->
<configuration  scan="true" scanPeriod="10 seconds">

    <!--<include resource="org/springframework/boot/logging/logback/base.xml" />-->

    <contextName>logback</contextName>
    <!-- name的值是變量的名稱,value的值時變量定義的值。通過定義的值會被插入到logger上下文中。定義變量後,可以使“${}”來使用變量。 打包後在項目的更目錄生成日誌文件-->
    <property name="log.path" value="${catalina.base}/webapps/ZoomSealEnt/logs" />

    <!-- 彩色日誌 -->
    <!-- 彩色日誌依賴的渲染類 -->
    <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" />
    <!-- 彩色日誌格式   [%-5p] %d{yyyy-MM-dd HH:mm:ss,SSS} method:%l%n%m%n  -->

    <property name="CONSOLE_LOG_PATTERN" value="${CONSOLE_LOG_PATTERN:-%clr(%d{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}}"/>


    <!--輸出到控制檯-->
    <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
        <!--此日誌appender是爲開發使用,只配置最底級別,控制檯輸出的日誌級別是大於或等於此級別的日誌信息-->
        <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
            <level>debug</level>
        </filter>
        <encoder>
            <Pattern>${CONSOLE_LOG_PATTERN}</Pattern>
            <!-- 設置字符集 -->
            <charset>UTF-8</charset>
        </encoder>
    </appender>


    <!--輸出到文件-->
    <!-- 時間滾動輸出 level爲 DEBUG 日誌 -->
    <appender name="DEBUG_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!-- 正在記錄的日誌文件的路徑及文件名 -->
        <!--先將今天的日誌保存在這個文件中-->
        <file>${log.path}/log_debug.log</file>
        <!--日誌文件輸出格式   %-d{yyyy-MM-dd HH:mm:ss}  [ %t:%r ] - [ %p ]  %m%n
            %d{HH: mm:ss.SSS}——日誌輸出時間
            %thread——輸出日誌的進程名字,這在Web應用以及異步任務處理中很有用
            %-5level——日誌級別,並且使用5個字符靠左對齊
            %logger{36}——日誌輸出者的名字
            %msg——日誌消息
            %n——平臺的換行符
           -->
        <encoder>
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
            <charset>UTF-8</charset> <!-- 設置字符集 -->
        </encoder>
        <!-- 日誌記錄器的滾動策略,按日期,按大小記錄 -->

        <rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
            <!-- rollover daily -->
            <!--如果第二天輸出日誌,會將當天的日誌記錄在<file>${log.path}/log_debug.log</file>,然後將昨天的日誌歸檔到下面的文件中-->
            <!--以分鐘切分  %d{yyyy-MM-dd_HH-mm}-->
            <fileNamePattern>${log.path}/debug/log-debug-%d{yyyy-MM-dd_HH-mm}.%i.log</fileNamePattern>
            <!-- each file should be at most 100MB, keep 60 days worth of history, but at most 20GB -->
            <!--單個日誌文件最大100M,到了這個值,就會再創建一個日誌文件,日誌文件的名字最後+1-->
            <maxFileSize>100MB</maxFileSize>
            <!--日誌文件保留天數-->
            <maxHistory>30</maxHistory>
            <!--所有的日誌文件最大20G,超過就會刪除舊的日誌-->
            <totalSizeCap>20GB</totalSizeCap>
        </rollingPolicy>
        <!-- 
            此日誌文件只記錄debug級別的 
            onMatch和onMismatch都有三個屬性值,分別爲Accept、DENY和NEUTRAL
            onMatch="ACCEPT" 表示匹配該級別及以上
            onMatch="DENY" 表示不匹配該級別及以上
            onMatch="NEUTRAL" 表示該級別及以上的,由下一個filter處理,如果當前是最後一個,則表        示匹配該級別及以上
            onMismatch="ACCEPT" 表示匹配該級別以下
            onMismatch="NEUTRAL" 表示該級別及以下的,由下一個filter處理,如果當前是最後一個,則不匹配該級別以下的
            onMismatch="DENY" 表示不匹配該級別以下的
        -->
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>debug</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>
    </appender>

    <!-- 時間滾動輸出 level爲 INFO 日誌 -->
    <appender name="INFO_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!-- 正在記錄的日誌文件的路徑及文件名 -->
        <file>${log.path}/log_info.log</file>
        <!--日誌文件輸出格式-->
        <encoder>
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
            <charset>UTF-8</charset>
        </encoder>
        <!-- 日誌記錄器的滾動策略,按日期,按大小記錄 -->
        <rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
            <!-- rollover daily -->
            <!--如果第二天輸出日誌,會將當天的日誌記錄在<file>${log.path}/log_debug.log</file>,然後將昨天的日誌歸檔到下面的文件中-->
            <!--以分鐘切分  %d{yyyy-MM-dd_HH-mm}-->
            <fileNamePattern>${log.path}/info/log-info-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
            <!-- each file should be at most 100MB, keep 60 days worth of history, but at most 20GB -->
            <!--單個日誌文件最大100M,到了這個值,就會再創建一個日誌文件,日誌文件的名字最後+1-->
            <maxFileSize>100MB</maxFileSize>
            <!--日誌文件保留天數-->
            <maxHistory>30</maxHistory>
            <!--所有的日誌文件最大20G,超過就會刪除舊的日誌-->
            <totalSizeCap>20GB</totalSizeCap>
        </rollingPolicy>
        <!--SizeAndTimeBasedRollingPolicy配置更靈活,所以改用SizeAndTimeBasedRollingPolicy-->
        <!--<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            &lt;!&ndash; 每天日誌歸檔路徑以及格式 &ndash;&gt;
            <fileNamePattern>${log.path}/info/log-info-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <maxFileSize>100MB</maxFileSize>
            </timeBasedFileNamingAndTriggeringPolicy>
            &lt;!&ndash;日誌文件保留天數&ndash;&gt;
            <maxHistory>15</maxHistory>
        </rollingPolicy>-->
        <!-- 此日誌文件只記錄info級別的 -->
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>info</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>
    </appender>

    <!-- 時間滾動輸出 level爲 WARN 日誌 -->
    <appender name="WARN_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!-- 正在記錄的日誌文件的路徑及文件名 -->
        <file>${log.path}/log_warn.log</file>
        <!--日誌文件輸出格式-->
        <encoder>
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
            <charset>UTF-8</charset> <!-- 此處設置字符集 -->
        </encoder>
        <!-- 日誌記錄器的滾動策略,按日期,按大小記錄 -->
        <rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
            <!-- rollover daily -->
            <!--如果第二天輸出日誌,會將當天的日誌記錄在<file>${log.path}/log_debug.log</file>,然後將昨天的日誌歸檔到下面的文件中-->
            <!--以分鐘切分  %d{yyyy-MM-dd_HH-mm}-->
            <fileNamePattern>${log.path}/warn/log-warn-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
            <!-- each file should be at most 100MB, keep 60 days worth of history, but at most 20GB -->
            <!--單個日誌文件最大100M,到了這個值,就會再創建一個日誌文件,日誌文件的名字最後+1-->
            <maxFileSize>100MB</maxFileSize>
            <!--日誌文件保留天數-->
            <maxHistory>30</maxHistory>
            <!--所有的日誌文件最大20G,超過就會刪除舊的日誌-->
            <totalSizeCap>20GB</totalSizeCap>
        </rollingPolicy>
        <!-- 此日誌文件只記錄warn級別的 -->
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>warn</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>
    </appender>


    <!-- 時間滾動輸出 level爲 ERROR 日誌 -->
    <appender name="ERROR_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!-- 正在記錄的日誌文件的路徑及文件名 -->
        <file>${log.path}/log_error.log</file>
        <!--日誌文件輸出格式-->
        <encoder>
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
            <charset>UTF-8</charset> <!-- 此處設置字符集 -->
        </encoder>
        <!-- 日誌記錄器的滾動策略,按日期,按大小記錄 -->
        <rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
            <!-- rollover daily -->
            <!--如果第二天輸出日誌,會將當天的日誌記錄在<file>${log.path}/log_debug.log</file>,然後將昨天的日誌歸檔到下面的文件中-->
            <!--以分鐘切分  %d{yyyy-MM-dd_HH-mm}-->
            <fileNamePattern>${log.path}/error/log-error-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
            <!-- each file should be at most 100MB, keep 60 days worth of history, but at most 20GB -->
            <!--單個日誌文件最大100M,到了這個值,就會再創建一個日誌文件,日誌文件的名字最後+1-->
            <maxFileSize>100MB</maxFileSize>
            <!--日誌文件保留天數-->
            <maxHistory>30</maxHistory>
            <!--所有的日誌文件最大20G,超過就會刪除舊的日誌-->
            <totalSizeCap>20GB</totalSizeCap>
        </rollingPolicy>
        <!-- 此日誌文件只記錄ERROR級別的 -->
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>ERROR</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>
    </appender>

    <!--root配置必須在appender下邊-->
    <!--root節點是對所有appender的管理,添加哪個appender就會打印哪個appender的日誌-->
    <!--root節點的level是總的日誌級別控制,如果appender的日誌級別設定比root的高,會按照appender的日誌級別打印日誌,-->
    <!--如果appender的日誌級別比root的低,會按照root設定的日誌級別進行打印日誌-->
    <!--也就是說root設定的日誌級別是最低限制,如果root設定級別爲最高ERROR,那麼所有appender只能打印最高級別的日誌-->
    <root level="DEBUG">
        <appender-ref ref="CONSOLE" />
        <appender-ref ref="DEBUG_FILE" />
        <appender-ref ref="INFO_FILE" />
        <appender-ref ref="WARN_FILE" />
        <appender-ref ref="ERROR_FILE" />
    </root>

    <!--
    name:用來指定受此loger約束的某一個包或者具體的某一個類。
    addtivity:是否向上級loger傳遞打印信息。默認是true。
    因爲mybatis打印的sql日誌是debug級別的,如果將所有的debug都打印出來會特別亂,
    所以特意指定mybatis的日誌爲debug,其他的爲info
-->
    <logger name="com.zzzy.zlu.mapper" level="debug" additivity="false">
        <appender-ref ref="CONSOLE" />
    </logger>

    <!--配置多環境日誌輸出  可以在application.properties中配置選擇哪個profiles : spring.profiles.active=dev-->
    <!--生產環境:輸出到文件-->
    <!--<springProfile name="pro">
        <root level="info">
            <appender-ref ref="DEBUG_FILE" />
            <appender-ref ref="INFO_FILE" />
            <appender-ref ref="ERROR_FILE" />
            <appender-ref ref="WARN_FILE" />
        </root>
    </springProfile>-->
    <!--開發環境:打印控制檯-->
    <!--<springProfile name="dev">
        <root level="debug">
            <appender-ref ref="CONSOLE" />
        </root>
    </springProfile>-->

</configuration>

 

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章