海鷗航際

if (someCondition) {
 System.out.println("some information.");
}

package org.javaresearch.log4j;
import org.apache.log4j.*;
public class TestLog4J {
 static Logger log = Logger.getLogger(TestLog4J.class.getName());
 public static void main(String args[]) {
  BasicConfigurator.configure();
  // logging的各種方法
  cat.debug("Start of main()");
  cat.info("Just testing a log message with priority set to INFO");
  cat.warn("Just testing a log message with priority set to WARN");
  cat.error("Just testing a log message with priority set to ERROR");
  cat.fatal("Just testing a log message with priority set to FATAL");
  // 另一種不方便的格式
  cat.log(Priority.DEBUG, "Testing a log message use a alternate form");
  log.debug("End of main().");
 }
}

0 [main] DEBUG TestLog4J  - Start of main()
10 [main] INFO TestLog4J  - Just testing a log message with priority set to INFO
20 [main] WARN TestLog4J  - Just testing a log message with priority set to WARN
30 [main] ERROR TestLog4J  - Just testing a log message with priority set to ERROR
30 [main] FATAL TestLog4J  - Just testing a log message with priority set to FATAL
40 [main] DEBUG TestLog4J  - Testing a log message use a alternate form
50 [main] DEBUG TestLog4J  - End of main().

log4j.rootLogger=DEBUG, A1
log4j.appender.A1=org.apache.log4j.ConsoleAppender
log4j.appender.A1.layout=org.apache.log4j.PatternLayout
log4j.appender.A1.layout.ConversionPattern= "%-4r [%t] %-5p %c %x - %m%n

20 [main] WARN TestLog4J  - Just testing a log message with priority set to WARN
30 [main] ERROR TestLog4J  - Just testing a log message with priority set to ERROR
30 [main] FATAL TestLog4J  - Just testing a log message with priority set to FATAL

package org.apache.log4j;
public class Logger {
 //創建和恢復方法
 public static Logger getRootLogger();
 public static Logger getLogger(String name);
 public static Logger getLogger(Class clazz);
 // 打印方法
 public void debug(Object message);
 public void info(Object message);
 public void warn(Object message);
 public void error(Object message);
 public void fatal(Object message);
 // 常用打印方法
 public void log(Level l, Object message);
}

Logger logger = Logger.getLogger(JavaLoggingExample.class.getName());

static Logger root = Logger.getRootLogger();
static Logger log1 = Logger.getLogger("org");
static Logger log2 = Logger.getLogger("org.javaresearch");
static Logger log3 = Logger.getLogger("org.javaresearch.log4j.TestLog4J");

DEBUG  <  INFO  <  WARN  <  ERROR  <  FATAL

// 得到一個logger 實例 "com.foo"
Logger  logger = Logger.getLogger("com.foo")
// 現在設置logger的級別，但正常情況是不需要刻意設置lgger級別的，因為它已經在配置文件中完成了
logger.setLevel(Level.INFO);
Logger barlogger = Logger.getLogger("com.foo.Bar");
//因為 WARN >= INFO，這個請求是可以實現的
logger.warn("Low fuel level.");
// 因為DEBUG < INFO，所以這個請求是無法實現的
logger.debug("Starting search for nearest gas station.");
// logger實例"com.foo.Bar"將從"com.foo"繼承級別，這樣，因為INFO >= 
INFO，所以可以實現下面的請求
barlogger.info("Located nearest gas station.");
//因為DEBUG < INFO，這個請求是不能實現的 
barlogger.debug("Exiting gas station search");

性能

在記錄一些日志信息時，會一定程度地影響系統的運行效率，這時日志工具是否高效就是一個關鍵。Log4J的首要設計目標就是高效，一些關鍵組件都重寫過很多次以不斷提高性能。根據Log4J項目小組的報告，在AMD Duron 800MHz ＋ JDK1.3.1的環境下，Log4J判斷一條日志語句是否需要輸出僅需要5納秒。實際的日志語句執行的也非常快速，從使用SimpleLayout的21微秒（幾乎與System.out.println一樣快），到使用TTCCLayout的37微秒不等。

嵌套診斷環境NDC

在多用戶并發的環境下，通常是由不同的線程分別處理不同的客戶端請求。此時要在日志信息中區分出不同的客戶端，你可以為每一個線程生成一個Logger，從而從一堆日志信息中區分出哪些信息是屬于哪個線程的，但這種方式并不高效。Log4J巧妙地使用了Neil Harrison提出的“NDC（嵌套診斷環境）”機制來解決這個問題。Log4J為同一類別的線程生成一個Logger，多個線程共享使用，而它僅在日志信息中添加能夠區分不同線程的信息。NDC是什么？舉例來說，如果一個Servlet接到并發請求時，為每一個客戶端創建一個新的線程，然后分配一個用于保存該請求上下文的NDC堆棧。該上下文可能是發出請求的主機名、IP地址或其它任何可以用于標識該請求的信息。這樣，由于不同的客戶端處理線程具有不同的NDC堆棧，即使這個Servlet同時生成多個線程處理不同的請求，這些日志信息仍然可以區分出來，就好像Log4J為每一個線程都單獨生成了一個Logger實例一樣。在Log4J中是通過org.apache.log4j.NDC實現這種機制的。使用NDC的方法也很簡單，步驟如下：

