log4j详解

1.背景
对于有经验的开发者来说，日志记录的重要性显而易见。例如程序中的异常处理和安全性都依赖于Logging的功能来帮助履行它们的指责。应用程序中的日志记录主要基于三个目的：监视代码中变量的变化情况，周期性的记录到文件中供其他应用进行统计分析工作；跟踪代码运行时轨迹，作为日后审计的依据；担当集成开发环境中的调试器的作用，向文件或控制台打印代码的调试信息。经验表明日志记录是开发周期中的重要组成部分。

最简单的做法就是在代码中嵌入许多的打印语句，但是这样打印语句会充斥代码的主体，显然不是一个好方法。因此，使用成熟的框架例如Log4j，则会更具灵活性。

2.Log4j简介
Log4j 框架是用 Java 语言编写的标准日志记录框架。作为 Jakarta 项目的一部分，它在 Apache 软件许可证（Apache Software License）下分发，以速度和灵活性为中心概念：Log4j 环境是完全可配置的，通过使用Log4j，我们可以控制日志信息输送的目的地是控制台、文件、GUI组件、甚至是套接口服务器、NT的事件记录器、 UNIX Syslog守护进程等；我们也可以控制每一条日志的输出格式；通过定义每一条日志信息的级别，我们能够更加细致地控制日志的生成过程。

Log4j由三个重要的部件构成：记录器（Loggers）、输出源（Appenders）和布局（Layouts）。

记录器按照布局中指定的格式把日志信息写入一个或多个输出源。输出源可以是控制台、文本文件、XML文件或Socket，甚至还可以把信息写入到Windows事件日志或通过电子邮件发送。我们可以通过配置文件来部署这些组件。

其实您也可以完全不使用配置文件，而是在代码中配置Log4j环境。但是，使用配置文件将使您的应用程序更加灵活。本文从描述 log4j 体系结构的主要组件着手。然后是描述基本用法和配置的简单示例。

3.定义配置文件
Log4j支持两种配置文件格式，一种是XML格式的文件，一种是Java特性文件（键=值）。下面我们介绍使用Java特性文件做为配置文件的方法：

3.1 配置记录器

Log4j允许程序员定义多个记录器，每个记录器有自己的名字。但有一个记录器叫做根记录器rootLogger，它永远存在，且不能通过名字检索或引用。

rootLogger的用处是可以全局控制所有日志，这样不至于在要修改记录器的级别时要到处去修改，直接改rootLogger就可以了。但是这也不是说所有的记录器都必须继承rootLogger的配置参数，在任何一个记录器中就可以设置additivity="false"来防止本记录器从rootLogger继承属性。

在配置文件中，可以如下定义根记录器：

　　log4j.rootLogger = [ level ] , appenderName, appenderName, …

Level是记录器的级别，它是日志记录的优先级，分为OFF、FATAL、ERROR、WARN、INFO、DEBUG、ALL或者您定义的级别。Log4j建议只使用四个级别：ERROR、WARN、INFO、DEBUG：

　　DEBUG < INFO < WARN < ERROR < FATAL

右边的级别比左边的高。如果一条log信息的级别，大于等于记录器的级别值，那么记录器就会记录它。例如level被设置为INFO级别，那么应用程序中所有的DEBUG的日志信息将不被打印出来。通过在这里定义的级别，您可以控制到应用程序中相应级别的日志信息的开关。

appenderName是输出源的名字，它指定日志信息输出到哪个地方。您可以为一个记录器指定多个输出源。

在一些配置文件中，你可能会看到下面的语句：

　　log4j.rootCategory = [ level ] , appenderName, appenderName, …

在早期的Log4j版本中，org.apache.Category实现了记录器的功能，为了提高向后兼容性，Logger扩展了Category，因此rootCategory和rootLogger是可以互换的，但最后Category将从类库中删除，因此请使用Logger类。

除了根记录器之外，log4j允许程序员定义多个记录器，每个记录器有自己的名字：

　　log4j.logger.loggerName = [ level ] , appenderName, appenderName, …

