Apache Log4j 学习笔记

zhouandtao

ApacheLogging Project Homepage: http://logging.apache.org
Log4j的类图

      

• Logger- 日志写出器，供程序员输出日志信息
  
• Appender- 日志目的地，把格式化好的日志信息输出到指定的地方去
  
  
  
  • ConsoleAppender- 目的地为控制台的Appender
    
  • FileAppender- 目的地为文件的Appender
    
  • RollingFileAppender- 目的地为大小受限的文件的Appender
    
  
  
• Layout- 日志格式化器，用来把程序员的loggingrequest格式化成字符串
  
  
  
  • PatternLayout- 用指定的pattern格式化loggingrequest的Layout
    
  
  

Logger：日志写出器
Logger对象是用来取代System.out或者System.err的日志写出器，用来供程序员输出日志信息。
Logger的输出方法
Logger类对象提供一系列方法供程序员输出日志信息：

• publicvoid debug(Object msg);
  
• publicvoid debug(Object msg, Throwable t);
  
• publicvoid info(Object msg);
  
• publicvoid info(Object msg, Throwable t);
  
• publicvoid warn(Object msg);
  
• publicvoid warn(Object msg, Throwable t);
  
• publicvoid error(Object msg);
  
• publicvoid error(Object msg, Throwable t);
  
• publicvoid fatal(Object msg);
  
• publicvoid fatal(Object msg, Throwable t);
  

Logger的命名规则
Logger由一个String类的名字识别，logger的名字是大小写敏感的，且名字之间具有继承的关系，子名有父名作为前缀，用点号.分隔。如：x.y是x.y.z的父亲。
根logger(root logger)是所有logger的祖先，它具有如下属性：1)它总是存在的；2)它不可以通过名字获得。
通过调用publicstatic Logger Logger.getRootLogger()获得rootlogger；通过调用publicstatic Logger Logger.getLogger(String name)或者publicstatic Logger Logger.getLogger(Class clazz)获得（或者创建）一个namedlogger。后者相当于调用Logger.getLogger(clazz.getName())。
在某对象中，用该对象所属的类为参数，调用Logger.getLogger(Classclazz)以获得logger被认为是目前所知的最理智的命名logger的方法。
Loglevel
每个logger都被分配了一个日志级别(loglevel)，用来控制日志信息的输出。未被分配level的logger将继承它最近的父logger的level。
每条输出到logger的日志请求(loggingrequest)也都有一个level，如果该request的level大于等于该logger的level，则该request将被处理（称为enabled）；否则该request将被忽略。故可得知：

• logger的level越低，表示该logger越详细
  
• loggingrequest的level越高，表示该loggingrequest越优先输出
  

Level类中预定义了五个level，它们的大小关系如下：
Level.ALL< Level.DEBUG < Level.INFO < Level.WARN < Level.ERROR


...... ... ...
我自己的一个使用xml文件配置log4j环境的很简单的例子
为WSOTA（WebServices Over The Air）项目开发javaweb start的胖客户端时，使用了如下的xml文件配置log4j环境（文件名为wsota-rc.log4j.xml）：







































































在胖客户程序中使用了如下代码来使用外部xml文件配置log4j环境，注意该代码段位于程序的mainclass的静态初始化块中，含有以下代码的类和xml配置文件在同一个目录下：
importorg.apache.log4j.xml.DOMConfigurator;
publicclass SapFrame extends JFrame {
static{
DOMConfigurator.configure(SapFrame.class.getResource("wsota-rc.log4j.xml"));
}
...... ... ...
}
Log4j的编码习惯

• 让每个类都拥有一个privatestatic的Logger对象，用来输出该类中的全部日志信息
  
• 使用xml文件来完成对log4j环境的配置。在项目的mainclass中的静态初始化块里放log4j环境的配置代码。注意：在一个项目中，log4j环境只需要被配置一次，而不是在每个使用了logger的类里都需要调用一次
  
• 用MyClass.class作为参数创建该类的静态Logger对象
  

Fixme(heavyz)
Toadd more...
参考资料

• Log4j主页上的相关文档：http://jakarta.apache.org/log4j/docs
  
• AshleyJ.SMills的log4j教程：http://supportweb.cs.bham.ac.uk/documentation/tutorials/docsystem/build/tutorials/log4j/log4j.html