使用Log4J來進行調試

 

Log4J的配置文件(Configuration File)就是用來設置記錄器的級別、存放器和佈局的，它可接key=value格式的設置或xml格式的設置信息。通過配置，可以創建出Log4J的運行環境。

1. 配置文件
Log4J配置文件的基本格式如下：

#配置根Logger
log4j.rootLogger  =   [ level ]   ,  appenderName1 ,  appenderName2 ,  …

#配置日誌信息輸出目的地Appender
log4j.appender.appenderName  =  fully.qualified.name.of.appender.class 
　　log4j.appender.appenderName.option1  =  value1 
　　… 
　　log4j.appender.appenderName.optionN  =  valueN 

#配置日誌信息的格式（佈局）
log4j.appender.appenderName.layout  =  fully.qualified.name.of.layout.class 
　　log4j.appender.appenderName.layout.option1  =  value1 
　　… 
　　log4j.appender.appenderName.layout.optionN  =  valueN 

其中 [level] 是日誌輸出級別，共有5級：
爲日誌輸出目的地，Log4j提供的appender有以下幾種：

Layout：日誌輸出格式，Log4j提供的layout有以下幾種：

FATAL      0  
ERROR      3  
WARN       4  
INFO       6  
DEBUG      7

Appender

org.apache.log4j.ConsoleAppender（控制檯），
org.apache.log4j.FileAppender（文件），
org.apache.log4j.DailyRollingFileAppender（每天產生一個日誌文件），
org.apache.log4j.RollingFileAppender（文件大小到達指定尺寸的時候產生一個新的文件），
org.apache.log4j.WriterAppender（將日誌信息以流格式發送到任意指定的地方）

 

org.apache.log4j.HTMLLayout（以HTML表格形式佈局），
org.apache.log4j.PatternLayout（可以靈活地指定佈局模式），
org.apache.log4j.SimpleLayout（包含日誌信息的級別和信息字符串），
org.apache.log4j.TTCCLayout（包含日誌產生的時間、線程、類別等等信息）

打印參數: Log4J採用類似C語言中的printf函數的打印格式格式化日誌信息，如下:

　　%m   輸出代碼中指定的消息
　　%p   輸出優先級，即DEBUG，INFO，WARN，ERROR，FATAL 
　　%r   輸出自應用啓動到輸出該log信息耗費的毫秒數 
　　%c   輸出所屬的類目，通常就是所在類的全名 
　　%t   輸出產生該日誌事件的線程名 
　　%n   輸出一個回車換行符，Windows平臺爲“/r/n”，Unix平臺爲“/n” 
　　%d   輸出日誌時間點的日期或時間，默認格式爲ISO8601，也可以在其後指定格式，比如：%d{yyy MMM dd HH:mm:ss , SSS}，輸出類似：2002年10月18日  22 ： 10 ： 28 ， 921  
　　%l   輸出日誌事件的發生位置，包括類目名、發生的線程，以及在代碼中的行數。舉例：Testlog4.main(TestLog4.java: 10 ) 

2. 在代碼中初始化Logger:
1）在程序中調用BasicConfigurator.configure()方法：給根記錄器增加一個ConsoleAppender，輸出格式通過PatternLayout設爲"%-4r [%t] %-5p %c %x - %m%n"，還有根記錄器的默認級別是Level.DEBUG.
2）配置放在文件裏，通過命令行參數傳遞文件名字，通過PropertyConfigurator.configure(args[x])解析並配置；
3）配置放在文件裏，通過環境變量傳遞文件名等信息，利用log4j默認的初始化過程解析並配置；
4）配置放在文件裏，通過應用服務器配置傳遞文件名等信息，利用一個特殊的servlet來完成配置。

3. 爲不同的 Appender 設置日誌輸出級別：
當調試系統時，我們往往注意的只是異常級別的日誌輸出，但是通常所有級別的輸出都是放在一個文件裏的，如果日誌輸出的級別是BUG！？那就慢慢去找吧。
這時我們也許會想要是能把異常信息單獨輸出到一個文件裏該多好啊。當然可以，Log4j已經提供了這樣的功能，我們只需要在配置中修改Appender的Threshold 就能實現,比如下面的例子：

[配置文件]
 

### set log levels ###
log4j.rootLogger = debug ,  stdout ,  D ,  E

### 輸出到控制檯 ###
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 %c{ 1 }:%L - %m%n

### 輸出到日誌文件 ###
log4j.appender.D = org.apache.log4j.DailyRollingFileAppender
log4j.appender.D.File = logs/log.log
log4j.appender.D.Append = true
log4j.appender.D.Threshold = DEBUG ## 輸出DEBUG級別以上的日誌
log4j.appender.D.layout = org.apache.log4j.PatternLayout
log4j.appender.D.layout.ConversionPattern = %-d{yyyy-MM-dd HH:mm:ss}  [ %t:%r ] - [ %p ]  %m%n

