1. 程式人生 > >log4j輸出日誌基本配置

log4j輸出日誌基本配置

日誌是應用軟體中不可缺少的部分,Apache的開源專案Log4j是一個功能強大的日誌元件,提供方便的日誌記錄。以下是個人經驗,具體請參考Log4j文件指南。

Log4j下載
在apache網站:jakarta.apache.org/log4j 可以免費下載到Log4j最新版本的軟體包。

Log4j使用
Log4j的包下載完成後,解壓,將其中打包好的的log4j-1.x.x.jar匯入你的工程LIB中。
Log4j之所以受歡迎的原因之一是它的靈活性。Log4j提供了靈活的配置方法,預設是呼叫BasicConfigurator.configure()來進行配置,但如果只是簡單的呼叫BasicConfigurator.configure()來進行配置工作,那麼所有的配置都是固定的,不方便以後修改配置。另一種是動態配置,Log4j提供了PropertyConfigurator.configure(……)來動態配置,引數可以是一個properties檔案所在路徑的String物件,可以是一個properties檔案所在路徑的URL物件,也可以是一個properties物件。如果要用XML檔案來配置資訊,則可用型別的DOMConfigurator()函式來從一個XML檔案中載入配置資訊。這種方式更方便修改配置。

動態配置

 

java 程式碼

  1. package http;   
  2.   
  3. import org.apache.log4j.BasicConfigurator;   
  4. import org.apache.log4j.Logger;   
  5. import org.apache.log4j.PropertyConfigurator;   
  6. import org.apache.log4j.xml.DOMConfigurator;   
  7.   
  8. public class Log4jDemo {   
  9.     static Logger log = Logger.getLogger(Log4jDemo.class.getClass());   
  10.     /**  
  11.      * main  
  12.      * @param args 
     
  13.      */  
  14.     public static void main(String[] args) {   
  15.         BasicConfigurator.configure();//預設配置   
  16.         PropertyConfigurator.configure("c:/log4j.properties");   
  17.         //動態配置,引數可以是一個properties檔案所在路徑的String物件   
  18.         //可以是一個properties檔案所在路徑的URL物件,也可以是一個properties物件   
  19.            
  20.         DOMConfigurator.configure("c:/log4j.xml");//XML配置檔案   
  21.   
  22.         //PropertyConfigurator.configure()的引數還可以是XML、Properties物件   
  23.            
  24.         //下面就可使用log4j   
  25.         log.info("info");   
  26.         log.debug("debug");   
  27.         log.error("error");   
  28.         log.warn("warn");   
  29.     }   
  30.   
  31. }   


J2EE應用log4j
上面程式碼描述了Log4j的簡單應用,其實使用Log4j也就是這樣簡單方便。當然除了上面的配置方法,還有其它,比如做一個J2EE應用,在J2EE應用使用Log4j,必須先在啟動服務時載入Log4j的配置檔案進行初始化,可以在web.xml中進行。

java 程式碼

  1. import java.io.IOException;   
  2. import java.io.PrintWriter;   
  3.   
  4. import javax.servlet.ServletException;   
  5. import javax.servlet.http.HttpServlet;   
  6. import javax.servlet.http.HttpServletRequest;   
  7. import javax.servlet.http.HttpServletResponse;   
  8.   
  9.   
  10.   
  11. public class J2eeLog4jDemo extends HttpServlet {   
  12.   
  13.     public void destroy() {   
  14.         super.destroy();    
  15.     }      
  16.     public void doGet(HttpServletRequest request, HttpServletResponse response)   
  17.             throws ServletException, IOException {   
  18.     }   
  19.     public void doPost(HttpServletRequest request, HttpServletResponse response)   
  20.             throws ServletException, IOException {         
  21.     }   
  22.     public void init() throws ServletException {   
  23.         //通過web.xml來動態取得配置檔案   
  24.         String prefix = getServletContext().getRealPath("/");   
  25.         String file = getInitParameter("log4j");   
  26.   
  27.         //如果沒有給出相應的配置檔案,則不進行初始化   
  28.         if(file != null)    
  29.         {   
  30.             PropertyConfigurator.configure(prefix+file);   
  31.         }   
  32.     }   
  33.   
  34. }   

 

Web.xml 程式碼

  1. <servlet>  
  2. <servlet-name>j2eelog4jdemoservlet-name>  
  3. <servlet-class>J2eeLog4jDemoservlet-class>  
  4. <init-param>  
  5. <param-name>log4jparam-name>  
  6. <param-value>log4j.propertiesparam-value>  
  7. init-param>  
  8. <load-on-startup>1load-on-startup>  //設為1時,Web容器啟動即進行載入
  9. servlet>  


Spring配置Log4j
Spring中配置Log4j只要配置applicationContext.xml檔案,Log4j的配置檔案放在Web工程的根目錄下,預設是objectname/root下,可以在web.xml中設定工程根目錄.

設定根目錄

web.xml 程式碼

  1. <!---->  
  2.  <context-param>  
  3.   <param-name>webAppRootKeyparam-name>  
  4.   <param-value>webapp.rootparam-value>  
  5.  context-param>  

配置applicationContext.xml

applicationContext.xml 程式碼

  1. <!---->  
  2. <context-param>  
  3.  <param-name>log4jConfigLocationparam-name>  
  4.  <param-value>/WEB-INF/log4j.propertiesparam-value>  
  5.  <!---->  
  6. context-param>  
  7.   
  8.   
  9.   
  10. <!---->  
  11. <context-param>  
  12.  <param-name>log4jRefreshIntervalparam-name>  
  13.  <param-value>60000param-value>  
  14. context-param>  
  15.   
  16. <!---->  
  17. <listener>  
  18.  <listener-class>org.springframework.web.util.Log4jConfigListenerlistener-class>  
  19. listener>  