1. 在進入一個環境時調用NDC.push(String)，然后創建一個NDC；

2. 所做的日志操作輸出中包括了NDC的信息；

3. 離開該環境時調用NDC.pop方法；

4. 當從一個線程中退出時調用NDC.remove方法，以便釋放資源。

下面是一個模擬記錄來自不同客戶端請求事件的例子，代碼如下：

import org.apache.log4j.Logger; import org.apache.log4j.NDC; public class TestNDC { static Logger log = Logger.getLogger(TestNDC.class.getName()); public static void main(String[] args) { log.info("Make sure %x is in your layout pattern!"); // 從客戶端獲得IP地址的例子 String[] ips = {"192.168.0.10","192.168.0.27"}; for (int i = 0; i<ips.length ; i++) // 模擬一個運行方法 { // 將IP放進 NDC中 NDC.push(ips[i]); log.info("A NEW client connected, who's ip should appear in this log message."); NDC.pop(); } NDC.remove(); log.info("Finished."); } }

注意配置文件中的布局格式中一定要加上%x。系統輸出如下：

INFO - Make sure %x is in your layout pattern! INFO 192.168.0.10 - A NEW client connected, who's ip should appear in this log message. INFO 192.168.0.27 - A NEW client connected, who's ip should appear in this log message. INFO - Finished.

使用Log4J還是JDK logging API

從JDK 1.4.0開始，引入了java.util.logging包。雖然Log4J小組曾竭力游說JCP（Java Community Process）采用Log4J作為JDK 1.4的“標準”日志API，雖然最終因Sun的日志API規范的負責人Graham Hamilton的一句“Merlin的開發已經到了最后階段，這時不允許再對主要API做出改變”而沒有被采納，但Log4J還是對新的日志API產生了重要影響。那么，我們到底應該采用Log4J還是java.util.logging包呢？下面僅對兩者做一簡單的比較。

1. Log4J更加成熟，從1999年10月開始至今已經有3年的時間，并且已經在許多項目中有著成熟的應用。而JDK中的logging包是在1.4之后才引入的，并且不能運行于JDK 1.3之前的版本。Log4J則可以良好地運行于JDK 1.1之后的所有版本。

2. Log4J已經被移植到多種環境下，包括log4c（C）、log4cpp（C++）、log4perl（Perl）、log4net（.net）等。在這些環境下，可以感受到幾乎一致的配置和使用方式。這是JDK中的logging API所不能比擬的。

3. Log4J還具有更加強力的格式化系統，可以使記錄輸出時實現簡單的模式。但是，它不會增加類而導致格式化工具的擴展。眾多的附加程序和處理器使得Log4J數據包成為一個絕佳的選擇，所有你所需要的都可能加以實現。

4. Log4J在性能上做了最大的優化。

Logging API對于簡單的使用是足夠的，但它缺少了許多Log4J所具有的功能。所以，如果你需要一個強力的logging機制，就應堅持使用Log4J；而如果只是需要一些簡單的控制或文件記錄，那么可以使用已經內建在JDK之中的logging API。

雖然Log4J和JDK logging API是一種競爭關系，但在logging API還在JCP中討論（JSR47）時，兩者之間就已經開始相互影響了。

FAQ

1. 如何讓Log4J使用指定的配置文件

在啟動你的應用時植入系統屬性。例如，可以把上面的log4j.properties文件放到\properties的相對路徑下，并改名為log.properties，此時如果讓Log4J能夠找到這個配置文件并正確地初始化，需要這樣運行程序：

D:\..\java -Dlog4j.configuration=. \properties\log.properties YourAppName

為什么一定要使用系統屬性，而不在配置文件中指定呢？很顯然，如果把它寫入配置文件，那么，Log4J讀到它時已經遲了。

2. 如何查看到Log4J的配置過程

可以類似1中的那樣，設置系統屬性log4j.debug=true，從而打開Log4J的Verbose模式，此時會輸出Log4J的初始化過程，這樣就會對Log4J的啟動有一個更詳細的了解。下面是Log4J啟動信息的一個示例：

log4j: Trying to find [log4j.xml] using context classloader sun.misc.Launcher$AppClassLoader@92e78c. log4j: Trying to find [log4j.xml] using sun.misc.Launcher$ExtClassLoader@9fbe93class loader. log4j: Trying to find [log4j.xml] using ClassLoader.getSystemResource(). log4j: Trying to find [log4j.properties] using context classloader sun.misc.Launcher$AppClassLoader@92e78c. log4j: Using URL [file:/D:/java/logging/src/log4j.properties] for automatic log4j configuration. log4j: Reading configuration from URL file:/E:/java/logging/src/log4j.properties log4j: Parsing for [root] with value=[DEBUG, A1]. log4j: Level token is [DEBUG]. log4j: Category root set to DEBUG log4j: Parsing appender named "A1". log4j: Parsing layout options for "A1". log4j: Setting property [conversionPattern] to [%d %l %-5p %c [%t] - %m%n]. log4j: End of parsing for "A1". log4j: Parsed "A1" options. log4j: Finished configuring. ...... // 下面就是應用的日志信息，省略。