### 保存異常信息到單獨文件 ###
log4j.appender.D = org.apache.log4j.DailyRollingFileAppender
log4j.appender.D.File = logs/error.log ## 異常日誌文件名
log4j.appender.D.Append = true
log4j.appender.D.Threshold = ERROR ## 只輸出ERROR級別以上的日誌!!!
log4j.appender.D.layout = org.apache.log4j.PatternLayout
log4j.appender.D.layout.ConversionPattern = %-d{yyyy-MM-dd HH:mm:ss}  [ %t:%r ] - [ %p ]  %m%n

 

有了上面的配置文件後，可以通過以下任意一種方式對其進行裝載：

• 讓Log4j自動裝載配置文件
  將上面的文件命名爲log4j.properties，並保存到WEB-INF/classes/ 目錄下，這樣當第一次調用Logger.getLogger(SomeClass.class.getName()); 時，Log4j 就會自動裝載該配置文件對log 系統進行初始化。
• 用系統變量指定配置文件的位置
  如果不想把配置文件放到WEB-INF/clases/ 目錄下，或者不想把配置文件命名爲log4j.properties 那麼就可以通過系統變量log4j.configuration來對其進行自定義，例如：
  -Dlog4j.configuration=file:/D:/projects/someproject/WEB-INF/log4j.properties
  用指定位置的文件進行配置
  -Dlog4j.configuration=foo.txt
  用WEB-INF/classes/目錄下的foo.txt 進行配置
  
• 用PropertyConfigurator 讀取配置文件

import org.apache.log4j.PropertyConfigurator;
import org.apache.log4j.Logger;
......
public class Log4jTestServlet {
  private static Logger logger = Logger.getLogger(Log4jTestServlet.class.getName());
......
  public void init(ServletConfig servletConfig) throws ServletException {
    super.init(servletConfig);
    String file = getRealPath(getInitParameter("log4j-init-file"));
    PropertyConfigurator.configure(file);
    /*
     *PropertyConfigurator.configure(Properties);
     *PropertyConfigurator.configure(URL);
     *PropertyConfigurator.configureAndWatch(file, 30); //delay 30 second
     */
    logger.info("log4j has been configurated with PropertyConfigurator.configuration successfully!");
  }
}
###############################################################

入門實踐

Configuration file name：log4j.properties

# For the general syntax of property based configuration files see the
# documenation of org.apache.log4j.PropertyConfigurator.
# The root category uses the appender called A1. Since no priority is
# specified, the root category assumes the default priority for root
# which is DEBUG in log4j. The root category is the only category that
# has a default priority. All other categories need not be assigned a
# priority in which case they inherit their priority from the
# hierarchy.

log4j.rootCategory=INFO, A1, A2

# A1 is set to be a FileAppender which outputs to the file
# "factor.log". Start the server NumberCruncherServer and two
# NumberCruncherClients, and ask to factor two numbers
# near-simultaneously. Notice that the log output from these two
# requests are logged in the file factor.log. Nevertheless, the logs
# of these requests can still be distinguished given their distinct
# nested diagnostic contexts.

log4j.appender.A1=org.apache.log4j.DailyRollingFileAppender
log4j.appender.A1.File=Log4J.log
log4j.appender.A1.DatePattern='.'yyyy-MM-dd
log4j.appender.A1.layout=org.apache.log4j.PatternLayout

log4j.appender.A2=org.apache.log4j.ConsoleAppender
log4j.appender.A2.layout=org.apache.log4j.PatternLayout

# Note the %x conversion specifier for NDC printing.
# %d date time
# %-5p debug level
# %m messages
# %l class with method and line number (slowly! dubug only, on release use %c{2} in release version)
# %n /n or /r/n

#debug version
log4j.appender.A1.layout.ConversionPattern=%d [%-5p] %l - %m%n
log4j.appender.A2.layout.ConversionPattern=%d [%-5p] %l - %m%n

#release version
# log4j.appender.A1.layout.ConversionPattern=%d [%-5p] %c{2} - %m%n

Class name：TestLog4J.java

package com.echo.test;

import org.apache.log4j.Logger;

/*

* author：echo

*/

public class TestLog4J {
 
 private static final Logger logger = Logger.getLogger(TestLog4J.class);
 
 /**
  * @param args
  */
 public static void main(String[] args) {
  // TODO Auto-generated method stub
  logger.info("This is a Log4J info Testing!");
  logger.error("This is a Log4J error Testing!");
  //The debug log will be not printed on the text file
  //and the console, because the log4j's rootCategory
  //is INFO, so there are just INFO WARN ERROR JATAL can be
  //printed on the text file and the console.
  logger.debug("This is a Log4J Debug Testing!");
 }

}