優雅天平

Logger類對象提供一系列方法供程序員輸出日志信息。

        

        ------ Log4j APIs : class Logger ------
        
        
        
        // Printing methods :
        
        public void debug(Object msg);
        public void debug(Object msg, Throwable t);
        
        public void info(Object msg);
        public void info(Object msg, Throwable t);
        
        public void warn(Object msg);
        public void warn(Object msg, Throwable t);
        
        public void error(Object msg);
        public void error(Object msg, Throwable t);
        
        public void fatal(Object msg);
        public void fatal(Object msg, Throwable t);
        
        // Generic printing method :
        
        public void log(Level l, Object msg);
      

Logger由一個String類的名字識別，logger的名字是大小寫敏感的，且名字之間具有繼承的關系，子名有父名作為前綴，用點號.分隔。如：x.y是x.y.z的父親。

根logger (root logger)是所有logger的祖先，它具有如下屬性：1) 它總是存在的；2) 它不可以通過名字獲得。

通過調用public static Logger Logger.getRootLogger()獲得root logger；通過調用public static Logger Logger.getLogger(String name)或者public static Logger Logger.getLogger(Class clazz)獲得（或者創建）一個named logger。后者相當于調用Logger.getLogger(clazz.getName())。

在某對象中，用該對象所屬的類為參數，調用Logger.getLogger(Class clazz)以獲得logger被認為是目前所知的最理智的命名logger的方法。

每個logger都被分配了一個日志級別 (log level)，用來控制日志信息的輸出。未被分配level的logger將繼承它最近的父logger的level。

每條輸出到logger的日志請求(logging request)也都有一個level，如果該request的level大于等于該logger的level，則該request將被處理（稱為enabled）；否則該request將被忽略。故可得知：

1. logger的level越低，表示該logger越詳細
2. logging request的level越高，表示該logging request越優先輸出

Level類中預定義了五個level，它們的大小關系如下：

        Level.ALL < Level.DEBUG < Level.INFO < Level.WARN < Level.ERROR < Level.FATAL < Level.OFF
      

以下代碼將用自己所屬的類為參數，創建一個logger，啟用默認配置，設置其level并向其輸出若干logging request。

import org.apache.log4j.Logger;
import org.apache.log4j.BasicConfigurator;
import org.apache.log4j.Level;

public class Log4jTest {
    public static void main(String argv[]) {
    
        
        // Create a logger by the name of class Log4jTest.
        
        Logger logger = Logger.getLogger(Log4jTest.class);
        
        // Use the default configuration.
        
        BasicConfigurator.configure();
        
        // Set the logger level to Level.INFO
        
        logger.setLevel(Level.INFO);
        
        // This request will be disabled since Level.DEBUG < Level.INFO.
                  
        logger.debug("This is debug.");
        
        // These requests will be enabled.
                  
        logger.info("This is an info.");
        logger.warn("This is a warning.");
        logger.error("This is an error.");
        logger.fatal("This is a fatal error.");
        
        return;
    }
}
      

1. 用同名參數調用Logger.getLogger(String name)將返回同一個logger的引用。故可以在一個地方配置logger，在另外一個地方獲得配置好的logger，而無須相互間傳遞logger的引用。
2. logger的創建可以按照任意的順序，即，父logger可以后于子logger被創建。log4j將自動維護logger的繼承樹。

可以使用ConsoleAppender對象把日志輸出到控制臺。每個ConsoleAppender都有一個target，表示它的輸出目的地。它可以是System.out，標準輸出設備（緩沖顯示屏）；或者是System.err，標準錯誤設備（不緩沖顯示屏）。ConsoleAppender的使用方法參考如下API :.

        

        ------ Log4j APIs : class ConsoleAppender extends WriterAppender ------
        
      
        
        // 構造方法，使用一個Layout對象構造一個ConsoleAppender對象 :.
        // 默認情況下，ConsoleAppender的target是System.out :.
        
        public ConsoleAppender(Layout layout);
        
        // 構造方法，使用一個Layout對象和一個target字符串構造ConsoleAppender對象 :.
        // target的可能取值為ConsoleAppender.SYSTEM_OUT和ConsoleAppender.SYSTEM_ERR :.
        
        public ConsoleAppender(Layout layout, String target);
      

