日志記錄器(Logger)將只輸出那些級別高于或等于它的級別的信息。如果沒有設置日志記錄器(Logger)的級別,那么它將會繼承最近的祖先的級別。因此,如果在包com.foo.bar中創建一個日志記錄器(Logger)并且沒有設置級別,那它將會繼承在包com.foo中創建的日志記錄器(Logger)的級別。如果在com.foo中沒有創建日志記錄器(Logger)的話,那么在com.foo.bar中創建的日志記錄器(Logger)將繼承root 日志記錄器(Logger)的級別,root日志記錄器(Logger)經常被實例化而可用,它的級別為DEBUG。
有很多方法可以創建一個日志記錄器(Logger),下面方法可以取回root日志記錄器:
Logger logger = Logger.getRootLogger();
還可以這樣創建一個新的日志記錄器:
Logger logger = Logger.getLogger("MyLogger");
比較常用的用法,就是根據類名實例化一個靜態的全局日志記錄器:
static Logger logger = Logger.getLogger(test.class);
所有這些創建的叫"logger"的日志記錄器都可以用下面方法設置級別:
logger.setLevel((Level)Level.WARN);
可以使用7個級別中的任何一個; Level.DEBUG, Level.INFO, Level.WARN, Level.ERROR, Level.FATAL, Level.ALL and Level.OFF.
3.2.Appender
Appender 控制日志怎樣輸出。下面列出一些可用的Appender(log4j API中所描述的 http://jakarta.apache.org/log4j/docs/api/index.html):
ConsoleAppender:使用用戶指定的布局(layout) 輸出日志事件到System.out或者 System.err。默認的目標是System.out。
DailyRollingFileAppender 擴展FileAppender,因此多個日志文件可以以一個用戶選定的頻率進行循環日志記錄。
FileAppender 把日志事件寫入一個文件
RollingFileAppender 擴展FileAppender備份容量達到一定大小的日志文件。
WriterAppender根據用戶的選擇把日志事件寫入到Writer或者OutputStream。
SMTPAppender 當特定的日志事件發生時,一般是指發生錯誤或者重大錯誤時,發送一封郵件。
SocketAppender 給遠程日志服務器(通常是網絡套接字節點)發送日志事件(LoggingEvent)對象。
SocketHubAppender 給遠程日志服務器群組(通常是網絡套接字節點)發送日志事件(LoggingEvent)對象。
SyslogAppender給遠程異步日志記錄的后臺精靈程序(daemon)發送消息。
TelnetAppender 一個專用于向只讀網絡套接字發送消息的log4j appender。
還可以實現 Appender 接口,創建以自己的方式進行日志輸出的Appender。
3.2.1.使用ConsoleAppender
ConsoleAppender可以用這種方式創建:
ConsoleAppender appender = new ConsoleAppender(new PatternLayout());
創建了一個控制臺appender,具有一個默認的PatternLayout。它使用了默認的System.out 輸出。
3.2.2.使用FileAppender
FileAppender可以用這種方式創建:
FileAppender appender = null;
try {
appender = new FileAppender(new PatternLayout(),"filename");
} catch(Exception e) {}
上面用到的構造函數:
FileAppender(Layout layout, String filename)
實例化一個FileAppender并且打開變量"filename"指定的文件。
另一個有用的構造函數是:
FileAppender(Layout layout, String filename, boolean append)
實例化一個FileAppender并且打開變量"filename"指定的文件。
這個構造函數還可以選擇是否對指定的文件進行追加的方式輸出。如果沒有指定值,那么默認的方式就是追加。
3.2.3.使用WriterAppender
WriterAppender可以用這種方式創建:
WriterAppender appender = null;
try {
appender = new WriterAppender(new PatternLayout(),new FileOutputStream("filename"));
} catch(Exception e) {}
這個WriterAppender使用的構造函數帶有PatternLayout和OutputStream參數,在這種情況下, FileOutputStream用于向一個文件輸出。當然,它還具有其他可用的構造函數。
3.3.Layout
Appender必須使用一個與之相關聯的 Layout,這樣它才能知道怎樣格式化它的輸出。當前,log4j具有三種類型的Layout:
HTMLLayout 格式化日志輸出為HTML表格。
PatternLayout 根據指定的 轉換模式格式化日志輸出,或者如果沒有指定任何轉換模式,就使用默認的轉換模式。
SimpleLayout 以一種非常簡單的方式格式化日志輸出,它打印級別 Level,然后跟著一個破折號“-“ ,最后才是日志消息。
3.4.基本示例
3.4.1.SimpleLayout和 FileAppender
這里是一個非常簡單的例子,程序實現了SimpleLayout和FileAppender:
import org.apache.log4j.Level;
import org.apache.log4j.Logger;
import org.apache.log4j.SimpleLayout;
import org.apache.log4j.FileAppender;
public class simpandfile {
static Logger logger = Logger.getLogger(simpandfile.class);
public static void main(String args[]) {
SimpleLayout layout = new SimpleLayout();
FileAppender appender = null;
try {
appender = new FileAppender(layout,"output1.txt",false);
} catch(Exception e) {}
logger.addAppender(appender);
logger.setLevel((Level) Level.DEBUG);
logger.debug("Here is some DEBUG");
logger.info("Here is some INFO");
logger.warn("Here is some WARN");
logger.error("Here is some ERROR");
logger.fatal("Here is some FATAL");
}
}
你可以下載: simpandfile.java。 還可以查看它的輸出: output1.txt.
3.4.2.HTMLLayout和 WriterAppender
這里是一個非常簡單的例子,程序實現了 HTMLLayout和WriterAppender:
import java.io.*;
import org.apache.log4j.Level;
import org.apache.log4j.Logger;
import org.apache.log4j.HTMLLayout;
import org.apache.log4j.WriterAppender;
public class htmlandwrite {
static Logger logger = Logger.getLogger(htmlandwrite.class);
public static void main(String args[]) {
HTMLLayout layout = new HTMLLayout();
WriterAppender appender = null;
try {
FileOutputStream output = new FileOutputStream("output2.html");
appender = new WriterAppender(layout,output);
} catch(Exception e) {}
logger.addAppender(appender);
logger.setLevel((Level) Level.DEBUG);
logger.debug("Here is some DEBUG");
logger.info("Here is some INFO");
logger.warn("Here is some WARN");
logger.error("Here is some ERROR");
logger.fatal("Here is some FATAL");
}
}
你可以下載: simpandfile.java. 還可以查看它的輸出:output1.txt.
3.4.3.PatternLayout和 ConsoleAppender
這里是一個非常簡單的例子,程序實現了PatternLayout和ConsoleAppender:
import org.apache.log4j.Level;
import org.apache.log4j.Logger;
import org.apache.log4j.PatternLayout;
import org.apache.log4j.ConsoleAppender;
public class consandpatt {
static Logger logger = Logger.getLogger(consandpatt.class);
public static void main(String args[]) {
// Note, %n is newline
String pattern = "Milliseconds since program start: %r %n";
pattern += "Classname of caller: %C %n";
pattern += "Date in ISO8601 format: %d{ISO8601} %n";
pattern += "Location of log event: %l %n";
pattern += "Message: %m %n %n";
PatternLayout layout = new PatternLayout(pattern);
ConsoleAppender appender = new ConsoleAppender(layout);
logger.addAppender(appender);
logger.setLevel((Level) Level.DEBUG);
logger.debug("Here is some DEBUG");
logger.info("Here is some INFO");
logger.warn("Here is some WARN");
logger.error("Here is some ERROR");
logger.fatal("Here is some FATAL");
}
}
你可以下載:simpandfile.java. 還可以查看它的輸出: output2.txt.
4.使用外部配置文件
Log4j經常與外部日志文件聯合使用,這樣很多可選項不必硬編碼在軟件中。使用外部配置文件的優點就是修改可選項不需要重新編譯程序。唯一的缺點就是,由于用到io 指令,速度稍微有些減慢。
有兩個方法可以用來指定外部配置文件:文本文件或者XML文件。既然現在所有事情都寫成XML文件,那么該教程就重點講解XML文件方法,但是也包含相關文本文件的例子。首先,看看下面的XML配置文件示例:
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE log4j:configuration SYSTEM "log4j.dtd">
<log4j:configuration xmlns:log4j="http://jakarta.apache.org/log4j/">
<appender name="ConsoleAppender" class="org.apache.log4j.ConsoleAppender">
<layout class="org.apache.log4j.SimpleLayout"/>
</appender>
<root>
<priority value ="debug" />
<appender-ref ref="ConsoleAppender"/>
</root>
</log4j:configuration>
文件以標準的XML聲明作為開始,后面跟著指出DTD(文檔類型定義)的DOCTYPE聲明,它定義了XML文件的結構,例如,什么元素可以嵌入在其他元素中等等。上面文件在log4j發行版的src/java/org/apache/log4j/xml目錄中。 接著看看封裝所有元素的 log4j:configuration 元素,它在DOCTYPE聲明中被指定為根元素。嵌入在根元素中有兩個結構:
<appender name="ConsoleAppender" class="org.apache.log4j.ConsoleAppender">
<layout class="org.apache.log4j.SimpleLayout"/>
</appender>
這里創建一個名叫"ConsoleAppender"的 Appender,注意,你可以選擇任何名字,該示例之所以選擇"ConsoleAppender",完全是為了示例的設計。接著這個appender類以全名形式給出,經常用規范(fully qualified)類名。 Appender必須具有一個指定的 name和class。嵌入在 Appender之內的是 layout元素,這里它被指定為SimpleLayout。 Layout 必須具有一個 class屬性。
<root>
<priority value ="debug" />
<appender-ref ref="ConsoleAppender"/>
</root>
root元素必須存在且不能被子類化。示例中的優先級被設置為"debug",設置appender飽含一個appender-ref元素。還有更多的屬性或元素可以指定。查看log4j發行版中的src/java/org/apache/log4j/xml/log4j.dtd以了解關于XML配置文件結構的更多信息。可以用下面這種方法把配置信息文件讀入到Java程序中:
DOMConfigurator.configure("configurationfile.xml");
DOMConfigurator 用一棵DOM樹來初始化log4j環境。這里是示例中的XML配置文件:plainlog4jconfig.xml。這里是執行該配置文件的程序: files/externalxmltest.java:
import org.apache.log4j.Logger;
import org.apache.log4j.xml.DOMConfigurator;
public class externalxmltest {
static Logger logger = Logger.getLogger(filetest.class);
public static void main(String args[]) {
DOMConfigurator.configure("xmllog4jconfig.xml");
logger.debug("Here is some DEBUG");
logger.info("Here is some INFO");
logger.warn("Here is some WARN");
logger.error("Here is some ERROR");
logger.fatal("Here is some FATAL");
}
}
這里是一個實現帶有PatternLayout的FileAppender的日志記錄器Logger的XML配置文件:
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE log4j:configuration SYSTEM "log4j.dtd">
<log4j:configuration xmlns:log4j="http://jakarta.apache.org/log4j/">
<appender name="appender" class="org.apache.log4j.FileAppender">
<param name="File" value="Indentify-Log.txt"/>
<param name="Append" value="false"/>
<layout class="org.apache.log4j.PatternLayout">
<param name="ConversionPattern" value="%d [%t] %p - %m%n"/>
</layout>
</appender>
<root>
<priority value ="debug"/>
<appender-ref ref="appender"/>
</root>
</log4j:configuration>
你可以從這里下載示例: xmllog4jconfig2.xml。 想要得到更多的使用XML文件配置log4j環境的例子,請查看log4j發行版的目錄src/java/org/apache/log4j/xml/examples/ 。
這就是上面討論的文本文件形式的配置文件:
# initialise root logger with level DEBUG and call it BLAH
log4j.rootLogger=DEBUG, BLAH
# add a ConsoleAppender to the logger BLAH
log4j.appender.BLAH=org.apache.log4j.ConsoleAppender
# set set that layout to be SimpleLayout
log4j.appender.BLAH.layout=org.apache.log4j.SimpleLayout
從這里可以下載: plainlog4jconfig.txt。這就是執行該配置文件的程序:
import org.apache.log4j.Logger;
import org.apache.log4j.PropertyConfigurator;
public class externalplaintest {
static Logger logger = Logger.getLogger(externalplaintest.class);
public static void main(String args[]) {
PropertyConfigurator.configure("plainlog4jconfig.xml");
logger.debug("Here is some DEBUG");
logger.info("Here is some INFO");
logger.warn("Here is some WARN");
logger.error("Here is some ERROR");
logger.fatal("Here is some FATAL");
}
}
你可以下載使用該配置文件的示例: externalplaintest.java。想要獲得更多的使用文本文件配置log4j環境的例子,請查看log4j發行版中的目錄examples。
使用外部配置文件的例子就簡單的討論到這里,現在應該可以肯定你已經有能力獨立學習更多的log4j發行版和測試版中提供的例子。