logback的配置詳解及實現原理

logback是java的日誌開源組件，是log4j創始人寫的，性能比log4j要好，目前主要分爲3個模塊

logback-core:核心代碼模塊
logback-classic:log4j的一個改良版本，同時實現了slf4j的接口，這樣你如果之後要切換其他日誌組件也是一件很容易的事
logback-access:訪問模塊與Servlet容器集成提供通過Http來訪問日誌的功能

本篇博客會講解logback的使用、配置詳解、以及logback簡單的一個原理。

一、logback的使用

引入maven依賴

<!--這個依賴直接包含了 logback-core 以及 slf4j-api的依賴-->
<dependency>
     <groupId>ch.qos.logback</groupId>
     <artifactId>logback-classic</artifactId>
     <version>1.2.3</version>
</dependency>

然後就可以直接在代碼中使用slf4j的接口獲取Logger輸出日誌了。（配置在下面的章節介紹）

//這是slf4j的接口，由於我們引入了logback-classic依賴，所以底層實現是logback
private static final Logger LOGGER = LoggerFactory.getLogger(Test.class);

public static void main(String[] args) throws InterruptedException {
    LOGGER.info("hello world");
}

二、logback的配置

配置獲取順序

logback在啓動的時候，會按照下面的順序加載配置文件

如果java程序啓動時指定了logback.configurationFile屬性，就用該屬性指定的配置文件。如java -Dlogback.configurationFile=/path/to/mylogback.xml Test ，這樣執行Test類的時候就會加載/path/to/mylogback.xml配置
在classpath中查找 logback.groovy 文件
在classpath中查找 logback-test.xml 文件
在classpath中查找 logback.xml 文件
如果是 jdk6+,那麼會調用ServiceLoader 查找 com.qos.logback.classic.spi.Configurator接口的第一個實現類
自動使用ch.qos.logback.classic.BasicConfigurator,在控制檯輸出日誌

上面的順序表示優先級，使用java -D配置的優先級最高，只要獲取到配置後就不會再執行下面的流程。相關代碼可以看ContextInitializer#autoConfig()方法。

關於SLF4j的日誌輸出級別

在slf4j中，從小到大的日誌級別依舊是trace、debug、info、warn、error。

logback.xml 配置樣例

