springboot配置多環境日誌打印

springboot配置多環境日誌打印

  • 爲什麼要配置?

    一般開發用windows ,而程序最終多在linux系統上運行,每次打包發佈都要更改對應的配置信息。

  • 有幾種方法可以實現?

    目前常見的有兩種方法,一種是基於logback-spring.xml文件中來配置,優點是隻有一個文件,缺點是要共用一部分模版配置,另一種是定義不同的Logback配置文件,優點可以針對不同的條件激活不同的配置,缺點是文件過多。其實兩個原理是一樣的,把日誌託管給spring。

  • 需要引用哪些依賴?

    需要引用日誌模塊,但是已經包含在springboot-start裏面了。

通過不同的文件來達到多環境配置

  1. 首先在resources新建log文件夾並分在文件夾中別創建logback-dev.xml ,logback-test.xml ,logback-prod.xml文件

    -- logback-dev.xml

    
    <included>
        <!--0. 日誌格式和顏色渲染 -->
        <!-- 彩色日誌依賴的渲染類 -->
        <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" />
    
        <!-- 控制檯彩色日誌格式  %black", "%red", "%green","%yellow","%blue", "%magenta","%cyan", "%white", "%gray", "%boldRed","%boldGreen", "%boldYellow", "%boldBlue", "%boldMagenta""%boldCyan", "%boldWhite" and "%highlight" 支持的顏色-->
        <property name="CONSOLE_LOG_PATTERN" value="%boldMagenta(%d{yyyy-MM-dd HH:mm:ss.SSS}){faint} %boldYellow(${LOG_LEVEL_PATTERN:-%5p}) %boldCyan(${PID:- }){magenta} %boldGreen(---){faint} %boldGreen([%15.15t]){faint} %boldCyan(%-40.40logger{50}){cyan} %boldYellow(:){faint} %m%n${LOG_EXCEPTION_CONVERSION_WORD:-%wEx}"/>
        <!--文件日誌打印格式 -->
        <property name="FILE_LOG_PATTERN" value="%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n"/>
        <!--1. 輸出到控制檯 , class 用來指定輸出策略-->
        <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
            <!--此日誌appender是爲開發使用,只配置最底級別,控制檯輸出的日誌級別是大於或等於此級別的日誌信息-->
            <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
                <level>debug</level> <!--控制檯輸出的日誌級別-->
            </filter>
            <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
                <!--格式化輸出:%d表示日期,%thread表示線程名,%-5level:級別從左顯示5個字符寬度%msg:日誌消息,%n是換行符-->
                <pattern>${CONSOLE_LOG_PATTERN}</pattern>
            </encoder>
        </appender>
    
        <!--2. 輸出到文檔-->
        <!-- 2.1 level爲 DEBUG 日誌,時間滾動輸出  -->
        <appender name="DEBUG_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
            <!-- 正在記錄的日誌文檔的路徑及文檔名 -->
            <file>${log.path}/white_dev_debug.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.TimeBasedRollingPolicy">
                <!-- 日誌歸檔 -->
                <fileNamePattern>${log.path}/white-dev-debug-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
                <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                    <maxFileSize>100MB</maxFileSize>
                </timeBasedFileNamingAndTriggeringPolicy>
                <!--日誌文檔保留天數-->
                <maxHistory>15</maxHistory>
            </rollingPolicy>
            <!-- 此日誌文檔只記錄debug級別的 -->
            <filter class="ch.qos.logback.classic.filter.LevelFilter">
                <level>debug</level>
                <onMatch>ACCEPT</onMatch>
                <onMismatch>DENY</onMismatch>
            </filter>
        </appender>
    
        <!-- 2.2 level爲 INFO 日誌,時間滾動輸出  -->
        <appender name="INFO_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
            <!-- 正在記錄的日誌文檔的路徑及文檔名 -->
            <file>${log.path}/white_dev_info.log</file>
            <!--日誌文檔輸出格式-->
            <encoder>
                <pattern>${FILE_LOG_PATTERN}</pattern>
                <charset>UTF-8</charset>
            </encoder>
            <!-- 日誌記錄器的滾動策略,按日期,按大小記錄 -->
            <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
                <!-- 每天日誌歸檔路徑以及格式 -->
                <fileNamePattern>${log.path}/white-dev-info-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
                <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                    <maxFileSize>100MB</maxFileSize>
                </timeBasedFileNamingAndTriggeringPolicy>
                <!--日誌文檔保留天數-->
                <maxHistory>15</maxHistory>
            </rollingPolicy>
            <!-- 此日誌文檔只記錄info級別的 -->
            <filter class="ch.qos.logback.classic.filter.LevelFilter">
                <level>info</level>
                <onMatch>ACCEPT</onMatch>
                <onMismatch>DENY</onMismatch>
            </filter>
        </appender>
    
        <!-- 2.3 level爲 WARN 日誌,時間滾動輸出  -->
        <appender name="WARN_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
            <!-- 正在記錄的日誌文檔的路徑及文檔名 -->
            <file>${log.path}/white_dev_warn.log</file>
            <!--日誌文檔輸出格式-->
            <encoder>
                <pattern>${FILE_LOG_PATTERN}</pattern>
                <charset>UTF-8</charset> <!-- 此處設置字符集 -->
            </encoder>
            <!-- 日誌記錄器的滾動策略,按日期,按大小記錄 -->
            <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
                <fileNamePattern>${log.path}/white-dev-warn-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
                <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                    <maxFileSize>100MB</maxFileSize>
                </timeBasedFileNamingAndTriggeringPolicy>
                <!--日誌文檔保留天數-->
                <maxHistory>15</maxHistory>
            </rollingPolicy>
            <!-- 此日誌文檔只記錄warn級別的 -->
            <filter class="ch.qos.logback.classic.filter.LevelFilter">
                <level>warn</level>
                <onMatch>ACCEPT</onMatch>
                <onMismatch>DENY</onMismatch>
            </filter>
        </appender>
    
        <!-- 2.4 level爲 ERROR 日誌,時間滾動輸出  -->
        <appender name="ERROR_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
            <!-- 正在記錄的日誌文檔的路徑及文檔名 -->
            <file>${log.path}/white_dev_error.log</file>
            <!--日誌文檔輸出格式-->
            <encoder>
                <pattern>${FILE_LOG_PATTERN}</pattern>
                <charset>UTF-8</charset> <!-- 此處設置字符集 -->
            </encoder>
            <!-- 日誌記錄器的滾動策略,按日期,按大小記錄 -->
            <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
                <fileNamePattern>${log.path}/white-dev-error-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
                <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                    <maxFileSize>100MB</maxFileSize>
                </timeBasedFileNamingAndTriggeringPolicy>
                <!--日誌文檔保留天數-->
                <maxHistory>15</maxHistory>
            </rollingPolicy>
            <!-- 此日誌文檔只記錄ERROR級別的 -->
            <filter class="ch.qos.logback.classic.filter.LevelFilter">
                <level>ERROR</level>
                <onMatch>ACCEPT</onMatch>
                <onMismatch>DENY</onMismatch>
            </filter>
        </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>
    
    
    </included>
    

    -- logback-test.xml

    
    <included>
        <!--0. 日誌格式和顏色渲染 -->
        <!-- 彩色日誌依賴的渲染類 -->
        <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" />
    
        <!-- 控制檯彩色日誌格式  %black", "%red", "%green","%yellow","%blue", "%magenta","%cyan", "%white", "%gray", "%boldRed","%boldGreen", "%boldYellow", "%boldBlue", "%boldMagenta""%boldCyan", "%boldWhite" and "%highlight" 支持的顏色-->
        <property name="CONSOLE_LOG_PATTERN" value="%boldMagenta(%d{yyyy-MM-dd HH:mm:ss.SSS}){faint} %boldYellow(${LOG_LEVEL_PATTERN:-%5p}) %boldCyan(${PID:- }){magenta} %boldGreen(---){faint} %boldGreen([%15.15t]){faint} %boldCyan(%-40.40logger{50}){cyan} %boldYellow(:){faint} %m%n${LOG_EXCEPTION_CONVERSION_WORD:-%wEx}"/>
        <!--文件日誌打印格式 -->
        <property name="FILE_LOG_PATTERN" value="%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n"/>
        <!--1. 輸出到控制檯 , class 用來指定輸出策略-->
        <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
            <!--此日誌appender是爲開發使用,只配置最底級別,控制檯輸出的日誌級別是大於或等於此級別的日誌信息-->
            <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
                <level>debug</level> <!--控制檯輸出的日誌級別-->
            </filter>
            <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
                <!--格式化輸出:%d表示日期,%thread表示線程名,%-5level:級別從左顯示5個字符寬度%msg:日誌消息,%n是換行符-->
                <pattern>${CONSOLE_LOG_PATTERN}</pattern>
            </encoder>
        </appender>
    
        <!--2. 輸出到文檔-->
        <!-- 2.1 level爲 DEBUG 日誌,時間滾動輸出  -->
        <appender name="DEBUG_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
            <!-- 正在記錄的日誌文檔的路徑及文檔名 -->
            <file>${log.path}/white_test_debug.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.TimeBasedRollingPolicy">
                <!-- 日誌歸檔 -->
                <fileNamePattern>${log.path}/white-test-debug-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
                <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                    <maxFileSize>100MB</maxFileSize>
                </timeBasedFileNamingAndTriggeringPolicy>
                <!--日誌文檔保留天數-->
                <maxHistory>15</maxHistory>
            </rollingPolicy>
            <!-- 此日誌文檔只記錄debug級別的 -->
            <filter class="ch.qos.logback.classic.filter.LevelFilter">
                <level>debug</level>
                <onMatch>ACCEPT</onMatch>
                <onMismatch>DENY</onMismatch>
            </filter>
        </appender>
    
        <!-- 2.2 level爲 INFO 日誌,時間滾動輸出  -->
        <appender name="INFO_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
            <!-- 正在記錄的日誌文檔的路徑及文檔名 -->
            <file>${log.path}/white_test_info.log</file>
            <!--日誌文檔輸出格式-->
            <encoder>
                <pattern>${FILE_LOG_PATTERN}</pattern>
                <charset>UTF-8</charset>
            </encoder>
            <!-- 日誌記錄器的滾動策略,按日期,按大小記錄 -->
            <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
                <!-- 每天日誌歸檔路徑以及格式 -->
                <fileNamePattern>${log.path}/white-test-info-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
                <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                    <maxFileSize>100MB</maxFileSize>
                </timeBasedFileNamingAndTriggeringPolicy>
                <!--日誌文檔保留天數-->
                <maxHistory>15</maxHistory>
            </rollingPolicy>
            <!-- 此日誌文檔只記錄info級別的 -->
            <filter class="ch.qos.logback.classic.filter.LevelFilter">
                <level>info</level>
                <onMatch>ACCEPT</onMatch>
                <onMismatch>DENY</onMismatch>
            </filter>
        </appender>
    
        <!-- 2.3 level爲 WARN 日誌,時間滾動輸出  -->
        <appender name="WARN_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
            <!-- 正在記錄的日誌文檔的路徑及文檔名 -->
            <file>${log.path}/white_test_warn.log</file>
            <!--日誌文檔輸出格式-->
            <encoder>
                <pattern>${FILE_LOG_PATTERN}</pattern>
                <charset>UTF-8</charset> <!-- 此處設置字符集 -->
            </encoder>
            <!-- 日誌記錄器的滾動策略,按日期,按大小記錄 -->
            <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
                <fileNamePattern>${log.path}/white-test-warn-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
                <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                    <maxFileSize>100MB</maxFileSize>
                </timeBasedFileNamingAndTriggeringPolicy>
                <!--日誌文檔保留天數-->
                <maxHistory>15</maxHistory>
            </rollingPolicy>
            <!-- 此日誌文檔只記錄warn級別的 -->
            <filter class="ch.qos.logback.classic.filter.LevelFilter">
                <level>warn</level>
                <onMatch>ACCEPT</onMatch>
                <onMismatch>DENY</onMismatch>
            </filter>
        </appender>
    
        <!-- 2.4 level爲 ERROR 日誌,時間滾動輸出  -->
        <appender name="ERROR_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
            <!-- 正在記錄的日誌文檔的路徑及文檔名 -->
            <file>${log.path}/white_test_error.log</file>
            <!--日誌文檔輸出格式-->
            <encoder>
                <pattern>${FILE_LOG_PATTERN}</pattern>
                <charset>UTF-8</charset> <!-- 此處設置字符集 -->
            </encoder>
            <!-- 日誌記錄器的滾動策略,按日期,按大小記錄 -->
            <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
                <fileNamePattern>${log.path}/white-test-error-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
                <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                    <maxFileSize>100MB</maxFileSize>
                </timeBasedFileNamingAndTriggeringPolicy>
                <!--日誌文檔保留天數-->
                <maxHistory>15</maxHistory>
            </rollingPolicy>
            <!-- 此日誌文檔只記錄ERROR級別的 -->
            <filter class="ch.qos.logback.classic.filter.LevelFilter">
                <level>ERROR</level>
                <onMatch>ACCEPT</onMatch>
                <onMismatch>DENY</onMismatch>
            </filter>
        </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>
    
    
    </included>
    

    -- logback-prod.xml

    <included>
        <!-- name的值是變量的名稱,value的值時變量定義的值。通過定義的值會被插入到logger上下文中。定義後,可以使“${}”來使用變量。 -->
    <!--    <property name="log.path" value="/Users/andy/up/springboot2/" />-->
        <!--0. 日誌格式和顏色渲染 -->
        <!-- 彩色日誌依賴的渲染類 -->
        <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" />
    
        <!-- 控制檯彩色日誌格式  %black", "%red", "%green","%yellow","%blue", "%magenta","%cyan", "%white", "%gray", "%boldRed","%boldGreen", "%boldYellow", "%boldBlue", "%boldMagenta""%boldCyan", "%boldWhite" and "%highlight" 支持的顏色-->
        <property name="CONSOLE_LOG_PATTERN" value="%boldMagenta(%d{yyyy-MM-dd HH:mm:ss.SSS}){faint} %boldYellow(${LOG_LEVEL_PATTERN:-%5p}) %boldCyan(${PID:- }){magenta} %boldGreen(---){faint} %boldGreen([%15.15t]){faint} %boldCyan(%-40.40logger{50}){cyan} %boldYellow(:){faint} %m%n${LOG_EXCEPTION_CONVERSION_WORD:-%wEx}"/>
        <!--文件日誌打印格式 -->
        <property name="FILE_LOG_PATTERN" value="%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n"/>
        <!--1. 輸出到控制檯 , class 用來指定輸出策略-->
        <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
            <!--此日誌appender是爲開發使用,只配置最底級別,控制檯輸出的日誌級別是大於或等於此級別的日誌信息-->
            <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
                <level>info</level>
            </filter>
            <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
                <!--格式化輸出:%d表示日期,%thread表示線程名,%-5level:級別從左顯示5個字符寬度%msg:日誌消息,%n是換行符-->
                <pattern>${CONSOLE_LOG_PATTERN}</pattern>
            </encoder>
        </appender>
    
        <!--2. 輸出到文檔-->
        <!-- 2.1 level爲 DEBUG 日誌,時間滾動輸出  -->
        <appender name="DEBUG_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
            <!-- 正在記錄的日誌文檔的路徑及文檔名 -->
            <file>${log.path}/white_prod_debug.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.TimeBasedRollingPolicy">
                <!-- 日誌歸檔 -->
                <fileNamePattern>${log.path}/white-prod-debug-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
                <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                    <maxFileSize>100MB</maxFileSize>
                </timeBasedFileNamingAndTriggeringPolicy>
                <!--日誌文檔保留天數-->
                <maxHistory>15</maxHistory>
            </rollingPolicy>
            <!-- 此日誌文檔只記錄debug級別的 -->
            <filter class="ch.qos.logback.classic.filter.LevelFilter">
                <level>debug</level>
                <onMatch>ACCEPT</onMatch>
                <onMismatch>DENY</onMismatch>
            </filter>
        </appender>
    
        <!-- 2.2 level爲 INFO 日誌,時間滾動輸出  -->
        <appender name="INFO_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
            <!-- 正在記錄的日誌文檔的路徑及文檔名 -->
            <file>${log.path}/white_prod_info.log</file>
            <!--日誌文檔輸出格式-->
            <encoder>
                <pattern>${FILE_LOG_PATTERN}</pattern>
                <charset>UTF-8</charset>
            </encoder>
            <!-- 日誌記錄器的滾動策略,按日期,按大小記錄 -->
            <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
                <!-- 每天日誌歸檔路徑以及格式 -->
                <fileNamePattern>${log.path}/white-prod-info-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
                <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                    <maxFileSize>100MB</maxFileSize>
                </timeBasedFileNamingAndTriggeringPolicy>
                <!--日誌文檔保留天數-->
                <maxHistory>15</maxHistory>
            </rollingPolicy>
            <!-- 此日誌文檔只記錄info級別的 -->
            <filter class="ch.qos.logback.classic.filter.LevelFilter">
                <level>info</level>
                <onMatch>ACCEPT</onMatch>
                <onMismatch>DENY</onMismatch>
            </filter>
        </appender>
    
        <!-- 2.3 level爲 WARN 日誌,時間滾動輸出  -->
        <appender name="WARN_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
            <!-- 正在記錄的日誌文檔的路徑及文檔名 -->
            <file>${log.path}/white_prod_warn.log</file>
            <!--日誌文檔輸出格式-->
            <encoder>
                <pattern>${FILE_LOG_PATTERN}</pattern>
                <charset>UTF-8</charset> <!-- 此處設置字符集 -->
            </encoder>
            <!-- 日誌記錄器的滾動策略,按日期,按大小記錄 -->
            <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
                <fileNamePattern>${log.path}/white-prod-warn-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
                <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                    <maxFileSize>100MB</maxFileSize>
                </timeBasedFileNamingAndTriggeringPolicy>
                <!--日誌文檔保留天數-->
                <maxHistory>15</maxHistory>
            </rollingPolicy>
            <!-- 此日誌文檔只記錄warn級別的 -->
            <filter class="ch.qos.logback.classic.filter.LevelFilter">
                <level>warn</level>
                <onMatch>ACCEPT</onMatch>
                <onMismatch>DENY</onMismatch>
            </filter>
        </appender>
    
        <!-- 2.4 level爲 ERROR 日誌,時間滾動輸出  -->
        <appender name="ERROR_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
            <!-- 正在記錄的日誌文檔的路徑及文檔名 -->
            <file>${log.path}/white_prod_error.log</file>
            <!--日誌文檔輸出格式-->
            <encoder>
                <pattern>${FILE_LOG_PATTERN}</pattern>
                <charset>UTF-8</charset> <!-- 此處設置字符集 -->
            </encoder>
            <!-- 日誌記錄器的滾動策略,按日期,按大小記錄 -->
            <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
                <fileNamePattern>${log.path}/white-prod-error-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
                <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                    <maxFileSize>100MB</maxFileSize>
                </timeBasedFileNamingAndTriggeringPolicy>
                <!--日誌文檔保留天數-->
                <maxHistory>15</maxHistory>
            </rollingPolicy>
            <!-- 此日誌文檔只記錄ERROR級別的 -->
            <filter class="ch.qos.logback.classic.filter.LevelFilter">
                <level>ERROR</level>
                <onMatch>ACCEPT</onMatch>
                <onMismatch>DENY</onMismatch>
            </filter>
        </appender>
    
        <!--
            <logger>用來設置某一個包或者具體的某一個類的日誌打印級別、
            以及指定<appender>。<logger>僅有一個name屬性,
            一個可選的level和一個可選的addtivity屬性。
            name:用來指定受此logger約束的某一個包或者具體的某一個類。
            level:用來設置打印級別,大小寫無關:TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF,
                  還有一個特俗值INHERITED或者同義詞NULL,代表強制執行上級的級別。
                  如果未設置此屬性,那麼當前logger將會繼承上級的級別。
            addtivity:是否向上級logger傳遞打印信息。默認是true。
            <logger name="org.springframework.web" level="info"/>
            <logger name="org.springframework.scheduling.annotation.ScheduledAnnotationBeanPostProcessor" level="INFO"/>
        -->
    
        <!--
            使用mybatis的時候,sql語句是debug下才會打印,而這裏我們只配置了info,所以想要查看sql語句的話,有以下兩種操作:
            第一種把<root level="info">改成<root level="DEBUG">這樣就會打印sql,不過這樣日誌那邊會出現很多其他消息
            第二種就是單獨給dao下目錄配置debug模式,代碼如下,這樣配置sql語句會打印,其他還是正常info級別:
            【logging.level.org.mybatis=debug logging.level.dao=debug】
         -->
    
        <!--
          root節點是必選節點,用來指定最基礎的日誌輸出級別,只有一個level屬性 ,這個日誌的級別優先級比上面單個配置的優先級高
            舉例, 如果root 配置的是INFO ,控制檯輸出配置級別爲debug 則不會打印debug 日誌
            level:用來設置打印級別,大小寫無關:TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF,
            不能設置爲INHERITED或者同義詞NULL。默認是DEBUG
            可以包含零個或多個元素,標識這個appender將會添加到這個logger。
        -->
    
        <!-- 4.2 生產環境:輸出到文檔-->
        <root level="info">
            <appender-ref ref="CONSOLE" />
            <appender-ref ref="DEBUG_FILE" />
            <appender-ref ref="INFO_FILE" />
            <appender-ref ref="ERROR_FILE" />
            <appender-ref ref="WARN_FILE" />
        </root>
    
    </included>
    
  2. 在resources中創建logback-spring.xml文件,主要是根據不同的spring.profiles.active引入不同的文件到logback-spring.xml中來實現控制,內容如下

    <configuration scan="false">
        <contextName>logback</contextName>
        <property name="log.path" value="./logs"/>
        <property name="log.pattern" value="%-4relative \\\[%thread\\\] %-5level %logger{35} - %msg %n"/>
    
        <springProperty scope="context" name="profile" source="spring.profiles.active" defaultValue="dev"/>
        <logger level="TRACE" name="org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerMapping"/>
        <include resource="log/logback-${profile}.xml"/>
    </configuration>
    

    -- 說明

    a. spring.profiles.active定義在application文件中的話,並不會生效,Logback只會去加載名爲 logback-spring.profiles.active_IS_UNDEFINED.xml 的文件,需要設置其系統環境變量方可生效。可以通過來設置

    b. springboot2 日誌規劃有所改變,只有TRACE才能提供更加詳細的信息

    至此完成了相關配置。

    **- 也可以每個配置文件都寫成完成的logback.xml格式,通過配置不同的logging.config來實現 **

    # dev
    logging:
      config: classpath:log/logback-dev.xml
      
    # test
    logging:
      config: classpath:log/logback-test.xml
      
    # prod
    logging:
      config: classpath:log/logback-prod.xml
    
    

