log4j日誌配置

07-25

日誌是應用軟體中不可缺少的部分，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 代碼

package http;
import org.apache.log4j.BasicConfigurator;
import org.apache.log4j.Logger;
import org.apache.log4j.PropertyConfigurator;
import org.apache.log4j.xml.DOMConfigurator;
public class Log4jDemo {
static Logger log = Logger.getLogger(Log4jDemo.class.getClass());
/**
* main
* @param args
*/
public static void main(String[] args) {
BasicConfigurator.configure();//默認配置
PropertyConfigurator.configure("c:/log4j.properties");
//動態配置,參數可以是一個properties文件所在路徑的String對象
//可以是一個properties文件所在路徑的URL對象，也可以是一個properties對象
DOMConfigurator.configure("c:/log4j.xml");//XML配置文件
//PropertyConfigurator.configure()的參數還可以是XML、Properties對象
//下面就可使用log4j
log.info("info");
log.debug("debug");
log.error("error");
log.warn("warn");
}
}

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

java 代碼

import java.io.IOException;
import java.io.PrintWriter;
import javax.servlet.ServletException;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
public class J2eeLog4jDemo extends HttpServlet {
public void destroy() {
super.destroy();
}
public void doGet(HttpServletRequest request, HttpServletResponse response)
throws ServletException, IOException {
}
public void doPost(HttpServletRequest request, HttpServletResponse response)
throws ServletException, IOException {
}
public void init() throws ServletException {
//通過web.xml來動態取得配置文件
String prefix = getServletContext().getRealPath("/");
String file = getInitParameter("log4j");
//如果沒有給出相應的配置文件，則不進行初始化
if(file != null)
{
PropertyConfigurator.configure(prefix+file);
}
}
}

Web.xml 代碼

<servlet>
<servlet-name>j2eelog4jdemo</servlet-name>
<servlet-class>J2eeLog4jDemo</servlet-class>
<init-param>
<param-name>log4j</param-name>
<param-value>log4j.properties</param-value>
</init-param>
<load-on-startup>1</load-on-startup> //設為1時，Web容器啟動即進行載入
</servlet>

Spring配置Log4jSpring中配置Log4j只要配置applicationContext.xml文件，Log4j的配置文件放在Web工程的根目錄下，默認是objectname/root下,可以在web.xml中設置工程根目錄.設置根目錄

web.xml 代碼

<context-param>
<param-name>webAppRootKey</param-name>
<param-value>webapp.root</param-value>
</context-param>

配置applicationContext.xml

applicationContext.xml 代碼

<context-param>
<param-name>log4jConfigLocation</param-name>
<param-value>/WEB-INF/log4j.properties</param-value>
</context-param>
<context-param>
<param-name>log4jRefreshInterval</param-name>
<param-value>60000</param-value>
</context-param>
<listener>
<listener-class>org.springframework.web.util.Log4jConfigListener</listener-class>
</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中，兩者就可以很好的合作,實現如下：

package com.doctorcom.model;
import org.apache.commons.logging.Log;
public class LogFactorySupport {
public Log getLog(){
Log log = org.apache.commons.logging.LogFactory.getLog(LogFactorySupport.class);
log.info("");
log.debug("");
}
}

java 代碼

Log4j配置內容看一個簡單的java屬性配置文件log4j.properties：

properties 代碼

#指定根Logger，及日誌輸出級別，大於等於該級別的日誌將被輸出（ DEBUG < INFO < WARN < ERROR < FATAL ）設為OFF可以關閉日誌
log4j.rootLogger=DEBUG, A1,A2
#指定log輸出目的,這裡設為輸出日誌到指定目錄的文件my.log中
log4j.appender.A1=org.apache.log4j.FileAppender
log4j.appender.A1.File=\logs\my.log #當前根目錄下
#指定日誌信息的格式
log4j.appender.A1.layout=org.apache.log4j.PatternLayout
log4j.appender.A1.layout.ConversionPattern=%r %d{yyyy-MM-dd HH:mm:ss} %c %p -%m%n
#把A2輸出到控制台
log4j.appender.A2=org.apache.log4j.ConsoleAppender
log4j.appender.A2.layout=org.apache.log4j.SimpleLayout
#還可以單獨指定輸出某個包的日誌級別
#log4j.logger.com.study.HelloLog4j=INFO

1、配置根Logger，其語法為：log4j.rootLogger = [ level ] , appenderName, appenderName2level：日誌的級別，指定這條日誌信息的重要性。分為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文檔