Java日志框架-logback的介紹及配置使用方法（純Java工程）（轉）

說明：內容估計有些舊，2011年的，但是大體意思應該沒多大變化，最新的配置可以參考官方文檔。

一、logback的介紹

Logback是由log4j創始人設計的又一個開源日志組件。logback當前分成三個模塊：logback-core，logback- classic和logback-access。logback-core是其它兩個模塊的基礎模塊。logback-classic是log4j的一個改良版本。此外logback-classic完整實現SLF4J API使你可以很方便地更換成其它日志系統如log4j或JDK14 Logging。logback-access訪問模塊與Servlet容器集成提供通過Http來訪問日志的功能。 Logback是要與SLF4J結合起來用兩個組件的官方網站如下：

logback的官方網站： http://logback.qos.ch

SLF4J的官方網站：http://www.slf4j.org

本文章用到的組件如下：

logback-access-1.0.0.jar（這個可以不用）

logback-classic-1.0.0.jar

logback-core-1.0.0.jar

slf4j-api-1.6.0.jar

POM：

<!-- logback+slf4j -->  
<dependency>  
    <groupId>org.slf4j</groupId>  
    <artifactId>slf4j-api</artifactId>  
    <version>1.6.0</version>  
    <type>jar</type>  
    <scope>compile</scope>  
</dependency>  
<dependency>  
    <groupId>ch.qos.logback</groupId>  
    <artifactId>logback-core</artifactId>  
    <version>0.9.28</version>  
    <type>jar</type>  
</dependency>  
<dependency>  
    <groupId>ch.qos.logback</groupId>  
    <artifactId>logback-classic</artifactId>  
    <version>0.9.28</version>  
    <type>jar</type>  
</dependency>  

二、logback取代log4j的理由：

Logback和log4j是非常相似的，如果你對log4j很熟悉，那對logback很快就會得心應手。下面列了logback相對於log4j的一些優點：

1、更快的實現 

Logback的內核重寫了，在一些關鍵執行路徑上性能提升10倍以上。而且logback不僅性能提升了，初始化內存加載也更小了。

2、非常充分的測試 

Logback經過了幾年，數不清小時的測試。Logback的測試完全不同級別的。在作者的觀點，這是簡單重要的原因選擇logback而不是log4j。

3、Logback-classic非常自然實現了SLF4j   

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

4、非常充分的文檔 

官方網站有兩百多頁的文檔。

5、自動重新加載配置文件  

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

6、Lilith  

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

7、謹慎的模式和非常友好的恢復  

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

8、配置文件可以處理不同的情況   

開發人員經常需要判斷不同的Logback配置文件在不同的環境下（開發，測試，生產）。而這些配置文件僅僅只有一些很小的不同，可以通過 <if>，<then>和<else>標簽來實現，這樣一個配置文件就可以適應多個環境。

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比log4j太優秀了，讓我們的應用全部建立logback上吧 ！

三、Logback的配置介紹

1、Logger、appender及layout

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

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

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

2、logger context

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

3、有效級別及級別的繼承

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

4、打印方法與基本的選擇規則

打印方法決定記錄請求的級別。例如，如果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。

1、Logback的配置文件

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

2、Logback默認配置的步驟

(1). 嘗試在classpath下查找文件logback-test.xml；

(2). 如果文件不存在，則查找文件logback.xml；

(3). 如果兩個文件都不存在，logback用Bas icConfigurator自動對自己進行配置，這會導致記錄輸出到控制台。

3、Logback.xml文件       

<?xml version="1.0" encoding="UTF-8"?>
<configuration>
    <!--定義日志文件的存儲地址 勿在 LogBack 的配置中使用相對路徑-->  
    <property name="LOG_HOME" value="c:/log" />  
    <!-- 控制台輸出 -->   
    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
       <!-- 日志輸出編碼 -->  
       <Encoding>UTF-8</Encoding>   
        <layout class="ch.qos.logback.classic.PatternLayout">   
             <!--格式化輸出：%d表示日期，%thread表示線程名，%-5level：級別從左顯示5個字符寬度%msg：日志消息，%n是換行符--> 
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n   
            </pattern>   
        </layout>   
    </appender>   
    <!-- 按照每天生成日志文件 -->   
    <appender name="FILE"  class="ch.qos.logback.core.rolling.RollingFileAppender">   
        <Encoding>UTF-8</Encoding>   
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!--日志文件輸出的文件名-->
            <FileNamePattern>${LOG_HOME}/myApp.log.%d{yyyy-MM-dd}.log</FileNamePattern>   
            <MaxHistory>30</MaxHistory>
        </rollingPolicy>   
        <layout class="ch.qos.logback.classic.PatternLayout">  
            <!--格式化輸出：%d表示日期，%thread表示線程名，%-5level：級別從左顯示5個字符寬度%msg：日志消息，%n是換行符--> 
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n   
            </pattern>   
       </layout> 
        <!--日志文件最大的大小-->
       <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" />  
    
    <!-- 日志輸出級別 -->
    <root level="INFO">   
        <appender-ref ref="STDOUT" />   
        <appender-ref ref="FILE" />   
    </root> 
     
     <!--日志異步到數據庫 -->  
    <appender name="DB" class="ch.qos.logback.classic.db.DBAppender">
        <!--日志異步到數據庫 --> 
        <connectionSource class="ch.qos.logback.core.db.DriverManagerConnectionSource">
           <!--連接池 --> 
           <dataSource class="com.mchange.v2.c3p0.ComboPooledDataSource">
              <driverClass>com.mysql.jdbc.Driver</driverClass>
              <url>jdbc:mysql://127.0.0.1:3306/databaseName</url>
              <user>root</user>
              <password>root</password>
            </dataSource>
        </connectionSource>
  </appender> -->
</configuration>

五、在程序用引用Logback

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

public class BlogAction{
     //定義一個全局的記錄器，通過LoggerFactory獲取
     private static final Logger logger = LoggerFactory.getLogger(BlogAction.class); 
     /**
     * @param args
     */
    public static void main(String[] args) {
        logger.info("logback 成功了");
        logger.error("logback 成功了");
    }
}

 

參考：

http://sunney2010.iteye.com/blog/1404723（以上內容轉自此篇文章）

http://sunney2010.iteye.com/blog/1404729（以上內容轉自此篇文章）

http://blog.csdn.net/evankaka/article/details/50637994（Spring與Spring MVC的結合）