log4j的简要介绍(续)

Configuration

在应用程序代码中插入记录日志请求需要计划和精力。观察表明几乎4%的代码用于记录日志。结果，即使是中等规模的应用程序也有成千上万条记录日志语句嵌在程序中间。考虑到它们的数量，实现管理这些记录日志语句而不需要手工修改它们变得势在必行。

log4j环境完全可以用程序配置。但是，使用配置文件配置log4j要更灵活。当前，配置文件内能写在XML或者以（key=value）格式写在java属性文件中。

让我们以一个想象的使用log4j的应用程序MyApp感受一下这是怎么做的：

import com.foo.Bar;

 // Import log4j classes.
 import org.apache.log4j.Logger;
 import org.apache.log4j.BasicConfigurator;

 public class MyApp {

   // Define a static logger variable so that it references the
   // Logger instance named "MyApp".
   static Logger logger = Logger.getLogger(MyApp.class);

   public static void main(String[] args) {

     // Set up a simple configuration that logs on the console.
     BasicConfigurator.configure();

     logger.info("Entering application.");
     Bar bar = new Bar();
     bar.doIt();
     logger.info("Exiting application.");
   }
 }

MyApp开始引入log4j相关的类。然后定义了一个名为MyApp的静态的logger变量，正好是类的全名。

MyApp使用com.foo包中定义的Bar类。

package com.foo;
 import org.apache.log4j.Logger;

 public class Bar {
   static Logger logger = Logger.getLogger(Bar.class);

   public void doIt() {
     logger.debug("Did it again!");
   }
 }

调用BasicConfigurator.configure方法创建了一个相当简单的log4j设置。这个方法给根logger添加了一个ConsoleAppender。PatternLayout将会被设置为"%-4r [%t] %-5p %c %x - %m%n"，并以此格式化输出。

注意，默认情况下根logger的级别为Level.DEBUG。

MyApp的输出为:

0    [main] INFO  MyApp  - Entering application.
36   [main] DEBUG com.foo.Bar  - Did it again!
51   [main] INFO  MyApp  - Exiting application.

下图描述了MyApp调用BasicConfigurator.configure方法之后的对象图：

作为附注，log4j中子logger只连接到存在的ancestor。具体来说，loggercom.foo.Bar直接连接到根logger，因此避免了没有用到的com或者com.foologger。这极大地提升了性能，降低了log4j的内存耗费。

MyApp通过调用BasicConfigurator.configure方法配置log4j。其他类只需要导入org.apache.log4j.Logger类，检索他们需要使用的logger。

前一个例子总是输出相同的日志信息。幸运的是，修改MyApp很容易，日志输出能够在运行时控制。这是一个稍微修改的版本：

import com.foo.Bar;

 import org.apache.log4j.Logger;
 import org.apache.log4j.PropertyConfigurator;

 public class MyApp {

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

   public static void main(String[] args) {


     // BasicConfigurator replaced with PropertyConfigurator.
     PropertyConfigurator.configure(args[0]);

     logger.info("Entering application.");
     Bar bar = new Bar();
     bar.doIt();
     logger.info("Exiting application.");
   }
 }

这个版本的MyApp指令PropertyConfigurator解析一个配置文件并相应地设置日志。

这是一个简单的配置文件，可以产生和前一个基于BasicConfigurator的例子完全相同的输出。

# Set root logger level to DEBUG and its only appender to A1.
log4j.rootLogger=DEBUG, A1

# A1 is set to be a ConsoleAppender.
log4j.appender.A1=org.apache.log4j.ConsoleAppender

# A1 uses PatternLayout.
log4j.appender.A1.layout=org.apache.log4j.PatternLayout
log4j.appender.A1.layout.ConversionPattern=%-4r [%t] %-5p %c %x - %m%n

<!-- <p>请注意如果你复制和粘贴着两个例子，某些行结尾很可能包含一些空格。这些空格没有被截断，并被dPropertyConfigurator解析。在你阅读本文时，问题应该已经改正了.-->

假设我们不想看见属于com.foo包的任何组件的输出，如下配置文件展示了一种可行的方式：.

log4j.rootLogger=DEBUG, A1
log4j.appender.A1=org.apache.log4j.ConsoleAppender
log4j.appender.A1.layout=org.apache.log4j.PatternLayout

# Print the date in ISO 8601 format
log4j.appender.A1.layout.ConversionPattern=%d [%t] %-5p %c - %m%n

# Print only messages of level WARN or above in the package com.foo.
log4j.logger.com.foo=WARN

用这个文件配置的MyApp的输出如下：

2000-09-07 14:07:41,508 [main] INFO  MyApp - Entering application.
2000-09-07 14:07:41,529 [main] INFO  MyApp - Exiting application.

com.foo.Bar logger并没有赋予级别，它从com.foo继承级别，在配置文件中设为了WARN。Bar.doIt方法的日志语句基本为DEBUG，比logger级别低，从而doIt()方法的记录日志请求被压制了。

以下是使用多个appender的另外一份配置文件：

log4j.rootLogger=debug, stdout, R

log4j.appender.stdout=org.apache.log4j.ConsoleAppender
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

调用升级之后使用这个配置文件的MyApp将会在控制台输出如下内容：

INFO [main] (MyApp2.java:12) - Entering application.
DEBUG [main] (Bar.java:8) - Doing it again!
 INFO [main] (MyApp2.java:15) - Exiting application.

另外，根logger分配了另外一个appender，输出内容将会被写进example.log文件。当文件达到100KB时，再从文件开头开始写。原来的example.log中的内容自动移到了example.log.1。

注意为了获得这两种不同的记录日志行为，我们不需要重新编译代码。我们能同样简单地往UNIX Syslog守护进程里写记录日志，将所有的com.foo输出到NT事件logger，或者将记录日志事件发送到一个log4j的远程服务器。服务器将根据本地服务器policy记录日志，比如将记录日志事件转发到第二个log4j服务器。

export TOMCAT_OPTS="-Dlog4j.configuration=foobar.txt"

export TOMCAT_OPTS="-Dlog4j.debug -Dlog4j.configuration=foobar.xml"

set TOMCAT_OPTS=-Dlog4j.configuration=foobar.lcf -Dlog4j.configuratorClass=com.foo.BarConfigurator 

set TOMCAT_OPTS=-Dlog4j.configuration=file:/c:/foobar.lcf

package com.foo;

import org.apache.log4j.PropertyConfigurator;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.PrintWriter;
import java.io.IOException;

public class Log4jInit extends HttpServlet {

  public
  void init() {
    String prefix =  getServletContext().getRealPath("/");
    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);
    }
  }

  public
  void doGet(HttpServletRequest req, HttpServletResponse res) {
  }
}

<servlet>
    <servlet-name>log4j-init</servlet-name>
    <servlet-class>com.foo.Log4jInit</servlet-class>

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

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

public class NDC {
    // Used when printing the diagnostic
    public static String get();

    // Remove the top of the context from the NDC.
    public static String pop();

    // Add diagnostic context for the current thread.
    public static void push(String message);

    // Remove the diagnostic context for this thread.
    public static void remove();
  }