為什么推薦你使用 logback 取代 log4j

一、logback的介紹

Logback是由log4j創(chuàng)始人設計的另一個開源日志組件，它當前分為下面下個模塊：

• logback-core：其它兩個模塊的基礎模塊
• logback-classic：它是log4j的一個改良版本，同時它完整實現(xiàn)了slf4j API使你可以很方便地更換成其它日志系統(tǒng)如log4j或JDK14 Logging
• logback-access：訪問模塊與Servlet容器集成提供通過Http來訪問日志的功能

二、logback取代log4j的理由：

1.更快的實現(xiàn)：Logback的內(nèi)核重寫了，在一些關鍵執(zhí)行路徑上性能提升10倍以上。而且logback不僅性能提升了，初始化內(nèi)存加載也更小了。

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

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

4.非常充分的文檔：官方網(wǎng)站有兩百多頁的文檔。

5.自動重新加載配置文件，當配置文件修改了，Logback-classic能自動重新加載配置文件。掃描過程快且安全，它并不需要另外創(chuàng)建一個掃描線程。這個技術充分保證了應用程序能跑得很歡在JEE環(huán)境里面。

6.Lilith是log事件的觀察者，和log4j的chainsaw類似。而lilith還能處理大數(shù)量的log數(shù)據(jù)。

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

8.配置文件可以處理不同的情況，開發(fā)人員經(jīng)常需要判斷不同的Logback配置文件在不同的環(huán)境下（開發(fā)，測試，生產(chǎn)）。而這些配置文件僅僅只有一些很小的不同，可以通過,來實現(xiàn)，這樣一個配置文件就可以適應多個環(huán)境。

9.打印更加靈活：Filters（過濾器）有些時候，需要診斷一個問題，需要打出日志。在log4j，只有降低日志級別，不過這樣會打出大量的日志，會影響應用性能。在Logback，你可以繼續(xù)保持那個日志級別而除掉某種特殊情況，如alice這個用戶登錄，她的日志將打在DEBUG級別而其他用戶可以繼續(xù)打在WARN級別。要實現(xiàn)這個功能只需加4行XML配置。可以參考MDCFIlter 。

10.SiftingAppender（一個非常多功能的Appender）：它可以用來分割日志文件根據(jù)任何一個給定的運行參數(shù)。如，SiftingAppender能夠區(qū)別日志事件跟進用戶的Session，然后每個用戶會有一個日志文件。

11.自動壓縮已經(jīng)打出來的log：RollingFileAppender在產(chǎn)生新文件的時候，會自動壓縮已經(jīng)打出來的日志文件。壓縮是個異步過程，所以甚至對于大的日志文件，在壓縮過程中應用不會受任何影響。

12.堆棧樹帶有包版本：Logback在打出堆棧樹日志時，會帶上包的數(shù)據(jù)。

13.自動去除舊的日志文件：通過設置TimeBasedRollingPolicy或者SizeAndTimeBasedFNATP的maxHistory屬性，你可以控制已經(jīng)產(chǎn)生日志文件的最大數(shù)量。如果設置maxHistory 12，那那些log文件超過12個月的都會被自動移除。

三、logback的配置介紹

Logger、appender及l(fā)ayout

Logger作為日志的記錄器，把它關聯(lián)到應用的對應的context上后，主要用于存放日志對象，也可以定義日志類型、級別。

Appender主要用于指定日志輸出的目的地，目的地可以是控制臺、文件、遠程套接字服務器、 MySQL、PostreSQL、 Oracle和其他數(shù)據(jù)庫、 JMS和遠程UNIX Syslog守護進程等。

Layout 負責把事件轉(zhuǎn)換成字符串，格式化的日志信息的輸出。

logger context

各個logger 都被關聯(lián)到一個?LoggerContext，LoggerContext負責制造logger，也負責以樹結(jié)構(gòu)排列各logger。其他所有l(wèi)ogger也通過org.slf4j.LoggerFactory?類的靜態(tài)方法getLogger取得。

getLogger方法以 logger名稱為參數(shù)。用同一名字調(diào)用LoggerFactory.getLogger?方法所得到的永遠都是同一個logger對象的引用。

有效級別及級別的繼承

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

打印方法與基本的選擇規(guī)則

打印方法決定記錄請求的級別。例如，如果 L 是一個 logger 實例，那么，語句?L.info("..")是一條級別為 INFO的記錄語句。記錄請求的級別在高于或等于其 logger 的有效級別時被稱為被啟用，否則，稱為被禁用。記錄請求級別為 p，其 logger的有效級別為 q，只有則當 p>=q時，該請求才會被執(zhí)行。

該規(guī)則是 logback 的核心。級別排序為：TRACE < DEBUG < INFO < WARN < ERROR

四、logback的默認配置

如果配置文件 logback-test.xml 和 logback.xml 都不存在，那么 logback 默認地會調(diào)用BasicConfigurator ，創(chuàng)建一個最小化配置。最小化配置由一個關聯(lián)到根 logger 的ConsoleAppender 組成。

輸出用模式為%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n?的?PatternLayoutEncoder?進行格式化。root logger?默認級別是 DEBUG。

Logback的配置文件

Logback 配置文件的語法非常靈活。正因為靈活，所以無法用 DTD 或 XML schema 進行定義。盡管如此，可以這樣描述配置文件的基本結(jié)構(gòu)：以開頭，后面有零個或多個元素，有零個或多個元素，有最多一個元素。

Logback默認配置的步驟

