技術標籤：log4j配置檔案詳解logback不輸出至檔案logback使用logback日誌打印出方法logback配置檔案詳解slf4j配置詳解

作者：ryelqy

轉載自：

https://www.cnblogs.com/ryelqy/p/10314147.html

一、logback的介紹

Logback是由log4j創始人設計的另一個開源日誌元件,官方網站：http://logback.qos.ch。它當前分為下面下個模組：

• logback-core：其它兩個模組的基礎模組

• logback-classic：它是log4j的一個改良版本，同時它完整實現了slf4j API使你可以很方便地更換成其它日誌系統如log4j或JDK14 Logging

• logback-access：訪問模組與Servlet容器整合提供通過Http來訪問日誌的功能

二、logback取代log4j的理由：

1. 更快的實現：Logback的核心重寫了，在一些關鍵執行路徑上效能提升10倍以上。而且logback不僅效能提升了，初始化記憶體載入也更小了。

2. 非常充分的測試：Logback經過了幾年，數不清小時的測試。Logback的測試完全不同級別的。

3. Logback-classic非常自然實現了SLF4j：Logback-classic實現了SLF4j。在使用SLF4j中，你都感覺不到logback-classic。而且因為logback-classic非常自然地實現了slf4j ， 所 以切換到log4j或者其他，非常容易，只需要提供成另一個jar包就OK，根本不需要去動那些通過SLF4JAPI實現的程式碼。

4. 非常充分的文件 官方網站有兩百多頁的文件。

5. 自動重新載入配置檔案，當配置檔案修改了，Logback-classic能自動重新載入配置檔案。掃描過程快且安全，它並不需要另外建立一個掃描執行緒。這個技術充分保證了應用程式能跑得很歡在JEE環境裡面。

6. Lilith是log事件的觀察者，和log4j的chainsaw類似。而lilith還能處理大數量的log資料 。

7. 謹慎的模式和非常友好的恢復，在謹慎模式下，多個FileAppender例項跑在多個JVM下，能 夠安全地寫道同一個日誌檔案。RollingFileAppender會有些限制。Logback的FileAppender和它的子類包括 RollingFileAppender能夠非常友好地從I/O異常中恢復。

8. 配置檔案可以處理不同的情況，開發人員經常需要判斷不同的Logback配置檔案在不同的環境下(開發，測試，生產)。而這些配置檔案僅僅只有一些很小的不同，可以通過,和來實現，這樣一個配置檔案就可以適應多個環境。

9. Filters(過濾器)有些時候，需要診斷一個問題，需要打出日誌。在log4j，只有降低日誌級別，不過這樣會打出大量的日誌，會影響應用效能。在Logback，你可以繼續 保持那個日誌級別而除掉某種特殊情況，如alice這個使用者登入，她的日誌將打在DEBUG級別而其他使用者可以繼續打在WARN級別。要實現這個功能只需加4行XML配置。可以參考MDCFIlter 。

10. SiftingAppender(一個非常多功能的Appender)：它可以用來分割日誌檔案根據任何一個給定的執行引數。如，SiftingAppender能夠區別日誌事件跟進使用者的Session，然後每個使用者會有一個日誌檔案。

11. 自動壓縮已經打出來的log：RollingFileAppender在產生新檔案的時候，會自動壓縮已經打出來的日誌檔案。壓縮是個非同步過程，所以甚至對於大的日誌檔案，在壓縮過程中應用不會受任何影響。

12. 堆疊樹帶有包版本：Logback在打出堆疊樹日誌時，會帶上包的資料。

13. 自動去除舊的日誌檔案：通過設定TimeBasedRollingPolicy或者SizeAndTimeBasedFNATP的maxHistory屬性，你可以控制已經產生日誌檔案的最大數量。如果設定maxHistory 12，那那些log檔案超過12個月的都會被自動移除。

三、logback的配置介紹

• Logger、appender及layout