<?xml version="1.0" encoding="UTF-8"?>
<configuration>

    <!-- 定義日誌文件的存儲地址 -->
    <!--
        關於catalina.base解釋如下：
            catalina.home指向公用信息的位置，就是bin和lib的父目錄。
            catalina.base指向每個Tomcat目錄私有信息的位置，就是conf、logs、temp、webapps和work的父目錄。
    -->
    <property name="LOG_DIR" value="${catalina.base}/logs"/>

    <!--
        %p:輸出優先級，即DEBUG,INFO,WARN,ERROR,FATAL
        %r:輸出自應用啓動到輸出該日誌訊息所耗費的毫秒數
        %t:輸出產生該日誌事件的線程名
        %f:輸出日誌訊息所屬的類別的類別名
        %c:輸出日誌訊息所屬的類的全名
        %d:輸出日誌時間點的日期或時間，指定格式的方式： %d{yyyy-MM-dd HH:mm:ss}
        %l:輸出日誌事件的發生位置，即輸出日誌訊息的語句在他所在類別的第幾行。
        %m:輸出代碼中指定的訊息，如log(message)中的message
        %n:輸出一個換行符號
    -->
    <!--格式化輸出：%d表示日期，%thread表示線程名，%-5level：級別從左顯示5個字符寬度 %msg：日誌消息，%n是換行符-->
    <property name="pattern" value="%d{yyyyMMdd:HH:mm:ss.SSS} [%thread] %-5level  %msg%n"/>


    <!--
        Appender: 設置日誌信息的去向,常用的有以下幾個
            ch.qos.logback.core.ConsoleAppender (控制檯)
            ch.qos.logback.core.rolling.RollingFileAppender (文件大小到達指定尺寸的時候產生一個新文件)
            ch.qos.logback.core.FileAppender (文件)
    -->
    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
        <!-- 字符串System.out（默認）或者System.err -->
        <target>System.out</target>
        <!-- 對記錄事件進行格式化 -->
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <pattern>${pattern}</pattern>
        </encoder>
    </appender>

    <appender name="SQL_INFO" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!-- 被寫入的文件名，可以是相對目錄，也可以是絕對目錄，如果上級目錄不存在會自動創建 -->
        <file>${LOG_DIR}/sql_info.log</file>
        <!-- 當發生滾動時，決定RollingFileAppender的行爲，涉及文件移動和重命名。屬性class定義具體的滾動策略類 -->
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!-- 必要節點，包含文件名及"%d"轉換符，"%d"可以包含一個java.text.SimpleDateFormat指定的時間格式，默認格式是 yyyy-MM-dd -->
            <fileNamePattern>${LOG_DIR}/sql_info_%d{yyyy-MM-dd}.log.%i.gz</fileNamePattern>
            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <maxFileSize>20MB</maxFileSize>
            </timeBasedFileNamingAndTriggeringPolicy>
            <!-- 可選節點，控制保留的歸檔文件的最大數量，超出數量就刪除舊文件。假設設置每個月滾動，如果是6，則只保存最近6個月的文件，刪除之前的舊文件 -->
            <maxHistory>10</maxHistory>
        </rollingPolicy>
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <pattern>${pattern}</pattern>
        </encoder>
        <!-- LevelFilter： 級別過濾器，根據日誌級別進行過濾 -->
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>INFO</level>
            <!-- 用於配置符合過濾條件的操作 ACCEPT：日誌會被立即處理，不再經過剩餘過濾器 -->
            <onMatch>ACCEPT</onMatch>
            <!-- 用於配置不符合過濾條件的操作 DENY：日誌將立即被拋棄不再經過其他過濾器 -->
            <onMismatch>DENY</onMismatch>
        </filter>
    </appender>

    <appender name="SQL_ERROR" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <file>${LOG_DIR}/sql_error.log</file>
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <fileNamePattern>${LOG_DIR}/sql_error_%d{yyyy-MM-dd}.log.%i.gz</fileNamePattern>
            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <maxFileSize>20MB</maxFileSize>
            </timeBasedFileNamingAndTriggeringPolicy>
            <maxHistory>10</maxHistory>
        </rollingPolicy>
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <pattern>${pattern}</pattern>
        </encoder>
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>ERROR</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>
    </appender>

    <appender name="APP_INFO" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <file>${LOG_DIR}/info.log</file>
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <FileNamePattern>${LOG_DIR}/info.%d{yyyy-MM-dd}.log
            </FileNamePattern>
        </rollingPolicy>
        <encoder>
            <Pattern>[%date{yyyy-MM-dd HH:mm:ss}] [%-5level] [%thread] [%logger:%line]--%mdc{client} %msg%n</Pattern>
        </encoder>
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>INFO</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>
    </appender>

    <appender name="FILE" class="ch.qos.logback.core.FileAppender">
        <encoder class="ch.qos.logback.core.encoder.LayoutWrappingEncoder">
            <layout class="ch.qos.logback.classic.html.HTMLLayout">
                <property name="pattern" value="%d{yyyyMMdd:HH:mm:ss.SSS} [%thread] %-5level  %msg%n"/>
                <pattern>%d{yyyyMMdd:HH:mm:ss.SSS}%thread%-5level%F{32}%M%L%msg</pattern>
            </layout>
        </encoder>
        <file>${LOG_DIR}/test.html</file>
    </appender>


    <!--
        用來設置某一個包或者具體的某一個類的日誌打印級別、以及指定<appender>。
        <loger>僅有一個name屬性，一個可選的level和一個可選的addtivity屬性
        name:
            用來指定受此logger約束的某一個包或者具體的某一個類。
        level:
            用來設置打印級別，大小寫無關：TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF，
            如果未設置此屬性，那麼當前logger將會繼承上級的級別。
        additivity:
            是否向上級loger傳遞打印信息。默認是true。
        <logger>可以包含零個或多個<appender-ref>元素，標識這個appender將會添加到這個logger
    -->
    <logger name="java.sql" level="info" additivity="false">
        <level value="info" />
        <appender-ref ref="STDOUT"></appender-ref>
        <appender-ref ref="SQL_INFO"></appender-ref>
        <appender-ref ref="SQL_ERROR"></appender-ref>
    </logger>

    <logger name="com.souche.LogbackTest" additivity="false">
        <level value="info" />
        <appender-ref ref="STDOUT" />
        <appender-ref ref="APP_INFO" />
        <appender-ref ref="FILE"/>
    </logger>


    <!--
        也是<logger>元素，但是它是根logger。默認debug
        level:用來設置打印級別，大小寫無關：TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF，
        <root>可以包含零個或多個<appender-ref>元素，標識這個appender將會添加到這個logger。
    -->
    <root level="info">
        <level>info</level>
        <appender-ref ref="STDOUT"/>
        <appender-ref ref="SQL_INFO"/>
        <appender-ref ref="SQL_ERROR"/>
        <appender-ref ref="FILE"/>
    </root>

