log4j的使用详细解析

1 log4j配置说明

1.1 配置文件
log4j可以通过java程序动态设置，该方式明显缺点是：如果需要修改日志输出级别等信息，则必须修改java文件，然后重新编译，很是麻烦；

log4j也可以通过配置文件的方式进行设置，目前支持两种格式的配置文件：

•xml文件
•properties文件（推荐）
下面是一个log4j配置文件的完整内容：

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支持的日志级别及输出目的地，其语法为：
log4j.rootlogger = [ level ] , appendername, appendername, …
其中，level 是日志记录的优先级，分为off、fatal、error、warn、info、debug、all或者自定义的级别。

建议只使用四个级别，优先级从高到低分别是error、warn、info、debug。
appendername指定日志信息输出到哪个地方，可同时指定多个输出目的地。

1.3 配置输出目的地appender
appender主要定义日志信息输出在什么位置，主要语法为：

log4j.appender.appendername = classinfo
log4j.appender.appendername.option1 = value1
　　…
log4j.appender.appendername.optionn = valuen

log4j提供的appender有以下几种：

•org.apache.log4j.consoleappender（控制台），
•org.apache.log4j.fileappender（文件），
•org.apache.log4j.dailyrollingfileappender（每天产生一个日志文件），
•org.apache.log4j.rollingfileappender（文件大小到达指定尺寸的时候产生一个新的文件）
•org.apache.log4j.writerappender（将日志信息以流格式发送到任意指定的地方）
以consoleappender为例，如：

log4j.appender.stdout=org.apache.log4j.consoleappender
log4j.appender.stdout.target=system.out

1.4 配置日志信息的格式layout
layout 负责格式化appender的输出，其语法为：

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（包含日志信息的级别和信息字符串）
•org.apache.log4j.ttcclayout（包含日志产生的时间、线程、类别等等信息）

1.5 设置package输出级别
可以设置不同package的日志输出级别，语法为：
log4j.logger.packagename=level
其中，packagename为实际的包名，level为日志级别，例如：

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结合

2.1 使用spring架构
spring真是不错，替我们做了很多事情，如果系统使用了spring框架，则要集成log4j就很简单了，主要分为3个步骤，如下：

2.1.1 定义log4j配置文件

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  定义监听器
监听器需要定义在web.xml，主要包括：定义log4j配置文件目录、log4j监听器，如下：

<?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  测试类

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("服务器启动了，log4j开始工作了");
    }
}

2.2不使用spring架构
如果系统没有使用spring，我们以servlet为例，很简单，大家按照步骤执行即可，只贴代码，不说废话。

2.2.1 定义log4j配置文件
放在web工程的web-inf目录下，内容如：

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  创建log4j初始化类

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("//", "/");
       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中定义初始化类

    <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 测试类

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("服务器启动了，log4j开始工作了");
    }
}