　　Logger作為日誌的記錄器，把它關聯到應用的對應的context上後，主要用於存放日誌物件，也可以定義日誌型別、級別。
　　Appender主要用於指定日誌輸出的目的地，目的地可以是控制檯、檔案、遠端套接字伺服器、 MySQL、PostreSQL、 Oracle和其他資料庫、 JMS和遠端UNIX Syslog守護程序等。
　　Layout 負責把事件轉換成字串，格式化的日誌資訊的輸出。

• logger context

　　各個logger 都被關聯到一個 LoggerContext，LoggerContext負責製造logger，也負責以樹結構排列各logger。其他所有logger也通過org.slf4j.LoggerFactory 類的靜態方法getLogger取得。getLogger方法以 logger名稱為引數。用同一名字呼叫LoggerFactory.getLogger 方法所得到的永遠都是同一個logger物件的引用。

• 有效級別及級別的繼承

　　Logger 可以被分配級別。級別包括：TRACE、DEBUG、INFO、WARN 和 ERROR，定義於ch.qos.logback.classic.Level類。如果 logger沒有被分配級別，那麼它將從有被分配級別的最近的祖先那裡繼承級別。root logger 預設級別是 DEBUG。

• 列印方法與基本的選擇規則

　　列印方法決定記錄請求的級別。例如，如果 L 是一個 logger 例項，那麼，語句 L.info("..")是一條級別為 INFO的記錄語句。記錄請求的級別在高於或等於其 logger 的有效級別時被稱為被啟用，否則，稱為被禁用。記錄請求級別為 p，其 logger的有效級別為 q，只有則當 p>=q時，該請求才會被執行。
該規則是 logback 的核心。級別排序為：TRACE < DEBUG < INFO < WARN < ERROR

四、logback的預設配置

如果配置檔案 logback-test.xml 和 logback.xml 都不存在，那麼 logback 預設地會呼叫BasicConfigurator ，建立一個最小化配置。最小化配置由一個關聯到根 logger 的ConsoleAppender 組成。輸出用模式為%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n 的 PatternLayoutEncoder 進行格式化。root logger 預設級別是 DEBUG。

• Logback的配置檔案

　　Logback 配置檔案的語法非常靈活。正因為靈活，所以無法用 DTD 或 XML schema 進行定義。儘管如此，可以這樣描述配置檔案的基本結構：以開頭，後面有零個或多個元素，有零個或多個元素，有最多一個元素。

• Logback預設配置的步驟

1. 嘗試在 classpath下查詢檔案logback-test.xml；

2. 如果檔案不存在，則查詢檔案logback.xml；

3. 如果兩個檔案都不存在，logback用BasicConfigurator自動對自己進行配置，這會導致記錄輸出到控制檯。

五、logback.xml常用配置詳解

• (1)根節點，包含下面三個屬性：

　　　　scan: 當此屬性設定為true時，配置檔案如果發生改變，將會被重新載入，預設值為true。
　　　　scanPeriod: 設定監測配置檔案是否有修改的時間間隔，如果沒有給出時間單位，預設單位是毫秒。當scan為true時，此屬性生效。預設的時間間隔為1分鐘。
　　　　debug: 當此屬性設定為true時，將打印出logback內部日誌資訊，實時檢視logback執行狀態。預設值為false。
　　例如：

<configuration scan="true" scanPeriod="60 seconds" debug="false"> 　　   configuration>　

• (2) 子節點：用來設定上下文名稱，每個logger都關聯到logger上下文，預設上下文名稱為default。但可以使用設定成其他名字，用於區分不同應用程式的記錄。一旦設定，不能修改。

　　例如：

<configuration scan="true" scanPeriod="60 seconds" debug="false">      <contextName>myAppNamecontextName> 　　  configuration>    

• (3)子節點 ：用來定義變數值，它有兩個屬性name和value，通過定義的值會被插入到logger上下文中，可以使“${}”來使用變數。

