一文讀懂Logback的配置

作者：六脈神劍小六六 2021-09-04 19:04:14

為啥想著寫這個呢?是這樣，小六六每次搭建系統的時候，都會涉及到這塊的配置嘛，然后我發現我搭建了這么多次的系統，大部分的情況下，竟然是copy來完成的，然后這次搭建的過程中，又對這些配置又了點理解，所以打算給大家分享分享一些關鍵的點，讓大家多Java 項目的日志有一些更加深入的理解吧!

[[421672]]

前言

文本已收錄至我的GitHub倉庫，歡迎Star：https://github.com/bin392328206/six-finger

種一棵樹最好的時間是十年前，其次是現在

絮叨

為啥想著寫這個呢?是這樣，小六六每次搭建系統的時候，都會涉及到這塊的配置嘛，然后我發現我搭建了這么多次的系統，大部分的情況下，竟然是copy來完成的，然后這次搭建的過程中，又對這些配置又了點理解，所以打算給大家分享分享一些關鍵的點，讓大家多Java 項目的日志有一些更加深入的理解吧!當然這邊文章也得給大家清晰的理解logback的配置吧!盡量寫的直白點!文章打算沖以下幾個方面來描述

官網文檔
logback.xml常用配置詳解
一個小案例加深對配置的理解
logback.xml的參考配置(實戰)
開發時，小六六自己的一些特殊的用法(實戰)

參考的文檔

開始就先給大家給貼下參考的文檔吧!不過我覺得你應該不會去看，哈哈。我也是一樣的，看不下去官方文檔

logback.xml常用配置詳解

常用節點結構圖：

相信大家對這個圖應該不陌生，就是我們再spring-logback.xml里面要配置的文件就是這幾個配置，下面我先來給大家講講細節

根節點 configuration

包含下面三個屬性

scan: 當此屬性設置為true時，配置文件如果發生改變，將會被重新加載，默認值為true。
scanPeriod: 設置監測配置文件是否有修改的時間間隔，如果沒有給出時間單位，默認單位是毫秒。當scan為true時，此屬性生效。默認的時間間隔為1分鐘。
debug: 當此屬性設置為true時，將打印出logback內部日志信息，實時查看logback運行狀態。默認值為false。

<configuration scan="true" scanPeriod="60 seconds" debug="false">  
    <!--其他配置省略-->  
</configuration>

子節點 appender

它的作用是負責寫日志的組件，它有兩個必要屬性name和class。name指定appender名稱，class指定appender的全限定名。

下面小六六帶大家來看看我們常見的幾種appender吧!工作上肯定用的到的

ConsoleAppender 把日志輸出到控制臺

encoder：對日志進行格式化。

<appender name="console" class="ch.qos.logback.core.ConsoleAppender"> 
   <encoder> 
      <pattern>${CONSOLE_LOG_PATTERN}</pattern> 
   </encoder> 
</appender>

FileAppender：把日志添加到文件

file：被寫入的文件名，可以是相對目錄，也可以是絕對目錄，如果上級目錄不存在會自動創建，沒有默認值。
append：如果是 true，日志被追加到文件結尾，如果是 false，清空現存文件，默認是true。
encoder：對記錄事件進行格式化。
prudent：如果是 true，日志會被安全的寫入文件，即使其他的FileAppender也在向此文件做寫入操作，效率低，默認是 false。

<configuration>  
      <appender name="FILE" class="ch.qos.logback.core.FileAppender">  
        <file>testFile.log</file>  
        <append>true</append>  
        <encoder>  
          <pattern>%-4relative [%thread] %-5level %logger{35} - %msg%n</pattern>  
        </encoder>  
      </appender>  
 
      <root level="DEBUG">  
      <appender-ref ref="FILE" />  
      </root>  
  </configuration>

RollingFileAppender 滾動記錄文件，先將日志記錄到指定文件，當符合某個條件時，將日志記錄到其他文件這個小六六覺得是用的最多的一個了

file：被寫入的文件名，可以是相對目錄，也可以是絕對目錄，如果上級目錄不存在會自動創建，沒有默認值。
append：如果是 true，日志被追加到文件結尾，如果是 false，清空現存文件，默認是true。
rollingPolicy:當發生滾動時，決定RollingFileAppender的行為，涉及文件移動和重命名。屬性class定義具體的滾動策略類

class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy"：最常用的滾動策略，它根據時間來制定滾動策略，既負責滾動也負責出發滾動。

<appender name="BILogger_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender"> 
   <file>${log.path}/dataBi.dat</file> 
   <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy"> 
      <fileNamePattern>${log.path}/dataBi.dat.%d{yyyyMMdd}.gz</fileNamePattern> 
      <maxHistory>30</maxHistory> 
   </rollingPolicy> 
   <encoder> 
      <charset>UTF-8</charset> 
      <pattern>%date|%msg%n</pattern> 
   </encoder> 
</appender>

class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy"：查看當前活動文件的大小，如果超過指定大小會告知RollingFileAppender 觸發當前活動文件滾動