• 嘗試在 classpath下查找文件logback-test.xml；
• 如果文件不存在，則查找文件logback.xml；
• 如果兩個文件都不存在，logback用BasicConfigurator自動對自己進行配置，這會導致記錄輸出到控制臺。

五、logback.xml常用配置詳解

(1)?根節(jié)點

包含下面三個屬性：

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

例如：

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

(2) 子節(jié)點

用來設置上下文名稱，每個logger都關聯(lián)到logger上下文，默認上下文名稱為default。但可以使用設置成其他名字，用于區(qū)分不同應用程序的記錄。一旦設置，不能修改。

例如：

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

(3)?子節(jié)點

用來定義變量值，它有兩個屬性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)?子節(jié)點

獲取時間戳字符串，他有兩個屬性key和datePattern

• key: 標識此?的名字；
• datePattern: 設置將當前時間（解析配置文件的時間）轉(zhuǎn)換為字符串的模式，遵循java.txt.SimpleDateFormat的格式。

例如：

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

(5) 子節(jié)點

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

5.1、ConsoleAppender 把日志輸出到控制臺，有以下子節(jié)點：

• ：對日志進行格式化。（具體參數(shù)稍后講解 ）
• ：字符串System.out(默認)或者System.err（區(qū)別不多說了）

例如：

<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：把日志添加到文件，有以下子節(jié)點：

• ：被寫入的文件名，可以是相對目錄，也可以是絕對目錄，如果上級目錄不存在會自動創(chuàng)建，沒有默認值。
• ：如果是 true，日志被追加到文件結(jié)尾，如果是 false，清空現(xiàn)存文件，默認是true。
• ：對記錄事件進行格式化。（具體參數(shù)稍后講解 ）
• ：如果是 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：滾動記錄文件，先將日志記錄到指定文件，當符合某個條件時，將日志記錄到其他文件。有以下子節(jié)點：

：?被寫入的文件名，可以是相對目錄，也可以是絕對目錄，如果上級目錄不存在會自動創(chuàng)建，沒有默認值。

：?如果是 true，日志被追加到文件結(jié)尾，如果是 false，清空現(xiàn)存文件，默認是true。

:?當發(fā)生滾動時，決定RollingFileAppender的行為，涉及文件移動和重命名。屬性class定義具體的滾動策略類：

class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy"：最常用的滾動策略，它根據(jù)時間來制定滾動策略，既負責滾動也負責出發(fā)滾動。有以下子節(jié)點：

• ：

必要節(jié)點，包含文件名及%d轉(zhuǎn)換符，%d可以包含一個java.text.SimpleDateFormat指定的時間格式，如：%d{yyyy-MM}。

如果直接使用?%d，默認格式是?yyyy-MM-dd。RollingFileAppender的file字節(jié)點可有可無，通過設置file，可以為活動文件和歸檔文件指定不同位置，當前日志總是記錄到file指定的文件（活動文件），活動文件的名字不會改變；

如果沒設置file，活動文件的名字會根據(jù)fileNamePattern 的值，每隔一段時間改變一次。/或者\會被當做目錄分隔符。

• :

可選節(jié)點，控制保留的歸檔文件的最大數(shù)量，超出數(shù)量就刪除舊文件。假設設置每個月滾動，且是6，則只保存最近6個月的文件，刪除之前的舊文件。注意，刪除舊文件是，那些為了歸檔而創(chuàng)建的目錄也會被刪除。

class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy"：查看當前活動文件的大小，如果超過指定大小會告知RollingFileAppender 觸發(fā)當前活動文件滾動。只有一個節(jié)點:

• :這是活動文件的大小，默認值是10MB。
• ：當為true時，不支持FixedWindowRollingPolicy。支持TimeBasedRollingPolicy，但是有兩個限制，1不支持也不允許文件壓縮，2不能設置file屬性，必須留空。
• : 告知 RollingFileAppender 合適激活滾動?！　　　　　?em style="outline: 0px;max-width: 100%;color: rgb(14, 136, 235);letter-spacing: 0.3em;box-sizing: border-box !important;overflow-wrap: break-word !important;">class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy"?根據(jù)固定窗口算法重命名文件的滾動策略。有以下子節(jié)點：
• :窗口索引最小值
• :窗口索引最大值，當用戶指定的窗口過大時，會自動將窗口設置為12。
• :必須包含%i例如，假設最小值和最大值分別為1和2，命名模式為 mylog%i.log,會產(chǎn)生歸檔文件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個歸檔文件后，將覆蓋最早的日志。

：對記錄事件進行格式化。負責兩件事，一是把日志信息轉(zhuǎn)換成字節(jié)數(shù)組，二是把字節(jié)數(shù)組寫入到輸出流。

PatternLayoutEncoder 是唯一有用的且默認的encoder ，有一個節(jié)點，用來設置日志的輸入格式。使用“%”加“轉(zhuǎn)換符”方式，如果要輸出“%”，則必須用“\”對“%”進行轉(zhuǎn)義。

5.4、還有SocketAppender、SMTPAppender、DBAppender、SyslogAppender、SiftingAppender，并不常用，這里就不詳解了。

大家可以參考官方文檔，還可以編寫自己的Appender。

（6）子節(jié)點

用來設置某一個包或具體的某一個類的日志打印級別、以及指定。僅有一個name屬性，一個可選的level和一個可選的addtivity屬性。

可以包含零個或多個元素，標識這個appender將會添加到這個loger

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

（7）子節(jié)點

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

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配置

<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）輸出

八、總結(jié)

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