Apache Log4j 學習筆記

lwj888 2007-07-31

展開全文

Apache Log4j 學習筆記

Apache Logging Project Homepage: http://logging.

Log4j的類圖

Logger - 日志寫出器，供程序員輸出日志信息
Appender - 日志目的地，把格式化好的日志信息輸出到指定的地方去
- ConsoleAppender - 目的地為控制臺的Appender
- FileAppender - 目的地為文件的Appender
- RollingFileAppender - 目的地為大小受限的文件的Appender
Layout - 日志格式化器,，用來把程序員的logging request格式化成字符串
- PatternLayout - 用指定的pattern格式化logging request的Layout

Logger：日志寫出器

Logger對象是用來取代System.out或者System.err的日志寫出器,，用來供程序員輸出日志信息。

Logger的輸出方法

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

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);

Logger的命名規(guī)則

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

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

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

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

Log level

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

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

logger的level越低,，表示該logger越詳細
logging request的level越高,，表示該logging request越優(yōu)先輸出

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

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

示例代碼

以下代碼將用自己所屬的類為參數(shù),，創(chuàng)建一個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;
    }
}

關于logger的兩點說明

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

Appender：日志目的地

每個logger都可以擁有一個或者多個appender,，每個appender表示一個日志的輸出目的地,，比如console或者某個文件?？梢? 使用Logger.addAppender(Appender app)為logger增加一個appender,；可以使用Logger.removeAppender(Appender app)為logger移除一個appender,。

默認情況下,，logger的additive標志被設置為true，表示子logger將繼承父logger的所有appenders,。該選項可以被重新設置,，表示子logger將不再繼承父logger的appenders。

root logger擁有目標為system.out的consoleAppender,，故默認情況下,，所有的logger都將繼承該appender。

// Log4j APIs : class Logger
      
// 為logger對象增加或者移除一個Appender對象
public void appAppender(Appender app);
public void removeAppender(Appender app);

// 獲得和設置additive標志：是否繼承父logger的appenders
// 注意：在設置additive標志為false時,，必須保證已經(jīng)為該logger設置了新的appender,，
// 否則log4j將報錯：log4j:WARN No appenders could be found for logger (x.y.z).
public boolean getAdditivity();
public void setAdditivity(boolean additive);

ConsoleAppender

可以使用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

可以使用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;

RollingFileAppender

可以使用FileAppender的子類RollingFileAppender對象,，把日志輸出到一個指定的日志文件中。不同的是該日志文件的大小受到限制,，當日志內(nèi)容超出最大的尺寸時,，該文件將向上滾動（最老的日志被擦除）。還可以在該類對象中指定為日志文件做多少個備份,。具體使用方法參考如下 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;

// 獲得和設置日志備份文件的個數(shù) 
public int getMaxBackupIndex();
public void setMaxBackupIndex(int index);

// 獲得和設置滾動日志文件的最大尺寸 
public long getMaximumFileSize();
public void setMaximumFileSize(long size);

Layout：日志格式化器

每個appender都和一個layout相聯(lián)系；layout的任務是格式化用戶的logging request,，appender的任務是把layout格式化好的輸出內(nèi)容送往指定的目的地,。

PatternLayout

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

// Log4j APIs : class PatternLayout extends Layout
      
// 無參數(shù)構造方法,，使用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);

patterns in PatternLayout

Fixme (heavyz)

To be added...

Configuration：配置

對log4j環(huán)境的配置就是對root logger的配置,，包括把root logger設置為哪個級別(level)；為它增加哪些appender,，等等,。這些可以通過設置系統(tǒng)屬性的方法來隱式地完成，也可以在程序里調(diào)用 XXXConfigurator.configure()方法來顯式地完成,。

默認的log4j初始化過程

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

Logger的靜態(tài)初始化塊在完成初始化過程時將檢查一系列l(wèi)og4j定義的系統(tǒng)屬性,。它所做的事情如下：

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

BasicConfigurator.configure()

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

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

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

xml格式的log4j配置文件概述

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

log4j的xml配置文件的樹狀結構

log4j的xml配置文件的樹狀結構如下所示,，注意下圖只顯示了常用的部分。

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 declaration and DTD

xml配置文件的頭部包括兩個部分：xml聲明和DTD聲明,。頭部的格式如下：

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

log4j:configuration (root element)

