slf4j-api、slf4j-log4j十二、log4j之間關係

1. slf4j-api

slf4j:Simple Logging Facade for Java，爲java提供的簡單日誌Facade。Facade門面，更底層一點說就是接口。它容許用戶以本身的喜愛，在工程中經過slf4j接入不一樣的日誌系統。

所以slf4j入口就是衆多接口的集合，它不負責具體的日誌實現，只在編譯時負責尋找合適的日誌系統進行綁定。具體有哪些接口，所有都定義在slf4j-api中。查看slf4j-api源碼就能夠發現，裏面除了public final class LoggerFactory類以外，都是接口定義。所以slf4j-api本質就是一個接口定義。

它只提供一個核心slf4j api(就是slf4j-api.jar包)，這個包只有日誌的接口，並無實現，因此若是要使用就得再給它提供一個實現了些接口的日誌包，比 如：log4j,common logging,jdk log日誌實現包等，可是這些日誌實現又不能經過接口直接調用，實現上他們根本就和slf4j-api不一致，所以slf4j又增長了一層來轉換各日誌實 現包的使用，好比slf4j-log4j12等。

slf4j+log4j組合使用模式：
1. slf4j-api-1.5.11.jar
2. slf4j-log4j12-1.5.11.jar
3. log4j-1.2.15.jar
4. log4j.properties(也能夠是 log4j.xml)

具體使用日誌類的API：

1. log4j：

import org.apache.log4j.Logger;

Logger logger= Logger.getLogger(xx.class);

 

2. slf4j+log4j：（推薦）

import  org.slf4j.Logger;

import  org.slf4j.LoggerFactory;

Logger logger = LoggerFactory.getLogger(xx.class);

2. slf4j-api、slf4j-log4j十二、log4j

下圖比較清晰的描述了它們之間的關係，例子爲當系統採用log4j做爲日誌框架實現的調用關係：

1. 首先系統包含slf4j-api做爲日誌接入的接口：編譯時slf4j-api中public final class LoggerFactor類中private final static void bind()方法會尋找具體的日誌實現類綁定，主要經過StaticLoggerBinder.getSingleton()的語句調用。
2. slf4j-log4j12是連接slf4j-api和log4j中間的適配器：它實現了slf4j-api中StaticLoggerBinder接口，從而使得在編譯時綁定的是slf4j-log4j12的getSingleton()方法。
3. log4j是具體的日誌系統：經過slf4j-log4j12初始化Log4j，達到最終日誌的輸出。

3. log4j 

3.1 log4j的使用

（1）使用eclipse建立maven工程，在maven中增長依賴：

// 通常建立工程，建議經過slf4j設計日誌系統，方便擴展
<dependency>
  <groupId>org.slf4j</groupId>
  <artifactId>slf4j-log4j12</artifactId>
  <version>1.7.22</version>
</dependency>

// 能夠用於學習log4j，正式項目中不推薦使用，這樣是依賴具體的log4j日誌系統。
<dependency>
  <groupId>log4j</groupId>
  <artifactId>log4j</artifactId>
  <version>1.2.17</version>
</dependency>　　

（2）src建立log4j.properties文件

log4j.properties的內容以下：

# 級別，名稱
log4j.rootLogger = debug, console

log4j.appender.console = org.apache.log4j.ConsoleAppender #日誌輸出到控制檯
log4j.appender.console.Target = System.out
log4j.appender.console.layout = org.apache.log4j.PatternLayout
log4j.appender.console.layout.ConversionPattern = [%-5p] %d{yyyy-MM-dd HH:mm:ss,SSS} method:%l%m%n # 日誌格式

org.apache.log4j.App.java

package org.apache.log4j;

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

/**
 * Hello world!
 *
 */
public class App {
    private static final Logger LOG = LoggerFactory.getLogger(App.class);
    public static void main(String[] args) {

        LOG.info("info");
        LOG.debug("debug");
        LOG.error("error");
        System.out.println("Hello World!");
    }
}　　

運行以後結果以下：

3.2 log4j配置使用

Log4j由三個重要的組件構成：日誌信息的優先級，日誌信息的輸出目的地，日誌信息的輸出格式。

日誌信息的優先級從高到低有ERROR、WARN、 INFO、DEBUG，分別用來指定這條日誌信息的重要程度；

日誌信息的輸出目的地指定了日誌將打印到控制檯仍是文件中；

而輸出格式則控制了日誌信息的顯示內容。

3.2.1 定義配置文件

能夠徹底不使用配置文件，而是在代碼中配置Log4j環境。可是使用配置文件將使您的應用程序更加靈活。Log4j支持兩種配置文件格式，一種是XML格式的文件，一種是Java特性文件（鍵=值）。

