天天看點
傳回

logback的簡單使用

文章目錄

  • 1、前置
  • 2、application.yml配置如下:
  • 3、logback-spring.xml基本配置如下:
  • 4、動态指定日志級别方式A:
  • 5、動态指定日志級别方式B:
  • 6、備注:

1、前置

1、先介紹logback-spring.xml基本配置

2、動态指定日志級别方式A

3、動态指定日志級别方式B

4、個人看法

2、application.yml配置如下:

# logback-spring.xml中會應用以下參數
# 日志儲存目錄
log_path: ${LOG_PATH:/upload/logs}

3、logback-spring.xml基本配置如下:

logback的簡單使用
<?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" debug="false">
    <contextName>logback</contextName>
    <!-- 該 <springProperty> 标簽允許我們從Spring(application.yml)中擷取屬性，以便在Logback中使用。定義變量後，可以使“${}”來使用變量 -->
    <springProperty scope="context" name="log.path" source="log_path" defaultValue="/logs/chaim"/>
    <!-- property: name的值是變量的名稱，value的值時變量定義的值。通過定義的值會被插入到logger上下文中。定義變量後，可以使“${}”來使用變量。 -->
    <!-- 日志最大的曆史 10天 -->
    <property name="maxHistory" value="10" />
    <!--日志檔案大小-->
    <property name="maxFileSize" value="10MB" />
    <!--日志檔案總大小-->
    <property name="totalSizeCap" value="10GB" />

    <!-- 彩色日志 -->
    <!-- 彩色日志依賴的渲染類 -->
    <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" />
    <!-- 彩色日志格式 -->
    <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">
<!--        &lt;!&ndash;此日志appender是為開發使用，隻配置最底級别，控制台輸出的日志級别是大于或等于此級别的日志資訊&ndash;&gt;-->
<!--        &lt;!&ndash;目前從我自己測試來看, 該優先級最高, 我一般不使用這個配置&ndash;&gt;-->
<!--        <filter class="ch.qos.logback.classic.filter.ThresholdFilter">-->
<!--            <level>info</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>
        <!--日志檔案輸出格式-->
        <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">
            <!-- 日志歸檔 -->
            <fileNamePattern>${log.path}/debug/log-debug-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
            <maxFileSize>${maxFileSize}</maxFileSize>
            <maxHistory>${maxHistory}}</maxHistory>
            <totalSizeCap>${totalSizeCap}</totalSizeCap>
        </rollingPolicy>
        <!-- 此日志檔案隻記錄debug級别的 -->
        <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">
            <!-- 每天日志歸檔路徑以及格式 -->
            <fileNamePattern>${log.path}/info/log-info-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
            <maxFileSize>${maxFileSize}</maxFileSize>
            <maxHistory>${maxHistory}}</maxHistory>
            <totalSizeCap>${totalSizeCap}</totalSizeCap>
        </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">
            <fileNamePattern>${log.path}/warn/log-warn-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
            <maxFileSize>${maxFileSize}</maxFileSize>
            <maxHistory>${maxHistory}}</maxHistory>
            <totalSizeCap>${totalSizeCap}</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">
            <fileNamePattern>${log.path}/error/log-error-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
            <maxFileSize>${maxFileSize}</maxFileSize>
            <maxHistory>${maxHistory}}</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。
        列:
        使用mybatis的時候，sql語句是debug下才會列印，而這裡我們配置的日志級别是:info，是以想要檢視sql語句的話，有以下兩種操作：
        第一種修改日志級别為: DEBUG, 這樣就會列印sql，不過這樣日志那邊會出現很多其他消息
        第二種就是單獨給dao下目錄配置debug模式，代碼如下，這樣配置sql語句會列印，其他還是正常info級别：
    -->
    <logger name="com.chaim.system.mapper" level="DEBUG"/>
<!--    <logger name="org.springframework.web" level="info"/>-->
<!--    <logger name="org.springframework.scheduling.annotation.ScheduledAnnotationBeanPostProcessor" level="INFO"/>-->

    <!--
        root節點: 必選節點，用來指定最基礎的日志輸出級别，隻有一個level屬性
        level:用來設定列印級别，大小寫無關：TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF，
        不能設定為INHERITED或者同義詞NULL。預設是DEBUG
        可以包含零個或多個元素，辨別這個appender将會添加到這個logger。
    -->
    <root level="info">
        <!-- ref關聯appender節點的name值 -->
        <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>
</configuration>

找到對應的目錄下, 可以看到對應的日志已經被寫入檔案:

logback的簡單使用

4、動态指定日志級别方式A:

# application.yml添加一個參數:
# 日志輸出級别, true開發模式, false線上環境
log_environment: ${LOG_ENVIRONMENT:true}
           
# logback-spring.xml添加一個springProperty 标簽:
<springProperty scope="context" name="log_environment" source="log_environment" defaultValue="false"/>
           
# 需依賴包:janino
<dependency>
   <groupId>org.codehaus.janino</groupId>
   <artifactId>janino</artifactId>
   <version>3.1.2</version>
</dependency>

更改上面截圖中的第三塊:

# 通過 p("log_environment") 來擷取log_environment值
# equals contains
<if condition='"true".equals(p("log_environment"))'>
        <then>
            # 當log_environment==true, 指定日志級别:info 控制台輸出, 以及對應的檔案寫入
            <root level="info">
                <!-- ref關聯appender節點的name值 -->
                <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>
        </then>
        <else>
            # 當log_environment!=true, 指定日志級别:error 控制台輸出, 以及對應的日志級别檔案寫入
            <root level="error">
                <appender-ref ref="CONSOLE" />
                <appender-ref ref="INFO_FILE" />
                <appender-ref ref="ERROR_FILE" />
            </root>
        </else>
    </if>

關于 if 标簽官方文檔介紹:

位址:https://logback.qos.ch/manual/configuration.html

logback的簡單使用

5、動态指定日志級别方式B:

第一種: 配置pom.xml:
<profiles>
        <profile>
            <!-- 本地開發環境 -->
            <id>dev</id>
            <properties>
                <profiles.active>dev</profiles.active>
            </properties>
            <activation>
                <activeByDefault>true</activeByDefault>
            </activation>
        </profile>
        <profile>
            <!-- 線上運作環境 -->
            <id>prod</id>
            <properties>
                <profiles.active>prod</profiles.active>
            </properties>
        </profile>
    </profiles>

第二種: 指定目前環境:
# 在application.yml中指定目前環境參數:
spring.profiles.active=dev
           
<!-- springProfile擷取目前環境, 通過環境進行區分 -->
    <!--開發環境:列印控制台-->
    <springProfile name="dev">
        <root level="info">
            <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>
    </springProfile>

    <!--生産環境:輸出到檔案-->
    <springProfile name="prod">
        <root level="error">
            <appender-ref ref="CONSOLE" />
            <appender-ref ref="INFO_FILE" />
            <appender-ref ref="ERROR_FILE" />
        </root>
    </springProfile>

6、備注:

java logback log4j 日志 Java日志
上一篇: 讓愛好更專業，奧迪RS駕駛學院進階來襲丨Experience
下一篇: PayPal----訂單支付

繼續閱讀