在Log4J中Logger是具有层次关系的，Log4j支持配置的记录器之间的“父子关系”，记录器之间通过名字来表明隶属关系（或家族关系），它们有一个共同的根，位于最上层，其它Logger遵循类似包的层次：记录器a.b,与记录器a.b.c之间是父子关系，而记录器a与a.b.c之间是祖先与后代的关系。例如：

static Logger root = Logger.getRootLogger();

static Logger log1 = Logger.getLogger("cc");

static Logger log2 = Logger.getLogger("cc.ejb");

static Logger log3 = Logger.getLogger("cc.ejb.my.TestApp"); 上面代码中，log1是log2的父亲，是log3的祖先，而root是所有log1、log2、 log3的祖先，它们都从root中继承。所以，一般情况下，仅需要配置好rootLogger，其它子记录器都会从中继承rootLogger的配置。如果修改了rootLogger的配置，其它所有的子记录器也会继承这种变化。这样就大大地方便了配置。如果一个应用中包含了上千个类都需要日志，那么我们是否需要配置上千个Logger呢？我们通过一个简单的办法来解决这个问题：用每一个java类文件名（包含该类的包名）定义一个记录器，这是一种有用并且直观的记录器实例名的定义方式。例如在配置文件中定义了一个com.foo的记录器：　　log4j.logger.com.foo=WARN在com.foo中的一个java类bar，我们通过其本类的名字获得一个记录器“com.foo.Bar”：

package com.foo;
class Bar{
static Logger log=Logger.getLogger(bar.Class.getName());
.....
}

由于记录器com.foo.Bar 没有指定的级别，它从com.foo（在配置文件中其级别设置成WARN）继承级别。并且这样我们就能方便的从大量log信息中判断出它们各自的来源。当然了，这不是硬性规定的，实际上Log4j没有对设置记录器的实例名做什么限制，程序员可以根据自己的喜好随意定义。

3.2 日志信息输出源Appender
log4j 还允许日志记录请求打印到多个输出目的地，按 log4j 的叫法是输出源。一个记录器可以有多个输出源。一条log信息如果可被这个记录器处理，则该记录器会把这条信息送往每个它所拥有的输出源，以及层次结构中更高级的输出源。例如，根记录器以控制台作为输出源，则所有可被纪录的日志都将至少打印到控制台。

配置日志信息输出源，其语法为：

　　log4j.appender.appenderName = fully.qualified.name.of.appender.class

　　log4j.appender.appenderName.option1 = value1
　　…
　　log4j.appender.appenderName.option = valueN

Log4j提供的appender有以下几种：

