log4j的使用詳細(xì)解析

更新時(shí)間：2013年08月30日 10:06:53 作者：

最近在整理公司產(chǎn)品的日志輸出規(guī)范，涉及l(fā)og4j的使用介紹，就簡(jiǎn)單整理了一下。需要的朋友可以過(guò)來(lái)參考參考

1 Log4j配置說(shuō)明

1.1 配置文件
Log4j可以通過(guò)java程序動(dòng)態(tài)設(shè)置，該方式明顯缺點(diǎn)是：如果需要修改日志輸出級(jí)別等信息，則必須修改java文件，然后重新編譯，很是麻煩；

log4j也可以通過(guò)配置文件的方式進(jìn)行設(shè)置，目前支持兩種格式的配置文件：

•xml文件
•properties文件（推薦）
下面是一個(gè)log4j配置文件的完整內(nèi)容：

log4j.rootCategory=INFO, stdout
log4j.rootLogger=info, stdout

### stdout ###
log4j.appender.stdout=org.apache.log4j.ConsoleAppender
log4j.appender.stdout.Target=System.out
log4j.appender.stdout.layout=org.apache.log4j.PatternLayout
log4j.appender.stdout.layout.ConversionPattern=%d{ABSOLUTE} %5p - %m%n

### set package ###
log4j.logger.org.springframework=info
log4j.logger.org.apache.catalina=info
log4j.logger.org.apache.commons.digester.Digester=info
log4j.logger.org.apache.catalina.startup.TldConfig=info
log4j.logger.chb.test=debug

1.2 配置根Logger
根logger主要定義log4j支持的日志級(jí)別及輸出目的地，其語(yǔ)法為：
log4j.rootLogger = [ level ] , appenderName, appenderName, …
其中，level 是日志記錄的優(yōu)先級(jí)，分為OFF、FATAL、ERROR、WARN、INFO、DEBUG、ALL或者自定義的級(jí)別。

建議只使用四個(gè)級(jí)別，優(yōu)先級(jí)從高到低分別是ERROR、WARN、INFO、DEBUG。
appenderName指定日志信息輸出到哪個(gè)地方，可同時(shí)指定多個(gè)輸出目的地。

1.3 配置輸出目的地Appender
Appender主要定義日志信息輸出在什么位置，主要語(yǔ)法為：

復(fù)制代碼代碼如下:

log4j.appender.appenderName = classInfo
log4j.appender.appenderName.option1 = value1
　　…
log4j.appender.appenderName.optionN = valueN

Log4j提供的appender有以下幾種：

•org.apache.log4j.ConsoleAppender（控制臺(tái)），
•org.apache.log4j.FileAppender（文件），
•org.apache.log4j.DailyRollingFileAppender（每天產(chǎn)生一個(gè)日志文件），
•org.apache.log4j.RollingFileAppender（文件大小到達(dá)指定尺寸的時(shí)候產(chǎn)生一個(gè)新的文件）
•org.apache.log4j.WriterAppender（將日志信息以流格式發(fā)送到任意指定的地方）
以ConsoleAppender為例，如：

復(fù)制代碼代碼如下:

log4j.appender.stdout=org.apache.log4j.ConsoleAppender
log4j.appender.stdout.Target=System.out

1.4 配置日志信息的格式Layout
Layout 負(fù)責(zé)格式化Appender的輸出，其語(yǔ)法為：

復(fù)制代碼代碼如下:

log4j.appender.appenderName.layout = classInfo
log4j.appender.appenderName.layout.option1 = value1
…
log4j.appender.appenderName.layout.optionN = valueN

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

•org.apache.log4j.HTMLLayout（以HTML表格形式布局），
•org.apache.log4j.PatternLayout（可以靈活地指定布局模式），
•org.apache.log4j.SimpleLayout（包含日志信息的級(jí)別和信息字符串）
•org.apache.log4j.TTCCLayout（包含日志產(chǎn)生的時(shí)間、線程、類別等等信息）

1.5 設(shè)置package輸出級(jí)別
可以設(shè)置不同package的日志輸出級(jí)別，語(yǔ)法為：
log4j.logger.packageName=level
其中，packageName為實(shí)際的包名，level為日志級(jí)別，例如：

復(fù)制代碼代碼如下:

log4j.logger.org.springframework=info
log4j.logger.org.apache.catalina=info
log4j.logger.org.apache.commons.digester.Digester=info
log4j.logger.org.apache.catalina.startup.TldConfig=info
log4j.logger.chb.test=debug

2 Log4j與J2ee結(jié)合

2.1 使用spring架構(gòu)
Spring真是不錯(cuò)，替我們做了很多事情，如果系統(tǒng)使用了spring框架，則要集成log4j就很簡(jiǎn)單了，主要分為3個(gè)步驟，如下：

2.1.1 定義log4j配置文件

復(fù)制代碼代碼如下:

log4j.rootCategory=INFO, stdout
log4j.rootLogger=info, stdout

### stdout ###
log4j.appender.stdout=org.apache.log4j.ConsoleAppender
log4j.appender.stdout.Target=System.out
log4j.appender.stdout.layout=org.apache.log4j.PatternLayout
log4j.appender.stdout.layout.ConversionPattern=%d{ABSOLUTE} %5p - %m%n

### log to file ###
log4j.logger.org.springframework=info
log4j.logger.org.apache.catalina=info
log4j.logger.org.apache.commons.digester.Digester=info
log4j.logger.org.apache.catalina.startup.TldConfig=info
log4j.logger.chb.test=debug

