Log4J在javaWeb应用程序中的使用

     日志处理是每一个项目开发中必须的，很多公司自己独立自主开发自己的日志组件，除了自己从头到尾开发一个可重用的日志操作类外，Apache为我们提供了一个强有力的日志操作包-Log4j。

    Log4j是Apache的一个开放源代码项目，通过使用Log4j，我们可以控制日志信息输送的目的地是控制台、文件、GUI组件、甚至是套接口服务器、NT的事件记录器、UNIX Syslog守护进程等；我们也可以控制每一条日志的输出格式；通过定义每一条日志信息的级别（fatal，error，"warn，info，debug），我们能够更加细致地控制日志的生成过程。最令人感兴趣的就是，这些可以通过一个配置文件来灵活地进行配置，而不需要修改应用的代码。

    此外，通过Log4j其他语言接口，您可以在C、C++、.Net、PL/SQL程序中使用Log4j，其语法和用法与在Java程序中一样，使得多语言分布式系统得到一个统一一致的日志组件模块。而且，通过使用各种第三方扩展，您可以很方便地将Log4j集成到J2EE、JINI甚至是SNMP（这个倒是用过）应用中。

    说明：下面分为三部分，第一部分讲解如何配置log4j，第二部分为对log4j.properties配置文件中的各个属性的讲解，第三部分为对log4j的详细讲解，如果只想配置上log4j，那么只需要看前两个部分就可以，如果想对log4j深入了解，则还需看第三部分。

一、Log4j配置

第一步：到 jakarta下载一个log4j的组件,加入log4j-1.*.jar到lib下。可以是Tomcat的common\lib目录下，也可以是你需要用到log4j的application下的lib 目录(如：/WEB-INF/lib)

第二步：在CLASSPATH下建立log4j.properties。内容如下：

 

#All level less than INFO will be logged
log4j.rootLogger=INFO, A1

#A1 is the output device
log4j.appender.A1=org.apache.log4j.FileAppender
log4j.appender.A1.File=c:/log4j.htm

#use html layout
log4j.appender.A1.layout=org.apache.log4j.HTMLLayout

 

到这里我们需要讨论一些tomcat的启动过程：

 

你可能已经注意到，在Tomcat的已经有一个commons-logging-api.jar文件了。这个jar文件是commons-logging.jar的简版，只实现了SimpleLog及类似的其它部分，只能基本满足系统启动时的日志输出，因为没有日志系统的API，Tomcat是不能启动的。如果在启动classpath中没有加入日志系统（如log4j），是不可以用commons-loging.jar来进行替换这个文件的。 在启动过程中的一些类载入时，如果你在common/lib目录中加入了完整版的commons-logging.jar，它会替换commons-logging-api.jar的类，会重新初始化日志系统，并尝试定位log4j或其它你使用的日志系统。

     其实只要我们的配置文件log4j.properties放在classespath中，同时我们的系统中加载了log4j1.*.*.jar，系统会自动启动log4j放入日志的。但是为了保险期间，我们可以自己加载Log4J
　　在Application目录下的web.xml文件加入以后代码
　　<servlet>
　　<servlet-name>log4j</servlet-name>
　　<servlet-class>com.apache.jakarta.log4j.Log4jInit</servlet-class>
　　<init-param>
　　<param-name>log4j</param-name>
　　<param-value>/WEB-INF/log4j.properties</param-value>
　　</init-param>
　　<load-on-startup>1</load-on-startup>
　　</servlet>
　　这段代码的意思是说，在web应用程序启动时加载com.apache.jakarta.log4j.Log4jInit这个名叫Log4jInit.class这个类文件。其中Log4jInit.class的源代码大致如下：　　
　　package com.xaccp.log4j;
　　import org.apache.log4j.PropertyConfigurator;
　　import javax.servlet.http.HttpServlet;
　　import javax.servlet.http.HttpServletRequest;
　　import javax.servlet.http.HttpServletResponse;
　　public class Log4jInit extends HttpServlet {
　　
　　public void init() {
　　String prefix =　getServletContext().getRealPath("/");
　　String file = getInitParameter("log4j");
　　if(file != null) {
　　    PropertyConfigurator.configure(prefix+file);
　　}
　　}
　　}
　　这段代码很简单，可以看出，在加载的过程中，程序会读取/WEB-INF/log4j.properties这个文件
　　这个文件就是本文的重点，也就是log4j的配置文件。
　　
　　# Set root logger level to DEBUG and its only appender to A1
　　#log4j中有五级（level）logger
　　#FATAL 0
　　#ERROR 3
　　#WARN 4
　　#INFO 6
　　#DEBUG 7
　　#配置根Logger，其语法为：
　　#log4j.rootLogger = [ level ] , appenderName, appenderName, …
　　log4j.rootLogger=INFO, A1 ,R
　　#这一句设置以为着所有的log都输出
　　#如果为log4j.rootLogger=WARN, 则意味着只有WARN,ERROR,FATAL
　　#被输出，DEBUG,INFO将被屏蔽掉.
　　# A1 is set to be a ConsoleAppender.
　　#log4j中Appender有几层如控制台、文件、GUI组件、甚至是套接口服务器、NT的事件记录器、UNIX Syslog守护进程等
　　#ConsoleAppender输出到控制台
　　log4j.appender.A1=org.apache.log4j.ConsoleAppender
　　# A1 使用的输出布局，其中log4j提供4种布局.      

    #org.apache.log4j.HTMLLayout（以HTML表格形式布局）