可以使用FileAppender對象把日志輸出到一個指定的日志文件中去。使用方法可以參考如下的API :.

        

        ------ Log4j APIs : class FileAppender extends WriterAppender ------
        
      
        
        // 構造方法，使用一個Layout對象和日志文件名構造一個FileAppender對象 :.
        
        public FileAppender(Layout layout, String filename)
            throws IOException;
        public FileAppender(Layout layout, String filename, boolean append)
            throws IOException;
      

可以使用FileAppender的子類RollingFileAppender對象，把日志輸出到一個指定的日志文件中。不同的是該日志文件的大小受到限制，當日志內容超出最大的尺寸時，該文件將向上滾動（最老的日志被擦除）。還可以在該類對象中指定為日志文件做多少個備份。具體使用方法參考如下API :.

        

        ------ Log4j APIs : class RollingFileAppender extends FileAppender ------
        
      
        
        // 構造方法，使用一個Layout對象和日志文件名構造一個RollingFileAppender對象 :.
        
        public RollingFileAppender(Layout layout, String filename)
            throws IOException;
        public RollingFileAppender(Layout layout, String filename, boolean append)
            throws IOException;
        
        // 獲得和設置日志備份文件的個數 :.
        
        public int getMaxBackupIndex();
        public void setMaxBackupIndex(int index);
        
        // 獲得和設置滾動日志文件的最大尺寸 :.
        
        public long getMaximumFileSize();
        public void setMaximumFileSize(long size);
      

PatternLayout是Layout的一個子類，用來使用類似C語言的printf函數中使用的格式控制字符串來控制日志的輸出格式。使用方法參考如下API :.

        

        ------ Log4j APIs : class PatternLayout extends Layout ------
        
      
        
        // 無參數構造方法，使用DEFAULT_CONVERSION_PATTERN構造一個PatternLayout :.
        // 注意：DEFAULT_CONVERSION_PATTERN為"%m%n"，只打印消息信息 :.
        
        public PatternLayout();
        
        // 構造方法，使用自定義的pattern構造一個PatternLayout :.
        
        public PatternLayout(String pattern);
        
        // 獲得和設置PatternLayout對象的日志pattern :.
        
        public String getConversionPattern();
        public void setConversionPattern(String pattern);
      

未完待續

Logger類的靜態初始化塊(static initialization block)中對log4j的環境做默認的初始化。注意：如果程序員已經通過設置系統屬性的方法來配置了log4j環境，則不需要再顯式地調用XXXConfigurator.configure()方法來配置log4j環境了。

Logger的靜態初始化塊在完成初始化過程時將檢查一系列log4j定義的系統屬性。它所做的事情如下：

1. 檢查系統屬性log4j.defaultInitOverride，如果該屬性被設置為false，則執行初始化；否則（只要不是false，無論是什么值，甚至沒有值，都是否則），跳過初始化。
2. 把系統屬性log4j.configuration的值賦給變量resource。如果該系統變量沒有被定義，則把resource賦值為"log4j.properties"。注意：在apache的log4j文檔中建議使用定義log4j.configuration系統屬性的方法來設置默認的初始化文件是一個好方法。
3. 試圖把resource變量轉化成為一個URL對象url。如果一般的轉化方法行不通，就調用org.apache.log4j.helpers.Loader.getResource(resource, Logger.class)方法來完成轉化。
4. 如果url以".html"結尾，則調用方法DOMConfigurator.configure(url)來完成初始化；否則，則調用方法PropertyConfigurator.configure(url)來完成初始化。如果url指定的資源不能被獲得，則跳出初始化過程。

BasicConfigurator.configure()方法使用最簡的方法配置log4j環境。注：所謂配置log4j環境，就是指配置root logger，因為所有其它的logger都是root logger的后代，所以它們（默認情況下）都將繼承root logger的性質。

BasicConfigurator.configure()完成的任務是：

1. 用默認pattern創建PatternLayout對象p：
   PatternLayout p = new PatternLayout("%-4r[%t]%-5p%c%x - %m%n");
2. 用p創建ConsoleAppender對象a，目標是system.out，標準輸出設備：
   ConsoleAppender a = new ConsoleAppender(p,ConsoleAppender.SYSTEM_OUT);
3. 為root logger增加一個ConsoleAppender p：
   rootLogger.addAppender(p);
4. 把root logger的log level設置為DEBUG級別：
   rootLogger.setLevel(Level.DEBUG);