xmlns:log4j [#FIXED attribute] : 定義log4j的名字空間,，取定值"http://jakarta./log4j/"
appender [* child] : 一個appender子元素定義一個日志輸出目的地
logger [* child] : 一個logger子元素定義一個日志寫出器
root [? child] : root子元素定義了root logger

appender

appender元素定義一個日志輸出目的地。

name [#REQUIRED attribute] : 定義appender的名字,，以便被后文引用
class [#REQUIRED attribute] : 定義appender對象所屬的類的全名
param [* child] : 創(chuàng)建appender對象時傳遞給類構造方法的參數(shù)
layout [? child] : 該appender使用的layout對象

layout

layout元素定義與某一個appender相聯(lián)系的日志格式化器,。

class [#REQUIRED attribute] : 定義layout對象所屬的類的全名
param [* child] : 創(chuàng)建layout對象時傳遞給類構造方法的參數(shù)

logger

logger元素定義一個日志輸出器,。

name [#REQUIRED attribute] : 定義logger的名字,，以便被后文引用
additivity [#ENUM attribute] : 取值為"true"（默認）或者"false"，是否繼承父logger的屬性
level [? child] : 定義該logger的日志級別
appender-ref [* child] : 定義該logger的輸出目的地

root

root元素定義根日志輸出器root logger,。

param [* child] : 創(chuàng)建root logger對象時傳遞給類構造方法的參數(shù)
level [? child] : 定義root logger的日志級別
appender-ref [* child] : 定義root logger的輸出目的地

level

level元素定義logger對象的日志級別,。

class [#IMPLIED attribute] : 定義level對象所屬的類，默認情況下是"org.apache.log4j.Level類
value [#REQUIRED attribute] : 為level對象賦值,?？赡艿娜≈祻男〉酱笠来螢?all",、"debug"、"info",、"warn",、"error"、"fatal"和"off",。當值為"off"時表示沒有任何日志信息被輸出
param [* child] : 創(chuàng)建level對象時傳遞給類構造方法的參數(shù)

appender-ref

appender-ref元素引用一個appender元素的名字,，為logger對象增加一個appender。

ref [#REQUIRED attribute] : 一個appender元素的名字的引用
appender-ref元素沒有子元素

param

param元素在創(chuàng)建對象時為類的構造方法提供參數(shù),。它可以成為appender,、layout、filter,、errorHandler,、level、categoryFactory和root等元素的子元素,。

name and value [#REQUIRED attributes] : 提供參數(shù)的一組名值對
param元素沒有子元素

在xml文件中配置appender和layout

創(chuàng)建不同的Appender對象或者不同的Layout對象要調(diào)用不同的構造方法,。可以使用param子元素來設定不同的參數(shù)值,。

創(chuàng)建ConsoleAppender對象

ConsoleAppender的構造方法不接受其它的參數(shù),。

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

創(chuàng)建FileAppender對象

可以為FileAppender類的構造方法傳遞兩個參數(shù)：File表示日志文件名；Append表示如文件已存在,，是否把日志追加到文件尾部,，可能取值為"true"和"false"（默認）。

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

創(chuàng)建RollingFileAppender對象

除了File和Append以外,，還可以為RollingFileAppender類的構造方法傳遞兩個參數(shù)：MaxBackupIndex備份日志文件的個數(shù)（默認是1個）,；MaxFileSize表示日志文件允許的最大字節(jié)數(shù)（默認是10M）。

... ... ... ...
<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>
... ... ... ...

創(chuàng)建PatternLayout對象

可以為PatternLayout類的構造方法傳遞參數(shù)ConversionPattern,。

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

我自己的一個使用xml文件配置log4j環(huán)境的很簡單的例子

為WSOTA（Web Services Over The Air）項目開發(fā)java web start的胖客戶端時,，使用了如下的xml文件配置log4j環(huán)境（文件名為wsota-rc.log4j.xml）：

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

<log4j:configuration xmlns:log4j="http://jakarta./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環(huán)境，注意該代碼段位于程序的main class的靜態(tài)初始化塊中,，含有以下代碼的類和xml配置文件在同一個目錄下：

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

Log4j的編碼習慣

讓每個類都擁有一個private static的Logger對象,，用來輸出該類中的全部日志信息
使用xml文件來完成對log4j環(huán)境的配置。在項目的main class中的靜態(tài)初始化塊里放log4j環(huán)境的配置代碼,。注意：在一個項目中,，log4j環(huán)境只需要被配置一次，而不是在每個使用了logger的類里都需要調(diào)用一次
用MyClass.class作為參數(shù)創(chuàng)建該類的靜態(tài)Logger對象

Fixme (heavyz)

To add more...

參考資料

Log4j主頁上的相關文檔：http://jakarta./log4j/docs
Ashley J.S Mills的log4j教程：http://supportweb.cs./documentation/tutorials/docsystem/build/tutorials/log4j/log4j.html

本站是提供個人知識管理的網(wǎng)絡存儲空間,，所有內(nèi)容均由用戶發(fā)布,，不代表本站觀點。請注意甄別內(nèi)容中的聯(lián)系方式、誘導購買等信息,，謹防詐騙,。如發(fā)現(xiàn)有害或侵權內(nèi)容，請點擊一鍵舉報,。

久久国产成人av_抖音国产毛片_a片网站免费观看_A片无码播放手机在线观看,色五月在线观看,亚洲精品m在线观看,女人自慰的免费网址,悠悠在线观看精品视频,一级日本片免费的,亚洲精品久,国产精品成人久久久久久久

Apache Log4j 學習筆記

Apache Log4j 學習筆記

Log4j的類圖

Logger：日志寫出器

Logger的輸出方法

Logger的命名規(guī)則

Log level

示例代碼

關于logger的兩點說明

Appender：日志目的地

ConsoleAppender

FileAppender

RollingFileAppender

Layout：日志格式化器

PatternLayout

patterns in PatternLayout

Configuration：配置

默認的log4j初始化過程

BasicConfigurator.configure()

xml格式的log4j配置文件概述

log4j的xml配置文件的樹狀結構

xml declaration and DTD

log4j:configuration (root element)

appender

layout

logger

root

level

appender-ref

param

在xml文件中配置appender和layout

創(chuàng)建ConsoleAppender對象

創(chuàng)建FileAppender對象

創(chuàng)建RollingFileAppender對象

創(chuàng)建PatternLayout對象

我自己的一個使用xml文件配置log4j環(huán)境的很簡單的例子

Log4j的編碼習慣

參考資料