　　　　name: 變數的名稱
　　　　value: 的值時變數定義的值
　　例如：

<configuration scan="true" scanPeriod="60 seconds" debug="false"> 　　　<property name="APP_Name" value="myAppName" /> 　　　<contextName>${APP_Name}contextName> 　　　 configuration>

• (4)子節點：獲取時間戳字串，他有兩個屬性key和datePattern

　　　　key: 標識此 的名字；
　　　　datePattern: 設定將當前時間(解析配置檔案的時間)轉換為字串的模式，遵循java.txt.SimpleDateFormat的格式。
　　例如：

<configuration scan="true" scanPeriod="60 seconds" debug="false"> 　　　　　　<timestamp key="bySecond" datePattern="yyyyMMdd'T'HHmmss"/> 　　　　　　<contextName>${bySecond}contextName> 　　　　　　 　　　　configuration>

• (5) 子節點：負責寫日誌的元件，它有兩個必要屬性name和class。name指定appender名稱，class指定appender的全限定名

　　　　5.1、ConsoleAppender 把日誌輸出到控制檯，有以下子節點：：對日誌進行格式化。(具體引數稍後講解 )：字串System.out(預設)或者System.err(區別不多說了)
　　　　例如：

<configuration> 　　　<appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender"> 　　　　　 <encoder> 　　　　　　　　　<pattern>%-4relative [%thread] %-5level %logger{35} - %msg %npattern> 　　　　　 encoder> 　　　appender> 　　　<root level="DEBUG"> 　　　　　　<appender-ref ref="STDOUT" /> 　　　root> configuration>

　　　　上述配置表示把>=DEBUG級別的日誌都輸出到控制檯

　　　　5.2、FileAppender：把日誌新增到檔案，有以下子節點：：被寫入的檔名，可以是相對目錄，也可以是絕對目錄，如果上級目錄不存在會自動建立，沒有預設值。：如果是 true，日誌被追加到檔案結尾，如果是 false，清空現存檔案，預設是true。：對記錄事件進行格式化。(具體引數稍後講解 )：如果是 true，日誌會被安全的寫入檔案，即使其他的FileAppender也在向此檔案做寫入操作，效率低，預設是 false。
　　　　例如：

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

　　　　上述配置表示把>=DEBUG級別的日誌都輸出到testFile.log

　　　　5.3、RollingFileAppender：滾動記錄檔案，先將日誌記錄到指定檔案，當符合某個條件時，將日誌記錄到其他檔案。有以下子節點：：被寫入的檔名，可以是相對目錄，也可以是絕對目錄，如果上級目錄不存在會自動建立，沒有預設值。：如果是 true，日誌被追加到檔案結尾，如果是 false，清空現存檔案，預設是true。:當發生滾動時，決定RollingFileAppender的行為，涉及檔案移動和重新命名。屬性class定義具體的滾動策略類
　　　　　　：最常用的滾動策略，它根據時間來制定滾動策略，既負責滾動也負責出發滾動。有以下子節點：：必要節點，包含檔名及“%d”轉換符，“%d”可以包含一個java.text.SimpleDateFormat指定的時間格式，如：%d{yyyy-MM}。
如果直接使用 %d，預設格式是 yyyy-MM-dd。RollingFileAppender的file位元組點可有可無，通過設定file，可以為活動檔案和歸檔檔案指定不同位置，當前日誌總是記錄到file指定的檔案(活動檔案)，活動檔案的名字不會改變；
如果沒設定file，活動檔案的名字會根據fileNamePattern 的值，每隔一段時間改變一次。“/”或者“\”會被當做目錄分隔符。:
可選節點，控制保留的歸檔檔案的最大數量，超出數量就刪除舊檔案。假設設定每個月滾動，且是6，則只儲存最近6個月的檔案，刪除之前的舊檔案。注意，刪除舊檔案是，那些為了歸檔而建立的目錄也會被刪除。
　　　　　　：檢視當前活動檔案的大小，如果超過指定大小會告知RollingFileAppender 觸發當前活動檔案滾動。只有一個節點::這是活動檔案的大小，預設值是10MB。：當為true時，不支援FixedWindowRollingPolicy。支援TimeBasedRollingPolicy，但是有兩個限制，1不支援也不允許檔案壓縮，2不能設定file屬性，必須留空。: 告知 RollingFileAppender 合適啟用滾動。
　　　　　　 根據固定視窗演算法重新命名檔案的滾動策略。有以下子節點：:視窗索引最小值:視窗索引最大值，當用戶指定的視窗過大時，會自動將視窗設定為12。:必須包含“%i”例如，假設最小值和最大值分別為1和2，命名模式為 mylog%i.log,會產生歸檔檔案mylog1.log和mylog2.log。還可以指定檔案壓縮選項，例如，mylog%i.log.gz 或者 沒有log%i.log.zip
　　　　　　例如：　　　　　　　　