xml格式的log4j配置文件需要使用org.apache.log4j.html.DOMConfigurator.configure()方法來讀入。對xml文件的語法定義可以在log4j的發布包中找到：org/apache/log4j/xml/log4j.dtd。

          xml declaration and dtd
            |
          log4j:configuration
            |
            +-- appender (name, class)
            |     |
            |     +-- param (name, value)
            |     +-- layout (class)
            |           |
            |           +-- param (name, value)
            +-- logger (name, additivity)
            |     |
            |     +-- level (class, value)
            |     |     |
            |     |     +-- param (name, value)
            |     +-- appender-ref (ref)
            +-- root
                  |
                  +-- param (name, class)
                  +-- level
                  |     |
                  |     +-- param (name, value)
                  +-- appender-ref (ref)  
        

          <?xml version="1.0" encoding="UTF-8" ?>
          <!DOCTYPE log4j:configuration SYSTEM "log4j.dtd">
        

創建不同的Appender對象或者不同的Layout對象要調用不同的構造方法。可以使用param子元素來設定不同的參數值。

          ... ... ... ...
          <appender name="console.log" class="org.apache.log4j.ConsoleAppender">
            <layout ... >
              ... ...
            </layout>
          </appender>
          ... ... ... ...
        

          ... ... ... ...
          <appender name="file.log" class="org.apache.log4j.FileAppender">
            <param name="File" value="/tmp/log.txt" />
            <param name="Append" value="false" />
            <layout ... >
              ... ...
            </layout>
          </appender>
          ... ... ... ...
        

          ... ... ... ...
          <appender name="rollingFile.log" class="org.apache.log4j.RollingFileAppender">
            <param name="File" value="/tmp/rollingLog.txt" />
            <param name="Append" value="false" />
            <param name="MaxBackupIndex" value="2" />
            <param name="MaxFileSize" value="1024" />
            <layout ... >
              ... ...
            </layout>
          </appender>
          ... ... ... ...
        

          ... ... ... ...
          <layout class="org.apache.log4j.PatternLayout>
            <param name="Conversion" value="%d [%t] %p - %m%n" />
          </layout>
          ... ... ... ...
        

為WSOTA項目開發java web start的胖客戶端時，使用了如下的xml文件配置log4j環境（文件名為wsota-rc.log4j.html）：:.

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE log4j:configuration SYSTEM "log4j.dtd">

<log4j:configuration xmlns:log4j="http://jakarta.apache.org/log4j/">
  
  <!-- ================================================================= -->
  <!--                     a rolling file appender                       -->
  <!-- ================================================================= -->
  
  <appender name="wsota-rc.file.log" class="org.apache.log4j.RollingFileAppender">
    <param name="File" value="/tmp/wsota-rc.log" />
    <param name="Append" value="false" />
    <layout class="org.apache.log4j.PatternLayout">
      <param name="ConversionPattern" value="%d [%t] %p - %m%n" />
    </layout>
  </appender>
  
  <!-- ================================================================= -->
  <!--                       a console appender                          -->
  <!--     debug can be turned off by setting level of root to "off"     -->
  <!-- ================================================================= -->
  
  <appender name="wsota-rc.console.log" class="org.apache.log4j.ConsoleAppender">
    <layout class="org.apache.log4j.PatternLayout">
      <param name="ConversionPattern" value="%d [%t] %p - %m%n" />
    </layout>
  </appender>
  
  <!--  use this to turn on debug to a rolling file. -->
  
  <root>
    <level value="debug" />
    <appender-ref ref="wsota-rc.file.log" />
  </root>
  
  <!--  use this to turn on debug to console. -->
  <!--
  <root>
    <level value="off" />
    <appender-ref ref="wsota-rc.console.log" />
  </root>
  -->
  
  
  <!--  use this to turn off debug. -->
  <!--
  <root>
    <level value="off" />
    <appender-ref ref="wsota-rc.console.log" />
  </root>
  -->
  
</log4j:configuration>
      

在胖客戶程序中使用了如下代碼來使用外部xml文件配置log4j環境，注意該代碼段位于程序的main class的靜態初始化塊中，含有以下代碼的類和xml配置文件在同一個目錄下：:.

  import org.apache.log4j.html.DOMConfigurator;
  
  public class SapFrame extends JFrame {
      static {
          DOMConfigurator.configure(SapFrame.class.getResource("wsota-rc.log4j.html"));
      }
      ... ... ... ...
  }