<appender name="debug" class="ch.qos.logback.core.rolling.RollingFileAppender"> 
   <file>${log.path}/debug.log</file> 
   <rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy"> 
      <fileNamePattern>${log.path}/%d{yyyy-MM, aux}/debug.%d{yyyy-MM-dd}.%i.log.gz</fileNamePattern> 
      <maxFileSize>50MB</maxFileSize> 
      <maxHistory>30</maxHistory> 
   </rollingPolicy> 
   <encoder> 
      <pattern>%date [%thread] %-5level [%logger{50}] %file:%line - %msg%n</pattern> 
   </encoder> 
</appender>

子節點 logger

用來設置某一個包或具體的某一個類的日志打印級別、以及指定。

logger僅有一個name屬性，一個可選的level和一個可選的addtivity屬性
可以包含零個或多個元素，標識這個appender將會添加到這個logger。
name: 用來指定受此loger約束的某一個包或者具體的某一個類。
level: 用來設置打印級別，大小寫無關：TRACE, DEBUG, INFO, WARN, ERROR, ALL和OFF，還有一個特殊值INHERITED或者同義詞NULL，代表強制執行上級的級別。如果未設置此屬性，那么當前loger將會繼承上級的級別。
addtivity: 是否向上級logger傳遞打印信息。默認是true。可以包含零個或多個appender-ref素，標識這個appender將會添加到這個logger。

<!--  logger name 和spring配置一致  --> 
<logger name="BILogger" level="INFO" additivity="true"> 
   <appender-ref ref="BILogger_FILE" /> 
</logger>

像我們的bi日志，一般這種標準化，流程化的日志。

子節點root

它也是logger元素，但是它是根loger,是所有的上級。只有一個level屬性，因為name已經被命名為"root",且已經是最上級了。

<root level="INFO"> 
   <appender-ref ref="console"/> 
   <appender-ref ref="debug"/> 
   <appender-ref ref="error"/> 
</root>

好了，上面就是我們比較重要的幾個元素了，還有一兩個小元素的話，小六六這邊就沒給大家看了。

logback.xml配置示例

<?xml version="1.0" encoding="UTF-8"?> 
<configuration debug="false"> 
 
    <!--定義日志文件的存儲地址 勿在 LogBack 的配置中使用相對路徑--> 
    <property name="LOG_HOME" value="/home" /> 
 
    <!--控制臺日志， 控制臺輸出 --> 
    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender"> 
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder"> 
            <!--格式化輸出：%d表示日期，%thread表示線程名，%-5level：級別從左顯示5個字符寬度,%msg：日志消息，%n是換行符--> 
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern> 
        </encoder> 
    </appender> 
 
    <!--文件日志， 按照每天生成日志文件 --> 
    <appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender"> 
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy"> 
            <!--日志文件輸出的文件名--> 
            <FileNamePattern>${LOG_HOME}/TestWeb.log.%d{yyyy-MM-dd}.log</FileNamePattern> 
            <!--日志文件保留天數--> 
            <MaxHistory>30</MaxHistory> 
        </rollingPolicy> 
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder"> 
            <!--格式化輸出：%d表示日期，%thread表示線程名，%-5level：級別從左顯示5個字符寬度%msg：日志消息，%n是換行符--> 
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern> 
        </encoder> 
        <!--日志文件最大的大小--> 
        <triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy"> 
            <MaxFileSize>10MB</MaxFileSize> 
        </triggeringPolicy> 
    </appender> 
 
    <!-- show parameters for hibernate sql 專為 Hibernate 定制 --> 
    <logger name="org.hibernate.type.descriptor.sql.BasicBinder" level="TRACE" /> 
    <logger name="org.hibernate.type.descriptor.sql.BasicExtractor" level="DEBUG" /> 
    <logger name="org.hibernate.SQL" level="DEBUG" /> 
    <logger name="org.hibernate.engine.QueryParameters" level="DEBUG" /> 
    <logger name="org.hibernate.engine.query.HQLQueryPlan" level="DEBUG" /> 
 
    <!--myibatis log configure--> 
    <logger name="com.apache.ibatis" level="TRACE"/> 
    <logger name="java.sql.Connection" level="DEBUG"/> 
    <logger name="java.sql.Statement" level="DEBUG"/> 
    <logger name="java.sql.PreparedStatement" level="DEBUG"/> 
 
    <!-- 日志輸出級別 --> 
    <root level="DEBUG"> 
        <appender-ref ref="STDOUT" /> 
        <appender-ref ref="FILE"/> 
    </root> 
</configuration>

一個小案例加深對配置的理解

