log4j Tutorials

Pudgy's World — Thu, 18 Aug 2005 08:58:00 GMT

1. ��?/a>

2. 安装

3. log4j基本概念

3.1. Logger

3.2. Appender

3.2.1. 使用ConsoleAppender
3.2.2. 使用FileAppender
3.2.3. 使用WriterAppender

3.3. Layout

3.4. 基本�C�Z��

3.4.1. SimpleLayout和FileAppender
3.4.2. HTMLLayout和WriterAppender
3.4.3. PatternLayout和ConsoleAppender

4. 使用外部配置文�g

5. 参考资�?(以及一些有参考�h值的链接)

1.��?/a>

�E? 序开发环境中的日志记录是由嵌入在�E�序中以输出一些对开发�h员有用信息的语句所�l�成。例如，跟踪语句�Q�trace�Q�，�l�构转储和常见的 System.out.println或printf调试语句。log4j提供分��Ҏ��在程序中嵌入日志记录语句。日志信息具有多�U�输出格式和多个输出�U? 别�?

�? 用一个专门的日志记录包，可以减轻�Ҏ��千上万的System.out.println语句的维护成本，因�ؓ日志记录可以通过配置脚本在运行时得以控制�? log4j�l�护嵌入在程序代码中的日志记录语句。通过规范日志记录的处理过�E�，一些�h认�ؓ应该鼓励更多的��用日志记录�ƈ且获得更高程度的效率�?

2.安装

��Z��使用我们卛_��要安装的日志记录工具�Q�还必须要设�|�操作环境，只有�q�样�Q�工��h��能知道从哪里扑ֈ�它所需要的信息�Q��ƈ且操作系�l�知道从哪里扑ֈ��q�个工具。那么，怎样做呢�Q�实际上�Q�它要求更改操作环境。我有一些这斚w��的资格文档�?Configuring A Windows Working Environment �?Configuring A Unix Working Environment.

�?http://jakarta.apache.org/log4j/docs/download.html下蝲log4j发行版�?
解压存档文�g到合适的目录中�?/p>
��d��文�g dist/lib/log4j-1.2.6.jar �?CLASSPATH 环境变量中�?

3.log4j的基本概�?

使用log4j大概涉及3个主要概�?

公共�c?Logger

Logger 负责处理日志记录的大部分操作�?
公共接口 Appender

Appender 负责控制日志记录操作的输出�?
公共抽象�c�Layout

Layout 负责格式�?span class="strong">Appender的输出�?

3.1.Logger