　　#org.apache.log4j.PatternLayout（可以灵活地指定布局模式），
　　#org.apache.log4j.SimpleLayout（包含日志信息的级别和信息字符串），
　　#org.apache.log4j.TTCCLayout（包含日志产生的时间、线程、类别等等信息）
　　
　　log4j.appender.A1.layout=org.apache.log4j.PatternLayout
　　#灵活定义输出格式 具体查看log4j javadoc org.apache.log4j.PatternLayout
　　#d 时间 ....
　　log4j.appender.A1.layout.ConversionPattern=%-d{yyyy-MM-dd HH:mm:ss} [%c]-[%p] %m%n
　　#R 输出到文件 RollingFileAppender的扩展，可以提供一种日志的备份功能。
　　log4j.appender.R=org.apache.log4j.RollingFileAppender
　　#日志文件的名称
　　log4j.appender.R.File=log4j.log
　　#日志文件的大小
　　log4j.appender.R.MaxFileSize=100KB
　　# 保存一个备份文件
　　log4j.appender.R.MaxBackupIndex=1
　　
　　log4j.appender.R.layout=org.apache.log4j.TTCCLayout
　　#log4j.appender.R.layout.ConversionPattern=%-d{yyyy-MM-dd HH:mm:ss} [%c]-[%p] %m%n
　　
　　配置以这里就差不多了，如果你想更深入了解配置文件的各个细节，可以去查看docs。还有，在文章的最后面我们提供配置文件中一些主要的语法。下面我们来看看怎样在程序中使用log4j.

　　
　　Log4j的使用
　　使用Log4j，第一步就是获取日志记录器，这个记录器将负责控制日志信息。其语法为
public static Logger getLogger( Class clazz)，
　　必须在使用前要把这个类导入
　　import org.apache.log4j.Logger;
　　
　　name一般是类文件的名字，如下：
　　static Logger logger = Logger.getLogger (this.getClass()) ;
　　
　　您就可以轻松地使用不同优先级别的日志记录语句插入到您想记录日志的任何地方，其语法如下：
　　logger.debug ( Object message ) ;
　　logger.info ( Object message ) ;
　　logger.warn ( Object message ) ;
　　logger.error ( Object message ) ;
　　
　　为什么这里要分级别的呢？试想一下，我们在写程序的时候，为了调试程序，会在很多会出错的地方加入大量的logger.info();信息。当然程序调试完毕，我们不需要这些输出信息了，那怎么办呢？以前的做法是把每个程序中的logger.info删除，但这是不现实的，如果程序不大还可以，但如果程序很多，做这些事情就很烦人了。但因为log4j分级别了，当我们不需要输出这样调试时用到的log.info()时，我们可以把输出的级别调高，如调到 warn,或error级别，这样info级别及以下的级别就不会出输出了，是不是很方便的呢？
　　
　　其实除了这种使用方式，log4j还有其它的使用方面，不需要配置文件，直接在程序中定义输入出级别，层次等信息，如果要了解这方法的使用，可以参考文档。
　　我们在使用的时候只需要使用其3个重要组件： Loggers, Appenders, Layouts  这三个组件协同的工作，使得开发者能够依据信息类别和级别去纪录信息，并能够运行期间，控制信息记录的方式已经日志存放地点