<configuration> 　　　　　　　　　　<appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender"> 　　　　　　　　　　　　<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy"> 　　　　　　　　　　　　　　<fileNamePattern>logFile.%d{yyyy-MM-dd}.logfileNamePattern> 　　　　　　　　　　　　　　<maxHistory>30maxHistory> 　　　　　　　　　　　　rollingPolicy> 　　　　　　　　　　　　<encoder> 　　　　　　　　　　　　　　<pattern>%-4relative [%thread] %-5level %logger{35} - %msg%npattern> 　　　　　　　　　　　　encoder> 　　　　　　　　　　appender> 　　　　　　　　　　<root level="DEBUG"> 　　　　　　　　　　　　<appender-ref ref="FILE" /> 　　　　　　　　　　root> 　　　　　　　　configuration>

備註：上述配置表示每天生成一個日誌檔案，儲存30天的日誌檔案。

<configuration> 　　　　　　　　　　<appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender"> 　　　　　　　　　　　　<file>test.logfile> 　　　　　　　　　　　　<rollingPolicy class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy"> 　　　　　　　　　　　　　　<fileNamePattern>tests.%i.log.zipfileNamePattern> 　　　　　　　　　　　　　　<minIndex>1minIndex> 　　　　　　　　　　　　　　<maxIndex>3maxIndex> 　　　　　　　　　　　　rollingPolicy> 　　　　　　　　　　　　<triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy"> 　　　　　　　　　　　　　　<maxFileSize>5MBmaxFileSize> 　　　　　　　　　　　　triggeringPolicy> 　　　　　　　　　　　　<encoder> 　　　　　　　　　　　　　　<pattern>%-4relative [%thread] %-5level %logger{35} - %msg%npattern> 　　　　　　　　　　　　encoder> 　　　　　　　　　　appender> 　　　　　　　　　　<root level="DEBUG"> 　　　　　　　　　　　　<appender-ref ref="FILE" /> 　　　　　　　　　　root> 　　　　　　　　configuration>