基於logback-spring.xml實現多環境配置

<configuration scan="false" debug="true">
    <contextName>logback</contextName>
    <property name="log.path" value="./logs"/>
    <property name="log.pattern" value="%-4relative \[%thread\] %-5level %logger{35} - %msg %n"/>

    <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <pattern>${log.pattern}</pattern>
            <charset>UTF-8</charset>
        </encoder>
    </appender>

    <appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <file>${log.path}/log.log</file>
        <encoder>
            <pattern>${log.pattern}</pattern>
            <charset>UTF-8</charset>
        </encoder>
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <fileNamePattern>${log.path}/file/log-%d{yyyy-MM-dd}.log</fileNamePattern>
            <maxHistory>15</maxHistory>
        </rollingPolicy>
    </appender>

    <springProfile name="test">
        <root level="DEBUG">
            <appender-ref ref="FILE"/>
        </root>
    </springProfile>
    <springProfile name="dev">
        <root level="DEBUG">
            <appender-ref ref="CONSOLE"/>
        </root>
    </springProfile>
</configuration>

從上述配置中,可以看到定義了兩個appender:一個叫做CONSOLE,用於把日誌輸出到控制檯;另一個叫做FILE,用於把日誌輸出到文件中。同時還定義了兩個不同環境的root配置:dev環境下,給root添加了叫做CONSOLE的appender;test環境下,給root添加了叫做FILE的appender。