</configuration>

配置詳解

configuration節點相關屬性

屬性名稱	默認值	介紹
debug	false	要不要打印 logback內部日誌信息，true則表示要打印。建議開啓
scan	true	配置發送改變時，要不要重新加載
scanPeriod	1 seconds	檢測配置發生變化的時間間隔。如果沒給出時間單位，默認時間單位是毫秒

configuration子節點介紹

1. contextName節點

設置日誌上下文名稱，後面輸出格式中可以通過定義 %contextName 來打印日誌上下文名稱

2.property節點

用來設置相關變量,通過key-value的方式配置，然後在後面的配置文件中通過 ${key}來訪問

3.appender 節點

日誌輸出組件，主要負責日誌的輸出以及格式化日誌。常用的屬性有name和class

屬性名稱	默認值	介紹
name	無默認值	appender組件的名稱，後面給logger指定appender使用
class	無默認值	appender的具體實現類。常用的有 ConsoleAppender、FileAppender、RollingFileAppender

ConsoleAppender：向控制檯輸出日誌內容的組件，只要定義好encoder節點就可以使用。

FileAppender：向文件輸出日誌內容的組件，用法也很簡單，不過由於沒有日誌滾動策略，一般很少使用

RollingFileAppender：向文件輸出日誌內容的組件，同時可以配置日誌文件滾動策略，在日誌達到一定條件後生成一個新的日誌文件。

appender節點中有一個子節點filter，配置具體的過濾器，比如上面的例子配置了一個內置的過濾器ThresholdFilter，然後設置了level的值爲DEBUG。這樣用這個appender輸出日誌的時候都會經過這個過濾器，日誌級別低於DEBUG的都不會輸出來。

在RollingFileAppender中，可以配置相關的滾動策略，具體可以看配置樣例的註釋。

4.logger以及root節點

root節點和logger節點其實都是表示Logger組件。個人覺的可以把他們之間的關係可以理解爲父子關係，root是最頂層的logger，正常情況getLogger("name/class")沒有找到對應logger的情況下，都是使用root節點配置的logger。

如果配置了logger，並且通過getLogger("name/class")獲取到這個logger，輸出日誌的時候，就會使用這個logger配置的appender輸出，同時還會使用rootLogger配置的appender。我們可以使用logger節點的additivity="false"屬性來屏蔽rootLogger的appender。這樣就可以不使用rootLogger的appender輸出日誌了。

關於logger的獲取，一般logger是配置name的。我們再代碼中經常通過指定的CLass來獲取Logger，比如這樣LoggerFactory.getLogger(Test.class);,其實這個最後也是轉成對應的包名+類名的字符串com.kongtrio.Test.class。假設有一個logger配置的那麼是com.kongtrio，那麼通過LoggerFactory.getLogger(Test.class)獲取到的logger就是這個logger。

也就是說，name可以配置包名，也可以配置自定義名稱。

上面說的logger和root節點的父子關係只是爲了方便理解，具體的底層實現本人並沒有看，他們之間真正的關係讀者有興趣的話可以去看logback的源碼

一些特性的支持

在看logback的啓動日誌時，看到下面這句話。

no applicable action for [totalSizeCap], current ElementPath is [[configuration][appender][rollingPolicy][totalSizeCap]]