日志记录�?Logger)是日志处理的核心�l��g。log4j��h��5�U�正常��?Level)�?日志记录�?Logger)的可用��?span class="strong">Level (不包括自定义�U�别 Level)�Q?以下内容��是摘自log4j API (http://jakarta.apache.org/log4j/docs/api/index.html):

static Level DEBUG

DEBUG Level指出�l�粒度信息事件对调试应用�E�序是非常有帮助的�?/p>
static Level INFO

INFO level表明消息在粗�_�度�U�别上突出强调应用程序的�q�行�q�程�?
static Level WARN

WARN level表明会出现潜在错误的情�Ş�?/p>
static Level ERROR

ERROR level指出虽然发生错误事�g�Q�但仍然不媄响系�l�的�l�箋�q�行�?/p>
static Level FATAL

FATAL level指出每个严重的错误事件将会导致应用程序的退出�?/p>

另外�Q�还有两个可用的特别的日志记录��? (以下描述来自log4j API http://jakarta.apache.org/log4j/docs/api/index.html):

static Level ALL

ALL Level是最低等�U�的�Q�用于打开所有日志记录�?
static Level OFF

OFF Level是最高等�U�的�Q�用于关闭所有日志记录�?

日志记录器（Logger�Q�的行�ؓ是分�{��的。如下表所�C�：

�?日志输出�{��

日志记录器（Logger�Q�将只输出那些��别高于或�{�于它的�U�别的信息。如果没有设�|�日志记录器�Q�Logger�Q�的�U�别�Q�那么它��会�l�承最�q�的��先的��别。因此，如果在包com.foo.bar中创��Z��个日志记录器�Q�Logger�Q��ƈ且没有设�|��别，那它��会�l�承在包com.foo中创建的日志记录器（Logger�Q�的�U�别。如果在com.foo中没有创建日志记录器�Q�Logger�Q�的�?那么�?span class="strong">com.foo.bar中创建的日志记录器（Logger�Q�将�l�承root 日志记录器（Logger�Q�的�U�别�Q�root日志记录器（Logger�Q�经常被实例化而可用，它的�U�别�?span class="strong">DEBUG�?

有很多方法可以创��Z��个日志记录器�Q�Logger�Q�，下面�Ҏ��可以取回root日志记录�?

Logger logger = Logger.getRootLogger();

�q�可以这样创��Z��个新的日志记录器:

Logger logger = Logger.getLogger("MyLogger");

比较常用的用法，��是�Ҏ��c�d��实例化一个静态的全局日志记录�?

static Logger logger = Logger.getLogger(test.class);

所有这些创建的�?logger"的日志记录器都可以用下面�Ҏ��讄��U�别:

logger.setLevel((Level)Level.WARN);

可以使用7个��别中的�Q何一�? Level.DEBUG, Level.INFO, Level.WARN, Level.ERROR, Level.FATAL, Level.ALL and Level.OFF.

3.2.Appender

Appender 控制日志怎样输出。下面列��Z��些可用的Appender(log4j API中所描述�?http://jakarta.apache.org/log4j/docs/api/index.html):

ConsoleAppender:使用用户指定的布局(layout) 输出日志事�g到System.out或�?System.err。默认的目标是System.out�?
DailyRollingFileAppender 扩展FileAppender�Q�因此多个日志文件可以以一个用户选定的频率进行��@环日志记录�?
FileAppender 把日志事件写入一个文�?
RollingFileAppender 扩展FileAppender备䆾定w��辑ֈ�一定大��的日志文�g�?/p>
WriterAppender�Ҏ��用户的选择把日志事件写入到Writer或者OutputStream�?
SMTPAppender 当特定的日志事�g发生�Ӟ��一般是指发生错误或者重大错误时�Q�发送一��邮件�?
SocketAppender �l�远�E�日志服务器�Q�通常是网�l�套接字节点�Q�发送日志事�Ӟ��LoggingEvent�Q�对象�?/p>
SocketHubAppender �l�远�E�日志服务器��组�Q�通常是网�l�套接字节点�Q�发送日志事�Ӟ��LoggingEvent�Q�对象�?/p>
SyslogAppender�l�远�E�异步日志记录的后台�_��E�序(daemon)发送消息�?
TelnetAppender 一个专用于向只�ȝ��l�套接字发送消息的log4j appender�?

�q�可以实�?Appender 接口�Q�创��Z��自己的方式进行日志输出的Appender�?

3.2.1.使用ConsoleAppender

ConsoleAppender可以用这�U�方式创建：

ConsoleAppender appender = new ConsoleAppender(new PatternLayout());

创徏了一个控制台appender�Q�具有一个默认的PatternLayout。它使用了默认的System.out 输出�?

3.2.2.使用FileAppender

FileAppender可以用这�U�方式创�?

          FileAppender appender = null;
          try {
             appender = new FileAppender(new PatternLayout(),"filename");
          } catch(Exception e) {}

上面用到的构造函�?

FileAppender(Layout layout, String filename) 
          实例化一个FileAppender�q�且打开变量"filename"指定的文件�?br>

另一个有用的构造函数是�Q?/a>

FileAppender(Layout layout, String filename, boolean append) 
          实例化一个FileAppender�q�且打开变量"filename"指定的文件�?br>

�q�个构造函数还可以选择是否�Ҏ��定的文�g�q�行�q�加的方式输出。如果没有指定��|��那么默认的方式就是追加�?

3.2.3.使用WriterAppender

WriterAppender可以用这�U�方式创�?

          WriterAppender appender = null;
          try {
            appender = new WriterAppender(new PatternLayout(),new FileOutputStream("filename"));
          } catch(Exception e) {}

�q�个WriterAppender使用的构造函数带有PatternLayout和OutputStream参数�Q�在�q�种情况下， FileOutputStream用于向一个文件输出。当�Ӟ��它还��h��其他可用的构造函数�?

3.3.Layout

Appender必须使用一个与之相兌��?Layout�Q�这样它才能知道怎样格式化它的输出。当前，log4j��h��三种�c�d��的Layout:

HTMLLayout 格式化日志输��ZؓHTML表格�?
PatternLayout �Ҏ��指定�?转换模式格式化日志输出，或者如果没有指定�Q何�{换模式，��׃��用默认的转换模式�?
SimpleLayout 以一�U�非常简单的方式格式化日志输出，它打印��?Level�Q�然后跟着一个破折号�?�?�Q�最后才是日志消息�?

3.4.基本�C�Z��

3.4.1.SimpleLayout�?FileAppender

�q�里是一个非常简单的例子�Q�程序实��C��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�?�q�可以查看它的输出： output1.txt.

3.4.2.HTMLLayout�?WriterAppender

�q�里是一个非常简单的例子�Q�程序实��C�� 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. �q�可以查看它的输出：output1.txt.

3.4.3.PatternLayout�?ConsoleAppender

�q�里是一个非常简单的例子�Q�程序实��C��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. �q�可以查看它的输出： output2.txt.

4.使用外部配置文�g

Log4j�l�常与外部日志文件联合��用，�q�样很多可选项不必��编码在软�g中。��用外部配�|�文件的优点��是修改可选项不需要重新编译程序。唯一的缺点就是，�׃��用到io 指��o�Q�速度�E�微有些减慢�?

有两个方法可以用来指定外部配�|�文�Ӟ��文本文�g或者XML文�g。既然现在所有事情都写成XML文�g�Q�那么该教程��重点讲解XML文�g�Ҏ��Q�但是也包含相关文本文�g的例子。首先，看看下面的XML配置文�g�C�Z��Q?/a>

文�g以标准的XML声明作�ؓ开始，后面跟着指出DTD�Q�文档类型定义）的DOCTYPE声明�Q�它定义了XML文�g的结构，例如�Q�什么元素可以嵌入在其他元素中等�{�。上面文件在log4j发行版的src/java/org/apache/log4j/xml目录中�?接着看看��装所有元素的 log4j:configuration 元素�Q�它在DOCTYPE声明中被指定为根元素。嵌入在根元素中有两个结构：

�q�里创徏一个名�?ConsoleAppender"�?Appender�Q�注意，你可以选择��M��名字�Q�该�C�Z��之所以选择"ConsoleAppender"�Q�完全是��Z��C�Z��的设计。接着�q�个appender�c�M��全名形式�l�出�Q�经常用规范�Q�fully qualified�Q�类名�?Appender必须��h��一个指定的 name�?span class="emphasis">class。嵌入在 Appender之内的是 layout元素�Q�这里它被指定�ؓSimpleLayout�?Layout 必须��h��一�?class属性�?

root元素必须存在且不能被子类化。示例中的优先��被设�|��ؓ"debug"�Q�设�|�appender饱含一�?span class="emphasis">appender-ref元素。还有更多的属性或元素可以指定。查看log4j发行版中的src/java/org/apache/log4j/xml/log4j.dtd以了解关于XML配置文�g�l�构的更多信息。可以用下面�q�种�Ҏ��把配�|�信息文件读入到Java�E�序�?

DOMConfigurator.configure("configurationfile.xml");

DOMConfigurator 用一��DOM树来初始化log4j环境。这里是�C�Z��中的XML配置文�g�Q?/a>plainlog4jconfig.xml。这里是执行该配�|�文件的�E�序: 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");
   }
}

�q�里是一个实现带�?span class="emphasis">PatternLayout�?span class="emphasis">FileAppender的日志记录器Logger的XML配置文�g:

你可以从�q�里下蝲�C�Z��: xmllog4jconfig2.xml�?惌��得到更多的��用XML文�g配置log4j环境的例子，��h��看log4j发行版的目录src/java/org/apache/log4j/xml/examples/ �?

�q�就是上面讨论的文本文�g形式的配�|�文�?

# 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。这��是执行该配�|�文件的�E�序:

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

你可以下载��用该配置文�g的示例： externalplaintest.java。想要获得更多的使用文本文�g配置log4j环境的例子，��h��看log4j发行版中的目录examples�?

使用外部配置文�g的例子就��单的讨论到这里，现在应该可以肯定你已�l�有能力独立学习更多的log4j发行版和��试版中提供的例子�?/p>

5.参考资�?(以及一些有参考�h值的链接)

http://jakarta.apache.org/log4j/docs/manual.html

log4j的简明介�l?- Ceki G- 2002�q?�?/p>
http://www.vipan.com/htdocs/log4jhelp.html

不要用System.out.println�Q�用Log4j - Vipan Singla
http://www.opensymphony.com/guidelines/logging.jsp

LOG4J / OpenSymphony日志记录入门
http://builder.com.com/article.jhtml?id=u00820020124kev01.htm

�l�你的Java应用�E�序��d��日志记录 - Kevin Brown

Pudgy's World 2005-08-18 16:58 发表评论

色偷偷亚洲男人天堂,亚洲国产成人久久精品影视,亚洲福利视频一区二区

log4j Tutorials