　　　　　　　　備註：上述配置表示按照固定視窗模式生成日誌檔案，當檔案大於5MB時，生成新的日誌檔案。視窗大小是1到3，當儲存了3個歸檔檔案後，將覆蓋最早的日誌。：對記錄事件進行格式化。負責兩件事，一是把日誌資訊轉換成位元組陣列，二是把位元組陣列寫入到輸出流。
PatternLayoutEncoder 是唯一有用的且預設的encoder ，有一個節點，用來設定日誌的輸入格式。使用“%”加“轉換符”方式，如果要輸出“%”，則必須用“\”對“\%”進行轉義。
　　　　5.4、還有SocketAppender、SMTPAppender、DBAppender、SyslogAppender、SiftingAppender，並不常用，這裡就不詳解了。
大家可以參考官方文件(http://logback.qos.ch/documentation.html)，還可以編寫自己的Appender。

• (6)子節點：用來設定某一個包或具體的某一個類的日誌列印級別、以及指定。僅有一個name屬性，一個可選的level和一個可選的addtivity屬性。

可以包含零個或多個元素，標識這個appender將會新增到這個loger
　　　　name: 用來指定受此loger約束的某一個包或者具體的某一個類。
　　　　level: 用來設定列印級別，大小寫無關：TRACE, DEBUG, INFO, WARN, ERROR, ALL和OFF，還有一個特俗值INHERITED或者同義詞NULL，代表強制執行上級的級別。如果未設定此屬性，那麼當前loger將會繼承上級的級別。
addtivity: 是否向上級loger傳遞列印資訊。預設是true。同一樣，可以包含零個或多個元素，標識這個appender將會新增到這個loger。

• (7)子節點:它也是元素，但是它是根loger,是所有的上級。只有一個level屬性，因為name已經被命名為"root",且已經是最上級了。

　　　　level: 用來設定列印級別，大小寫無關：TRACE, DEBUG, INFO, WARN, ERROR, ALL和OFF，不能設定為INHERITED或者同義詞NULL。預設是DEBUG。

六、常用logger配置

<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" /><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"/>

七、Demo

• (1)新增依賴包logback使用需要和slf4j一起使用，所以總共需要新增依賴的包有slf4j-api

logback使用需要和slf4j一起使用，所以總共需要新增依賴的包有slf4j-api.jar，logback-core.jar，logback-classic.jar，logback-access.jar這個暫時用不到所以不新增依賴了，maven配置

<properties>　　　　<project.build.sourceEncoding>UTF-8project.build.sourceEncoding>　　　　<logback.version>1.1.7logback.version>　　　　<slf4j.version>1.7.21slf4j.version>　　properties>　　<dependencies>　　　　<dependency>　　　　　　<groupId>org.slf4jgroupId>　　　　　　<artifactId>slf4j-apiartifactId>　　　　　　<version>${slf4j.version}version>　　　　　　<scope>compilescope>　　　　dependency>　　　　<dependency>　　　　　　<groupId>ch.qos.logbackgroupId>　　　　　　<artifactId>logback-coreartifactId>　　　　　　<version>${logback.version}version>　　　　dependency>　　　　<dependency>　　　　　　<groupId>ch.qos.logbackgroupId>　　　　　　<artifactId>logback-classicartifactId>　　　　　　<version>${logback.version}version>　　　　　　dependency>　　dependencies>

• (2)logback.xml配置

<?xml version="1.0" encoding="UTF-8"?><configuration debug="false"><property name="LOG_HOME" value="/home" /><appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender"><encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder"><pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%npattern>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}.logFileNamePattern><MaxHistory>30MaxHistory>rollingPolicy><encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder"><pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%npattern>encoder><triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy"><MaxFileSize>10MBMaxFileSize>triggeringPolicy>appender><root level="INFO"><appender-ref ref="STDOUT" />root>configuration>

• (3)java程式碼

/**　　* Hello world!　　*/　　public class App {　　private final static Logger logger = LoggerFactory.getLogger(App.class);　　　　public static void main(String[] args) {　　　　　　logger.info("logback 成功了");　　　　　　logger.error("logback 成功了");　　　　　　logger.debug("logback 成功了");　　　　}　　}

• (4)輸出

八、總結

logback的配置，需要配置輸出源appender，打日誌的loger(子節點)和root(根節點)，實際上，它輸出日誌是從子節點開始，子節點如果有輸出源直接輸入，如果無，判斷配置的addtivity，是否像上級傳遞，即是否向root傳遞，傳遞則採用root的輸出源，否則不輸出日誌。

長按關注鋒哥微信公眾號，非常感謝；

加鋒哥微信 拉你進微信群扯淡^_^：