no applicable action for [maxFileSize], current ElementPath is [[configuration][appender][rollingPolicy][maxFileSize]]

大概意思解析logbck配置時不支持totalSizeCap、maxFileSize的配置。後來查了下，果然，totalSizeCap是在1.1.6之後的版本纔開始支持的，切換到1.1.7之後就不會出現這句話了。

maxFileSize比較奇怪，試了目前所有的版本都不支持rollingPolicy—maxFileSize的配置方案，如果配置到triggeringPolicy節點下，又是可以生效的。但是官網給的文檔上又有出現rollingPolicy下面的。

Ps:啓動的時候建議多看看日誌，可以及早發現一些問題。比如這些配置沒生效，看到這些日誌就可以馬上調整，而不會因爲沒達到預期的效果而造成一些損失。

三、實現原理

slf4j是什麼

slf4j只是一套標準，通俗來講，就是定義了一系列接口，它並不提供任何的具體實現。所以，我們使用這套接口進行開發，可以任意的切換底層的實現框架。

比如，一開始項目用的是log4j的實現，後來發現log4j的性能太差了，想換成logback，由於我們代碼中都是面向slf4j接口的，這樣我們只要吧log4j的依賴換成logback就可以了。

logback-classic啓動原理

我們在調用LoggerFactory.getLogger(Test.class)時，這些接口或者類都是slf4j的，那麼，它是怎麼切換到logback的實現的呢？

爲了解決這個問題，我追蹤了一下代碼，發現logback-classic底下，有一個slf4j的包.

logback-slf4j實現.png

slf4j在初始化時會調用org.slf4j.StaticLoggerBinder進行初始化。因此，每個要實現slf4j的日誌組件項目，底下都要有org.slf4j.StaticLoggerBinder的具體實現。這樣slf4j纔會在初始化的關聯到具體的實現。

比如logback在自己定義的StaticLoggerBinder做了自己組件的初始化工作。下面是網上找的一個時序圖：

多個依賴包都實現了slf4j

如果引入了多個slf4j的實現依賴包，那麼各個包底下都有org.slf4j.StaticLoggerBinder的實現，這時候slf4j會調用哪個包的StaticLoggerBinder實現呢？

這個問題和java的類加載機制有關係，在雙親委派機制的模型中，這些引入的依賴包通常都是由Application ClassLoader來加載的。Application ClassLoader會加載用戶路徑(classpath)上指定的類庫，如果多個org.slf4j.StaticLoggerBinder的jar包實現，類加載器先掃到哪個jar包，就會使用jar包提供的實現。

舉個例子，我們通過 java -classpath a.jar:b.jar Test運行Test類，a.jar和b.jar都定義了org.slf4j.StaticLoggerBinder的實現，那麼執行Test時加載StaticLoggerBinder類就會加載a.jar中的那個定義類。因爲a.jar在classpath中排在比較前面。

四、總結

日誌組件的使用一般都非常簡單，幾乎所有的項目中都會用到各種各樣的日誌組件。但是可能就是由於太簡單了，比較少的人會願意深入系統的去了解。本人也只是對logback的配置以及一些簡單的原理做了一些瞭解，並沒有很深入的去看logback的具體實現。

因此，本文的內容大部分都是基於官網的文檔以及網上一些其他關於logback的博客，雖然也做了一些簡單的測試，但並不保證全部都是正確的。

logback的配置詳解及實現原理

一、logback的使用

二、logback的配置

配置獲取順序

關於SLF4j的日誌輸出級別

logback.xml 配置樣例

配置詳解

一些特性的支持

三、實現原理

slf4j是什麼

logback-classic啓動原理

多個依賴包都實現了slf4j

四、總結

前端使用 Konva 實現可視化設計器（13）- 折線 - 最優路徑應用【思路篇】

log4j的使用和配置

Sql Server 時間格式化

Fastjson 判斷 JSONObject 與 JSONArray

Java常用工具類： HttpClientUtil

Java常用工具類：生成二維碼base64編碼

Mac下配置sublime實現LaTeX

https://yachay.unat.edu.pe/blog/index.php?comment_area=format_blog&comment_component=blog&comment_co

linux以太網驅動總結