<?xml version="1.0" encoding="UTF-8"?> 
<configuration debug="false"> 
 
    <!--定義日志文件的存儲地址 勿在 LogBack 的配置中使用相對路徑--> 
    <property name="LOG_HOME" value="/home" /> 
 
    <!--控制臺日志， 控制臺輸出 --> 
    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender"> 
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder"> 
            <!--格式化輸出：%d表示日期，%thread表示線程名，%-5level：級別從左顯示5個字符寬度,%msg：日志消息，%n是換行符--> 
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern> 
        </encoder> 
    </appender> 
 
    <!--文件日志， 按照每天生成日志文件 --> 
    <appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender"> 
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy"> 
            <!--日志文件輸出的文件名--> 
            <FileNamePattern>${LOG_HOME}/TestWeb.log.%d{yyyy-MM-dd}.log</FileNamePattern> 
            <!--日志文件保留天數--> 
            <MaxHistory>30</MaxHistory> 
        </rollingPolicy> 
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder"> 
            <!--格式化輸出：%d表示日期，%thread表示線程名，%-5level：級別從左顯示5個字符寬度%msg：日志消息，%n是換行符--> 
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern> 
        </encoder> 
        <!--日志文件最大的大小--> 
        <triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy"> 
            <MaxFileSize>10MB</MaxFileSize> 
        </triggeringPolicy> 
    </appender> 
 
    <!-- show parameters for hibernate sql 專為 Hibernate 定制 --> 
    <logger name="org.hibernate.type.descriptor.sql.BasicBinder" level="TRACE" /> 
    <logger name="org.hibernate.type.descriptor.sql.BasicExtractor" level="DEBUG" /> 
    <logger name="org.hibernate.SQL" level="DEBUG" /> 
    <logger name="org.hibernate.engine.QueryParameters" level="DEBUG" /> 
    <logger name="org.hibernate.engine.query.HQLQueryPlan" level="DEBUG" /> 
 
    <!--myibatis log configure--> 
    <logger name="com.apache.ibatis" level="TRACE"/> 
    <logger name="java.sql.Connection" level="DEBUG"/> 
    <logger name="java.sql.Statement" level="DEBUG"/> 
    <logger name="java.sql.PreparedStatement" level="DEBUG"/> 
 
    <!-- 日志輸出級別 --> 
    <root level="DEBUG"> 
        <appender-ref ref="STDOUT" /> 
        <appender-ref ref="FILE"/> 
    </root> 
</configuration>

開發時，小六六自己的一些特殊的用法(實戰)

第一個，就是在日志的時候加上traceId,這樣的好處就是可以把日志收集到日志平臺的時候，可以很好的查到整個流程

<!--輸出到日志平臺 --> 
<appender name="GELF" class="de.siegmar.logbackgelf.GelfUdpAppender"> 
    <graylogHost>${graylogHost}</graylogHost> 
    <graylogPort>${graylogPort}</graylogPort> 
    <encoder class="de.siegmar.logbackgelf.GelfEncoder"> 
        <originHost>${originHost}</originHost> 
        <includeRawMessage>false</includeRawMessage> 
        <includeMarker>true</includeMarker> 
        <includeMdcData>true</includeMdcData> 
        <includeCallerData>false</includeCallerData> 
        <includeRootCauseData>false</includeRootCauseData> 
        <includeLevelName>true</includeLevelName> 
        <shortPatternLayout class="ch.qos.logback.classic.PatternLayout"> 
            <pattern>%m%nopex</pattern> 
        </shortPatternLayout> 
        <fullPatternLayout class="ch.qos.logback.classic.PatternLayout"> 
            <pattern>%m%n</pattern> 
        </fullPatternLayout> 
        <staticField>app_name:${appName}</staticField> 
        <staticField>app_version:${appVersion}</staticField> 
        <staticField>os_arch:${os.arch}</staticField> 
        <staticField>os_name:${os.name}</staticField> 
        <staticField>os_version:${os.version}</staticField> 
        <staticField>uri:%X{uri}</staticField> 
        <staticField>uid:%X{uid}</staticField> 
        <staticField>ip:%X{ip}</staticField> 
        <staticField>traceId:%X{traceId}</staticField> 
    </encoder> 
</appender>

其中的原理是通過MDC實現的

第二個就是，我們一些格式話的日志，做到數倉里面

<!-- BI操作日志--> 
<appender name="BILogger_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender"> 
   <file>${log.path}/dataBi.dat</file> 
   <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy"> 
      <fileNamePattern>${log.path}/dataBi.dat.%d{yyyyMMdd}.gz</fileNamePattern> 
      <maxHistory>30</maxHistory> 
   </rollingPolicy> 
   <encoder> 
      <charset>UTF-8</charset> 
      <pattern>%date|%msg%n</pattern> 
   </encoder> 
</appender> 
<!-- DI操作日志--> 
<appender name="DILogger_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender"> 
   <file>${log.path}/dataDi.dat</file> 
   <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy"> 
      <fileNamePattern>${log.path}/dataDi.dat.%d{yyyyMMdd}.gz</fileNamePattern> 
      <maxHistory>30</maxHistory> 
   </rollingPolicy> 
   <encoder> 
      <charset>UTF-8</charset> 
      <pattern>%date|%msg%n</pattern> 
   </encoder> 
</appender>

類似于這種。。

結束

我是小六六，三天打魚，兩天曬網，今天就到這了哈!

責任編輯：武曉燕來源：六脈神劍的程序人生

配置 Logback Java