（1）配置根Logger

log4j.rootLogger = level, appenderName, appenderName, …

其中，level 是日誌記錄的優先級，分爲OFF、FATAL、ERROR、WARN、INFO、DEBUG、ALL或者您定義的級別。Log4j建議只使用四個級別，優 先級從高到低分別是ERROR、WARN、INFO、DEBUG。

每一個Logger都被了一個日誌級別（log level），用來控制日誌信息的輸出。日誌級別從高到低分爲：

• off 最高等級，用於關閉全部日誌記錄。
• fatal 指出每一個嚴重的錯誤事件將會致使應用程序的退出。
• error 指出雖然發生錯誤事件，但仍然不影響系統的繼續運行。
• warm 代表會出現潛在的錯誤情形。
• info 通常和在粗粒度級別上，強調應用程序的運行全程。
• debug 通常用於細粒度級別上，對調試應用程序很是有幫助。
• all 最低等級，用於打開全部日誌記錄。

經過在這裏定義的級別，您能夠控制到應用程序中相應級別的日誌信息的開關。好比在這裏定 義了INFO級別，則應用程序中全部DEBUG級別的日誌信息將不被打印出來。

appenderName就是指level級別的日誌信息輸出到哪一個地方，能夠同時指定多個輸出目的地。

（2）配置日誌信息輸出目的地Appender

log4j.appender.appenderName = fully.qualified.name.of.appender.class
log4j.appender.appenderName.option1 = value1
…
log4j.appender.appenderName.option = valueN

其中，Log4j提供的appender有如下幾種：

• org.apache.log4j.ConsoleAppender（控制檯）
• org.apache.log4j.FileAppender（文件）
• org.apache.log4j.DailyRollingFileAppender（天天產生一個日誌文件）
• org.apache.log4j.RollingFileAppender（文件大小到達指定尺寸的時候產生一個新的文件）
• org.apache.log4j.WriterAppender（將日誌信息以流格式發送到任意指定的地方）

（3）配置日誌信息的格式（佈局）

log4j.appender.appenderName.layout = fully.qualified.name.of.layout.class
log4j.appender.appenderName.layout.option1 = value1
…
log4j.appender.appenderName.layout.option = valueN

其中，Log4j提供的layout有如下幾種：

• org.apache.log4j.HTMLLayout（以HTML表格形式佈局）
• org.apache.log4j.PatternLayout（能夠靈活地指定佈局模式）
• org.apache.log4j.SimpleLayout（包含日誌信息的級別和信息字符串）
• org.apache.log4j.TTCCLayout（包含日誌產生的時間、線程、類別等等信息）

log4J採用相似C語言中的printf函數的打印格式格式化日誌信息，打印參數以下： %m 輸出代碼中指定的消息

%p 輸出優先級，即DEBUG，INFO，WARN，ERROR，FATAL %r 輸出自應用啓動到輸出該log信息耗費的毫秒數 %c 輸出所屬的類目，一般就是所在類的全名 %t 輸出產生該日誌事件的線程名 %n 輸出一個回車換行符，Windows平臺爲「rn」，Unix平臺爲「n」 %d 輸出日誌時間點的日期或時間，默認格式爲ISO8601，也能夠在其後指定格式，好比：%d{yyy MMM dd HH:mm:ss,SSS}，輸出相似：2002年10月18日 22：10：28，921 %l 輸出日誌事件的發生位置，包括類目名、發生的線程，以及在代碼中的行數。舉例：Testlog4.main(TestLog4.java:10)

 實例：

 

3.2.2 在代碼中使用log4j

（1）獲取Logger

使用Log4j，第一步就是獲取日誌記錄器，這個記錄器將負責控制日誌信息。其語法爲：

public static Logger getLogger( String name)

經過指定的名字得到記錄器，若是必要的話，則爲每一個類建立一個新的記錄器。Name通常取本類的名字，好比：

static Logger logger = Logger.getLogger ( ServerWithLog4j.class.getName () )

（2）讀取log4j.properties配置文件

當得到了日誌記錄器以後，第二步將配置Log4j環境，其語法爲：　

BasicConfigurator.configure()：自動快速地使用缺省Log4j環境
PropertyConfigurator.configure(String configFilename)：讀取使用property文件編寫的配置文件
DOMConfigurator.configure(String filename)：讀取XML形式的配置文件

（3）記日誌

Logger.debug(message);  
Logger.info(message);  
Logger.warn(message);  
Logger.error(message);

 

x. 參考資料

http://logging.apache.org/log4j/1.2/manual.html

http://blog.csdn.net/chen3749102/article/details/52795786

http://blog.csdn.net/tanga842428/article/details/52924725

http://blog.csdn.net/sunny_na/article/details/55212029