同時使用commons-logging和Log4j

1)首先在classpath下尋找自己的配置檔案commons-logging.properties,如果找到,則使用其中定義的Log實現類
2)如果找不到commons-logging.properties檔案,則在查詢是否已定義系統環境變數org.apache.commons.logging.Log,找到則使用其定義的Log實現類
3)否則,檢視classpath中是否有Log4j的包,如果發現,則自動使用Log4j作為日誌實現類
4)否則,使用JDK自身的日誌實現類(JDK1.4以後才有日誌實現類)
5)否則,使用commons-logging自己提供的一個簡單的日誌實現類SimpleLog

將commons-logging和Log4j的jar包都放置到classpath下,同時也將Log4j的配置檔案放到classpath中,兩者就可以很好的合作,實現如下:

  1. package com.doctorcom.model;   
  2.   
  3. import org.apache.commons.logging.Log;   
  4.   
  5. public class LogFactorySupport {       
  6.       
  7.     public Log getLog(){   
  8.         Log log = org.apache.commons.logging.LogFactory.getLog(LogFactorySupport.class);   
  9.         log.info("");   
  10.         log.debug("");   
  11.     }   
  12.        
  13. }  

java 程式碼


Log4j配置內容
看一個簡單的java屬性配置檔案log4j.properties: 

properties 程式碼

 

  1. #指定根Logger,及日誌輸出級別,大於等於該級別的日誌將被輸出( DEBUG < INFO < WARN < ERROR < FATAL ) 設為OFF可以關閉日誌   
  2. log4j.rootLogger=DEBUG, A1,A2   
  3. #指定log輸出目的,這裡設為輸出日誌到指定目錄的檔案my.log中   
  4. log4j.appender.A1=org.apache.log4j.FileAppender   
  5. log4j.appender.A1.File=\\logs\\my.log   #當前根目錄下
  6. #指定日誌資訊的格式   
  7. log4j.appender.A1.layout=org.apache.log4j.PatternLayout    
  8. log4j.appender.A1.layout.ConversionPattern=%r %d{yyyy-MM-dd HH:mm:ss} %c %p -%m%n   
  9.   
  10. #把A2輸出到控制檯   
  11. log4j.appender.A2=org.apache.log4j.ConsoleAppender   
  12. log4j.appender.A2.layout=org.apache.log4j.SimpleLayout    
  13.   
  14. #還可以單獨指定輸出某個包的日誌級別   
  15. #log4j.logger.com.study.HelloLog4j=INFO  
  16.   

 

1、配置根Logger,其語法為:
log4j.rootLogger = [ level ] , appenderName, appenderName2
level:日誌的級別,指定這條日誌資訊的重要性。分為ALL < DEBUG < INFO < WARN <error fatal=""></error>一般常用的為 DEBUG , INFO ,WARN ,ERROR四種,分別對應Logger類的四種方法
 debug(Object message ) ;
 info(Object message ) ;
 warn(Object message ) ;
 error(Object message ) ;
如果設定級別為INFO,則優先順序大於等於INFO級別(如:INFO、WARN、ERROR)的日誌資訊將可以被輸出,小於該級別的如:DEBUG將不會被輸出
appenderName :就是指定日誌資訊輸出目的地,比如(列印到控制檯,輸出到檔案等)。同一條日誌資訊可以配置多個輸出目的地。

2、配置log輸出目的地
 Log4j提供以下幾種:
 org.apache.log4j.ConsoleAppender(控制檯)
 org.apache.log4j.FileAppender(檔案)
 org.apache.log4j.DailyRollingFileAppender(每天產生一個日誌檔案)
 org.apache.log4j.RollingFileAppender(檔案大小到達指定尺寸的時候產生一個新的檔案)
 org.apache.log4j.WriterAppender(將日誌資訊以流格式傳送到任意指定的地方)
3、log資訊的格式
 org.apache.log4j.HTMLLayout(HTML表格形式)
 org.apache.log4j.SimpleLayout(簡單格式的日誌,只包括日誌資訊的級別和指定的資訊字串 ,如:DEBUG - Hello)
 org.apache.log4j.TTCCLayout(日誌的格式包括日誌產生的時間、執行緒、類別等等資訊)
 org.apache.log4j.PatternLayout(靈活地自定義日誌格式)

當使用org.apache.log4j.PatternLayout來自定義資訊格式時,可以使用
log4j.appender.A1.layout.ConversionPattern=%d{yyyy-MM-dd HH:mm:ss} %p -%m%n 來格式化資訊
%c    輸出所屬類的全名,可寫為 %c{Num} ,Num類名輸出的範圍  如:"com.sun.aaa.classB", %C{2}將使日誌輸出輸出範圍為:aaa.classB
%d    輸出日誌時間其格式為 可指定格式 如 %d{HH:mm:ss}等
%l    輸出日誌事件發生位置,包括類目名、發生執行緒,在程式碼中的行數
%n    換行符
%m    輸出程式碼指定資訊,如info(“message”),輸出message
%p    輸出日誌的優先順序,即 FATAL ,ERROR 等
%r    輸出從啟動到顯示該條日誌資訊所耗費的時間(毫秒數)
%t    輸出產生該日誌事件的執行緒名


更詳細引數資訊可參看類org.apache.log4j.PatternLayout的API doc文件