org.apache.log4j.ConsoleAppender（控制台）
org.apache.log4j.FileAppender（文件）
org.apache.log4j.DailyRollingFileAppender（每天产生一个日志文件）
org.apache.log4j.RollingFileAppender（文件大小到达指定尺寸的时候产生一个新的文件）
org.apache.log4j.WriterAppender（将日志信息以流格式发送到任意指定的地方）
org.apache.log4j.SocketAppender (Socket)
org.apache.log4j.NtEventLogAppender (NT的Event Log)
org.apache.log4j.JMSAppender (电子邮件）

请注意，可以通过覆盖缺省行为，这样就不再附加累积的输出源：

　　log4j.additivity.loggerName=false

注意，不要把一个输出源附加到多个记录器上，否则会得到“Attempted to append to closed appender named xxx”的信息。

3.3 配置日志信息的格式（布局），其语法为：

　　log4j.appender.appenderName.layout = fully.qualified.name.of.layout.class

　　log4j.appender.appenderName.layout.option1 = value1

　　…

　　log4j.appender.appenderName.layout.option = valueN

其中，Log4j提供的layout有以下几种：

org.apache.log4j.HTMLLayout（以HTML表格形式布局）
org.apache.log4j.PatternLayout（可以灵活地指定布局模式）
org.apache.log4j.SimpleLayout（包含日志信息的级别和信息字符串）
org.apache.log4j.TTCCLayout（包含日志产生的时间、线程、类别等等信息）

如果采用了PatternLayout, 则Log4J采用类似C语言中的printf函数的打印格式格式化日志信息，打印参数如下：

%m 输出代码中指定的消息
%p 输出优先级，即DEBUG，INFO，WARN，ERROR，FATAL
%r 输出自应用启动到输出该log信息耗费的毫秒数
%c 输出所属的类目，通常就是所在类的全名
%t 输出产生该日志事件的线程名
%n 输出一个回车换行符，Windows平台为“ ”，Unix平台为“ ”
%d 输出日志时间点的日期或时间，默认格式为ISO8601，也可以在其后指定格式，比如：%d{yyy MMM dd HH:mm:ss,SSS}，输出类似：2002年10月18日 22：10：28，921
%l 输出日志事件的发生位置，包括类目名、发生的线程，以及在代码中的行数。举例：Testlog4.main(TestLog4.java:10)

3.4 总结

<?xml version="1.0" encoding="UTF-8" ?>  
<!DOCTYPE log4j:configuration SYSTEM "log4j.dtd"]]>  
<log4j:configuration]]>  
 <appender name="CONSOLE" class="org.apache.log4j.ConsoleAppender"]]>  
  <layout class="org.apache.log4j.PatternLayout"]]>  
   <param name="ConversionPattern"  
    value="%d - %c -%-4r [%t] %-5p %x - %m%n" />  
  </layout]]>  
  <!--限制输出级别-->  
  <filter class="org.apache.log4j.varia.LevelRangeFilter"]]>  
   <param name="LevelMax" value="ERROR"/>  
   <param name="LevelMin" value="TRACE"/>  
  </filter]]>  
 </appender]]>  
 <appender name="FILE" class="org.apache.log4j.FileAppender"]]>  
  <param name="File" value="C:/log4j1.log"/>  
  <layout class="org.apache.log4j.PatternLayout"]]>  
   <param name="ConversionPattern"  
    value="%d - %c -%-4r [%t] %-5p %x - %m%n" />  
  </layout]]>  
 </appender]]>   
 <appender name="DATABASE" class="org.apache.log4j.jdbc.JDBCAppender"]]>  
  <param name="URL" value="jdbc:oracle:thin:@192.168.0.59:1521:oanet"/>  
  <param name="driver" value="oracle.jdbc.driver.OracleDriver"/>  
  <param name="user" value="hdczoa"/>  
  <param name="password" value="system"/>      
  <layout class="org.apache.log4j.PatternLayout"]]>  
   <param name="ConversionPattern"  
    value="INSERT INTO hdczoa.LOG4J(stamp,thread, info_level,class,message) VALUES ('%d', '%t', '%p', '%c', %m)" />  
  </layout]]>  
 </appender]]>  
 <!-- 发邮件（只有ERROR时才会发送！） -->  
 <appender name="MAIL"  
  class="org.apache.log4j.net.SMTPAppender"]]>  
  <param name="threshold" value="debug" />  
  <!-- 日志的错误级别  
   <param name="threshold" value="fatal"/>  
  --]]>  
  <!-- 缓存文件大小，日志达到512K时发送Email -->  
  <param name="BufferSize" value="512" /><!-- 单位K -->
  <param name="From" value="test@163.com" />  
  <param name="SMTPHost" value="smtp.163.com" />  
  <param name="Subject" value="juyee-log4jMessage" />  
  <param name="To" value="test@163.com" />  
  <param name="SMTPUsername" value="test" />  
  <param name="SMTPPassword" value="test" />  
  <layout class="org.apache.log4j.PatternLayout"]]>  
   <param name="ConversionPattern"  
    value="%-d{yyyy-MM-dd HH:mm:ss.SSS} [%p]-[%c] %m%n" />  
  </layout]]>  
 </appender]]>  
 <appender name="ASYNC" class="org.apache.log4j.AsyncAppender"]]>  
  <param name="BufferSize" value="256" />  
  <appender-ref ref="DATABASE" />  
 </appender]]>  
 <!--通过<logger></logger>的定义可以将各个包中的类日志输出到不同的日志文件中-->  
 <logger name="com.litt2.log4j" additivity="false"]]>     
        <level value="WARN" />     
        <appender-ref ref="CONSOLE" />     
    </logger]]>  
 <!--通过<category></category>的定义可以将各个包中的类日志输出到不同的日志文件中-->  
 <category name="com.litt3"]]>     
    <level value="DEBUG" />   
       <appender-ref ref="CONSOLE" />  
       <appender-ref ref="MAIL" />  
  </category]]>  
 <root]]>  
  <priority value="debug" />  
  <appender-ref ref="CONSOLE" />  
  <appender-ref ref="FILE" />  
 </root]]>  