通過指定application配置文件中的 spring.profiles.active=dev 或者通過指令 java -jar xx.jar --spring.profiles.active=dev 運行程序時,會發現日誌只在控制檯輸出。同樣的,當指定爲test環境時,日誌也只在文件中輸出。

PS:輸出到文件的appender,只要其配置生效,即使在當前的環境下,並未使用,也會生成相應的目錄和文件信息。

配置屬性說明

  1. logging.file,設置文件,可以是絕對路徑,也可以是相對路徑。如:logging.file=my.log

  2. logging.path,設置目錄,會在該目錄下創建spring.log文件,並寫入日誌內容,如:logging.path=/var/log

    如果只配置 logging.file,會在項目的當前路徑下生成一個 xxx.log 日誌文件。
    如果只配置 logging.path,在 /var/log文件夾生成一個日誌文件爲 spring.log

    注:二者不能同時使用,如若同時使用,則只有logging.file生效

  3. Spring Boot官方推薦優先使用帶有-spring的文件名作爲你的日誌配置(如使用logback-spring.xml,而不是logback.xml),命名爲logback-spring.xml的日誌配置文件,spring boot可以爲它添加一些spring boot特有的配置項,上面是默認的命名規則,並且放在src/main/resources下面即可。

  4. 如果你即想完全掌控日誌配置,但又不想用logback.xml作爲Logback配置的名字,可以在application.properties配置文件裏面通過logging.config屬性指定自定義的名字:雖然一般並不需要改變配置文件的名字,但是如果你想針對不同運行時Profile使用不同的日誌配置

  5. logback相關字段說明

    • addtivity:是否向上級logger傳遞打印信息。默認是true。
    • scan:當此屬性設置爲true時,配置文件如果發生改變,將會被重新加載,默認值爲true。
    • scanPeriod:設置監測配置文件是否有修改的時間間隔,如果沒有給出時間單位,默認單位是毫秒。當scan爲true時,此屬性生效。默認的時間間隔爲1分鐘。
    • debug:當此屬性設置爲true時,將打印出logback內部日誌信息,實時查看logback運行狀態。默認值爲false。
發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章