SLF4J日誌的使用

will的猜想發表於2017-10-17
SLF4J(Simple Logging Facade for Java) 是一個通用的日誌框架，不能何以謂之 Facade(門面)，所扮眼的角色相當於 Jakarta Commons Logging。就像 JCL 需要底層的日誌實現，如 Log4J、java.util.logging、Simple Logger 等來完成具體的資訊輸出，事實上基本總是 JCL+Log4J 那麼一個絕配。SLF4J 的原旨也是能支援多種下層日誌框架實現，但最好的日誌實現仍然是 Log4J，所以本篇講述 SLF4J 的第一種用法 SLF4J+Log4J。

 

 需要的配置檔案和元件包，下面三個 jar 檔案和一個 properties 檔案都是要放在專案的 ClassPath 上。 

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，本例中用 log4j.propertes)

 

log4j.properties

[java] view plain copy
  1. log4j.appender.stdout=org.apache.log4j.ConsoleAppender    
  2. log4j.appender.stdout.Target=System.out    
  3. log4j.appender.stdout.layout=org.apache.log4j.PatternLayout    
  4. log4j.appender.stdout.layout.ConversionPattern=%d{ABSOLUTE} %5p %c{1}:%L - %m%n    
  5. log4j.appender.db=org.apache.log4j.FileAppender    
  6. log4j.appender.db.File=${s2sh.root}/WEB-INF/logs/ssh.log    
  7. log4j.appender.db.Append=true    
  8. log4j.appender.db.layout=org.apache.log4j.PatternLayout    
  9. log4j.appender.db.layout.ConversionPattern=%d{yyyy-MM-dd HH:mm:ss} [%-5p][%c{1}] - %m%n  

 

使用 SLF4J  的程式碼：

 

[java] view plain copy
  1. import org.slf4j.Logger;   
  2. import org.slf4j.LoggerFactory;   
  3.    
  4. public class TestSlf4J {   
  5.     private static final Logger logger = LoggerFactory.getLogger(TestSlf4j.class);   
  6.     public static void main(String[] args) {   
  7.         logger.info("Hello {}","SLF4J");   
  8.     }   
  9. }   

執行它，控制檯輸出： 

[java] view plain copy
  1. 2010-04-07 17:14:51,390 [com.unmi.TestSlf4j]-[INFO] Hello SLF4J  

 

把這種 SLF4J+Log4J 的使用模式與曾為霸主地位的 JCL+Log4J 的用法進行一下對比(請忽略掉包檔案中的版本號)： 

 

把這種 SLF4J+Log4J 的使用模式與曾為霸主地位的 JCL+Log4J 的用法進行一下對比(請忽略掉包檔案中的版本號)： 

SLF4J+Log4j 組合 對比 JCL+Log4J 組合 
slf4j-api-1.5.11.jar 相當，定義高層 API commons-logging-1.1.jar 
slf4j-log4j12-1.5.11.jar 相當，左邊是用繫結包，右邊 
是用配置檔案來指定日誌實現 commons-logging.properties，內容為： 
org.apache.commons.logging.LogFactory= 
org.apache.commons.logging.impl.LogFactoryImpl 
或者 
org.apache.commons.logging.Log= 
org.apache.commons.logging.impl.Log4JLogger 
log4j-1.2.15.jar 一樣 log4j-1.2.15.jar 
log4j.properties 一樣，原來怎麼配置現在也是 log4j.properties 
程式程式碼中： 
import org.slf4j.Logger; 
import org.slf4j.LoggerFactory; 

Logger logger = LoggerFactory.getLogger(TestSlf4j.class); 
logger.info("Hello {}","SLF4J"); 左邊侵入的是 SLF4J API，右邊是被 JCL 的 API 汙染了 

SLF4J 支援引數化，而 JCL 不能 程式程式碼中： 
import org.apache.commons.logging.Log; 
import org.apache.commons.logging.LogFactory; 

Log log = LogFactory.getLog(TestJCL.class); 

log.info("Hello JCL"); 

從上面的對比來看，SLF4j+Log4j 與 JCL+Log4J 的使用方式差不多，主要差異就在 SLF4J 用 jar 來告知用哪種日誌實現，而 JCL 是通過配置檔案來獲得該選擇哪個日誌實現。

 

