首頁 > 軟體

springboot2.0整合logback紀錄檔的詳細程式碼

2022-02-15 13:02:07

一。

近期自己的專案想要一個記錄紀錄檔的功能,而springboot本身就內建了紀錄檔功能,然而想要輸入想要的紀錄檔,並且輸出到磁碟,然後按天歸檔,或者紀錄檔的切分什麼的,自帶的紀錄檔僅僅具有簡單的功能,百度了一番,總結如下,適合大多數的應用場景

二。

springboot的pom檔案都會引一個parent

 <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.0.0.RELEASE</version>
    </parent>

點進去這個parent,會有一個這個dependency

 <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-dependencies</artifactId>
        <version>2.0.0.RELEASE</version>
        <relativePath>../../spring-boot-dependencies</relativePath>
    </parent>

再點進去就是2.0版本,所謂的它給你整合的各種包依賴,而且規定了版本號,其中有一個包如下

 <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter</artifactId>
                <version>2.0.0.RELEASE</version>
            </dependency>

再點進去

    <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-logging</artifactId>
      <version>2.0.0.RELEASE</version>
      <scope>compile</scope>
    </dependency>

再點,這些都是原有的紀錄檔包,所以,不必再引依賴了,直接用就ok了,用法如下:

  <dependencies>
    <dependency>
      <groupId>ch.qos.logback</groupId>
      <artifactId>logback-classic</artifactId>
      <version>1.2.3</version>
      <scope>compile</scope>
    </dependency>
    <dependency>
      <groupId>org.apache.logging.log4j</groupId>
      <artifactId>log4j-to-slf4j</artifactId>
      <version>2.10.0</version>
      <scope>compile</scope>
    </dependency>
    <dependency>
      <groupId>org.slf4j</groupId>
      <artifactId>jul-to-slf4j</artifactId>
      <version>1.7.25</version>
      <scope>compile</scope>
    </dependency>

============================分割線====================================

首先,官方推薦使用的xml名字的格式為:logback-spring.xml而不是logback.xml,至於為什麼,因為帶spring字尾的可以使用<springProfile>這個標籤。

在resource下建立logback-spring.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="D:/nmyslog/nmys" />
    <!-- 彩色紀錄檔 -->
    <!-- 彩色紀錄檔依賴的渲染類 -->
    <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">
        <!--此紀錄檔appender是為開發使用,只設定最底級別,控制檯輸出的紀錄檔級別是大於或等於此級別的紀錄檔資訊-->
        <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>
        <!--紀錄檔檔案輸出格式-->
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
            <charset>UTF-8</charset> <!-- 設定字元集 -->
        <!-- 紀錄檔記錄器的捲動策略,按日期,按大小記錄 -->
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!-- 紀錄檔歸檔 -->
            <fileNamePattern>${log.path}/debug/log-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>
    <!-- 時間捲動輸出 level為 INFO 紀錄檔 -->
    <appender name="INFO_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <file>${log.path}/log_info.log</file>
            <!-- 每天紀錄檔歸檔路徑以及格式 -->
            <fileNamePattern>${log.path}/info/log-info-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
        <!-- 此紀錄檔檔案只記錄info級別的 -->
    <!-- 時間捲動輸出 level為 WARN 紀錄檔 -->
    <appender name="WARN_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <file>${log.path}/log_warn.log</file>
            <charset>UTF-8</charset> <!-- 此處設定字元集 -->
            <fileNamePattern>${log.path}/warn/log-warn-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
        <!-- 此紀錄檔檔案只記錄warn級別的 -->
            <level>warn</level>
    <!-- 時間捲動輸出 level為 ERROR 紀錄檔 -->
    <appender name="ERROR_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <file>${log.path}/log_error.log</file>
            <fileNamePattern>${log.path}/error/log-error-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
        <!-- 此紀錄檔檔案只記錄ERROR級別的 -->
            <level>ERROR</level>
    <!--
        <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級別:
     -->
        root節點是必選節點,用來指定最基礎的紀錄檔輸出級別,只有一個level屬性
        不能設定為INHERITED或者同義詞NULL。預設是DEBUG
        可以包含零個或多個元素,標識這個appender將會新增到這個logger。
    <!--開發環境:列印控制檯-->
    <springProfile name="dev">
        <logger name="com.nmys.view" level="debug"/>
    </springProfile>
    <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 name="pro">-->
        <!--<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>-->
    <!--</springProfile>-->
</configuration>

其中說一下,彩色紀錄檔這個功能,需要下載外掛,然後在yml或者properties中設定。

logging.config=classpath:log/logback-spring.xml
logging.path=D:/nmyslog/nmys

紀錄檔的使用方式,就跟普通使用一樣,只不過,此設定設定的是不僅在控制檯輸出而且在磁碟上也會保留,並且info/debug/error/warn的紀錄檔都區分開了,並且按照每天做了歸檔,

================================2019年7月18日更新==========================================

紀錄檔整合再次升級,升級內容:

1. 規範了紀錄檔的列印格式

2. 增加了彩色紀錄檔輸出

3. 支援非同步推播kafka

4. 紀錄檔檔案壓縮功能

地址:https://www.cnblogs.com/zhangjianbing/p/15895562.html

到此這篇關於springboot2.0整合logback紀錄檔(詳細)的文章就介紹到這了,更多相關springboot整合logback內容請搜尋it145.com以前的文章或繼續瀏覽下面的相關文章希望大家以後多多支援it145.com!


IT145.com E-mail:sddin#qq.com