</log4j:configuration]]>

4. 例子
下面是一个完整的Log4j配置文件，这个配置文件指定了两个输出源stdout和R。前者把日志信息输出到控制台，后者是一个轮转日志文件。最大的文件是100KB，当一个日志文件达到最大尺寸时，Log4J会自动把example.log 重命名为example.log.1，然后重建一个新的example.log文件，依次轮转。

log4j.rootLogger=debug, stdout, R

log4j.appender.stdout=org.apache.log4j.FileAppender
log4j.appender.stdout.File=System.out
log4j.appender.stdout.layout=org.apache.log4j.PatternLayout

# Pattern to output the caller's file name and line number.
log4j.appender.stdout.layout.ConversionPattern=%5p [%t] (%F:%L) - %m%n

log4j.appender.R=org.apache.log4j.RollingFileAppender
log4j.appender.R.File=example.log

log4j.appender.R.MaxFileSize=100KB
# Keep one backup file
log4j.appender.R.MaxBackupIndex=1

log4j.appender.R.layout=org.apache.log4j.PatternLayout
log4j.appender.R.layout.ConversionPattern=%p %t %c - %m%n

log4j.logger.cc.ejb.my=error,out

log4j.appender.out=org.apache.log4j.ConsoleAppender
log4j.appender.out.layout=org.apache.log4j.PatternLayout
log4j.appender.out.layout.ConversionPattern=%p %t %c - %m%n

log4j.logger.cc.ejb.my.son=debug
log4j.additivity.cc.ejb.my.son=false

5. 在代码中使用Log4j

5.1 得到记录器
使用Log4j，第一步就是获取日志记录器，这个记录器将负责控制日志信息。其语法为：

　　public static Logger getLogger( String name)

通过指定的名字获得记录器，如果必要的话，则为这个名字创建一个新的记录器。Name一般取本类的名字，比如：

　　static Logger logger = Logger.getLogger ( ServerWithLog4j.class.getName () )

5.2 读取配置文件
当获得了日志记录器之后，第二步将配置Log4j环境，其语法为：

　　//自动快速地使用缺省Log4j环境。

BasicConfigurator.configure ();
//读取使用Java的特性文件编写的配置文件
　　PropertyConfigurator.configure ( String configFilename);
//读取XML形式的配置文件
　　DOMConfigurator.configure ( String filename );

5.3 插入记录信息（格式化日志信息）
当上两个必要步骤执行完毕，您就可以轻松地使用不同优先级别的日志记录语句插入到您想记录日志的任何地方，其语法如下：

　　Logger.debug ( Object message ) ;

Logger.info ( Object message ) ;

　　Logger.warn ( Object message ) ;

　　Logger.error ( Object message ) ;

5.4 例子

我们通过下面这个简单的例子，来演示在程序如何使用Log4j，您可以修改配置文件以得到不同日志信息。

package cc.ejb.my;
import org.apache.log4j.Logger;
import org.apache.log4j.PropertyConfigurator;
import my.son.Foo;
public class TestApp {

static Logger logger=Logger.getLogger(TestApp.class.getName());

    public static void main(String[] args) {

        PropertyConfigurator.configure("log4j.properties");
        logger.info("Applcaiton Starts");
        logger.warn("Bar Starts");
        Bar bar=new Bar();
        logger.error("Bar Errors");
        bar.doIt();
        logger.warn("Bar Exits");
        logger.info("Foo Starts");
        Foo foo=new Foo();
        logger.error("Foo Errors");
        foo.doit();
        logger.warn("Foo exits ");
        logger.info("Applcaition Exits");

    }

}

class Bar
{
    static Logger logger = Logger.getLogger(Bar.class.getName());
    public void doIt() {
      logger.debug("Did it again!");
    }
}

package cc.ejb.my.son;

import org.apache.log4j.Logger;

public class Foo {
    private Logger log=Logger.getLogger(Foo.class.getName());
    public Foo() {
        log.info("Foo Initialzie");
    }
    public void doit()
    {
        log.debug("Do it in Foo");
    }

}