為什麼會興起 SLF4J，看看我們原來哪一個框架中，大的如 SSH 三雄(Spring、Struts、Hibernate)，還有 WAS 應用伺服器，小的就不計其數以前用的通用日誌框架都清一色的 Jakarta Commons Logging(JCL)，日誌實現會選用 Log4j，為何現在 Hibernate、Tapesty、DbUnit、Jetty V6 等紛紛變節，都採用了 SLF4J 了呢？SLF4J 與 JCL 相比，定然是有其可表之處。而其中 SLF4J 受類載入器的影響較小，不易產生記憶體溢位的問題，效能得到了改善，更主要是順應了潮流的發展--可方便部署到 OSGI 環境中.

 

SLF4J+LogBack

 

前面講的 SLF4J 的用法之一是 SLF4J+Log4J，而這裡要推出的組合是 SLF4J+LogBack。不用 Log4J？難道還有比 Log4J 更好的日誌實現嗎？是的，答案就是 LogBack。假如你知道 LogBack 和 Log4J 是同出一位大師之手，你就不會覺得驚訝了。LogBack 對 Log4J 進行了增強，並投入了 SLF4J 的懷抱，它還被作者認定為 Log4J 的繼任者。 

 

Logback 分為三個模組：logback-core，logback-classic，logback-access。logback-core 是核心；logback-classic 改善了 log4j，且自身實現了 SLF4J API，所以即使用 Logback 你仍然可以使用其他的日誌實現，如原始的 Log4J，java.util.logging 等；logback-access 讓你方便的訪問日誌資訊，如通過 http 的方式。 

還得提一點，Logback 能更好的放到 OSGI 環境中。好了，簡單紹完了 Logback，就來看看具體怎麼用它。 

需要的配置檔案和元件包，下面三個 jar 檔案和一個 xml檔案都是要放在專案的 ClassPath 上。 

 

slf4j-api-1.5.11.jar 
logback-core-0.9.20.jar 
logback-classic-0.9.20.jar 
logback.xml 或 logback-test.xml (類似於 log4j.properties/log4j.xml) 

 

Logback 先找 logback-test.xml，沒有則找 logback.xml 檔案，都找不到就使用 BasicConfigurator 基本配置，BasicConfigurator 就是相當於等會貼出的 logback.xml 檔案內容的配置。這裡我們用 logback.xml 配置檔案，以前的 log4j.properties  檔案可以用 PropertiesTranslator 轉換成 logback.xml 檔案內容。 

 

下面是一個最簡單的 logback.xml 檔案內容

 

[xhtml] view plain copy
  1. <?xml version="1.0" encoding="UTF-8"?>   
  2.   <configuration>   
  3.     <appender name="stdout" class="ch.qos.logback.core.ConsoleAppender">            
  4.          <encoder charset="GBK">   
  5.             <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>   
  6.          </encoder>   
  7.      </appender>       
  8.      <root level="DEBUG">   
  9.        <appender-ref ref="stdout" />   
  10.      </root>   
  11.   </configuration>   

 

在 log4j.xml 能做的配置，logback.xml 中也能做到，而且還增強了諸如 <if><then><else>、<filter>、<sift> 等更強的控制，請參考 logback 的手冊 http://logback.qos.ch/manual/index.html。 

 

使用 Logback  的程式碼 

[xhtml] view plain copy
  1. package com.unmi;   
  2.    
  3. import org.slf4j.Logger;   
  4. import org.slf4j.LoggerFactory;   
  5.    
  6. public class TestLogback {   
  7.     private static final Logger logger = LoggerFactory.getLogger(TestLogback.class);   
  8.    
  9.    public static void main(String[] args) {   
  10.         logger.info("Hello {}","TestLogback");   
  11.     }   
  12. }   

可以看到與使用 SLF4J 的程式碼沒有任何區別，因為本來用的通用日誌框架就是 SLF4J，說到底，這裡的 Logback 就相當於 SLF4J+Log4J 使用方式中的 Log4J 繫結和 Log4J 的功能。

執行上面的程式碼，輸出： 

21:38:43.031 [main] INFO  com.unmi.TestLogback - Hello TestLogback 

還是和上次一樣，這裡就拿 SLF4J+Logback 和 SLF4J+Log4J 兩種方式作下比較:

相關文章