2.1.2 定義監(jiān)聽器
監(jiān)聽器需要定義在web.xml，主要包括：定義log4j配置文件目錄、log4j監(jiān)聽器，如下：

復(fù)制代碼代碼如下:

<?xml version="1.0" encoding="UTF-8"?>
<web-app version="2.4"
    xmlns="http://java.sun.com/xml/ns/j2ee"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://java.sun.com/xml/ns/j2ee
    http://java.sun.com/xml/ns/j2ee/web-app_2_4.xsd">

    <!--由Spring載入的Log4j配置文件位置-->
    <context-param>
       <param-name>log4jConfigLocation</param-name>
       <param-value>/WEB-INF/log4j.properties</param-value>
    </context-param>

    <context-param>
       <param-name>contextConfigLocation</param-name>
       <param-value>
           /WEB-INF/classes/applicationContext*.xml
       </param-value>
    </context-param>

    <!--Spring log4j Config loader-->
    <listener>
       <listener-class>
           org.springframework.web.util.Log4jConfigListener
       </listener-class>
    </listener>

    <listener>
       <listener-class>
           org.springframework.web.context.ContextLoaderListener
       </listener-class>
    </listener>

    <servlet>
       <servlet-name>InitiaServlet</servlet-name>
    <servlet-class>chb.test.web.InitiaServlet</servlet-class>
       <load-on-startup>1</load-on-startup>
    </servlet>

  <welcome-file-list>
    <welcome-file>index.jsp</welcome-file>
  </welcome-file-list>
</web-app>

2.1.3 測(cè)試類

復(fù)制代碼代碼如下:

package com.dheaven.mip.web;

import javax.servlet.ServletException;
import javax.servlet.http.HttpServlet;

import org.apache.log4j.Logger;

public class InitiaServlet extends HttpServlet {

    protected Logger log = Logger.getLogger(InitiaServlet.class);

    private static final long serialVersionUID = 8550329576989690578L;

    /**
     * Constructor of the object.
     */
    public InitiaServlet() {
       super();
    }

    /**
     * Destruction of the servlet. <br>
     */
    public void destroy() {
       super.destroy();
    }

    /**
     * Initialization of the servlet. <br>
     *
     * @throws ServletException if an error occure
     */
    public void init() throws ServletException {
       log.debug("服務(wù)器啟動(dòng)了，log4j開始工作了");
    }
}

2.2不使用spring架構(gòu)
如果系統(tǒng)沒有使用spring，我們以servlet為例，很簡(jiǎn)單，大家按照步驟執(zhí)行即可，只貼代碼，不說(shuō)廢話。

2.2.1 定義log4j配置文件
放在web工程的WEB-INF目錄下，內(nèi)容如：

復(fù)制代碼代碼如下:

log4j.rootCategory=INFO, stdout
log4j.rootLogger=info, stdout

### stdout ###
log4j.appender.stdout=org.apache.log4j.ConsoleAppender
log4j.appender.stdout.Target=System.out
log4j.appender.stdout.layout=org.apache.log4j.PatternLayout
log4j.appender.stdout.layout.ConversionPattern=%d{ABSOLUTE} %5p - %m%n

### set package ###
log4j.logger.org.apache.catalina=info
log4j.logger.org.apache.commons.digester.Digester=info
log4j.logger.org.apache.catalina.startup.TldConfig=info
log4j.logger.com.dheaven=debug

2.2.2 創(chuàng)建log4j初始化類

復(fù)制代碼代碼如下:

package com.dheaven.mip.web;

import javax.servlet.ServletException;
import javax.servlet.http.HttpServlet;

import org.apache.log4j.PropertyConfigurator;

public class InitLog4j extends HttpServlet {

    private static final long serialVersionUID = 1L;

    public void init() throws ServletException {
       String prefix = getServletContext().getRealPath("/");
       prefix = prefix.replace("http://", "/");
       String file = getInitParameter("log4j-init-file");
       // if the log4j-init-file is not set, then no point in trying
       if (file != null) {
           PropertyConfigurator.configure(prefix + file);
       }
    }
}

2.2.3 在Web.xml中定義初始化類

復(fù)制代碼代碼如下:

    <servlet>
       <servlet-name>log4j-init</servlet-name>
       <servlet-class>chb.test.web.InitLog4j</servlet-class>

       <init-param>
           <param-name>log4j-init-file</param-name>
           <param-value>WEB-INF/log4j.properties</param-value>
       </init-param>

       <load-on-startup>1</load-on-startup>
    </servlet>

2.2.4 測(cè)試類

復(fù)制代碼代碼如下:

package chb.test.web;

 
import javax.servlet.ServletException;
import javax.servlet.http.HttpServlet;

import org.apache.log4j.Logger;

public class InitiaServlet extends HttpServlet {

    protected Logger log = Logger.getLogger(InitiaServlet.class);

    private static final long serialVersionUID = 8550329576989690578L;

    /**
     * Constructor of the object.
     */
    public InitiaServlet() {
       super();
    }

    /**
     * Destruction of the servlet. <br>
     */
    public void destroy() {
       super.destroy();
    }

    /**
     * Initialization of the servlet. <br>
     *
     * @throws ServletException if an error occure
     */
    public void init() throws ServletException {
       log.debug("服務(wù)器啟動(dòng)了，log4j開始工作了");
    }
}