Log4j的类图
日志记录器（Logger）只输出那些级别高于或等于它的级别的信息。如果没有设置日志记录器（Logger）的级别，那么它将会继承最近的祖先的级别。因此，如果在pack1.pack2包中创建一个日志记录器（Logger）并且没有设置级别，那它将会继承在包pack1中创建的日志记录器（Logger）的级别。如果在pack1中没有创建日志记录器（Logger）的话,那么在pack1中创建的日志记录器（Logger）将继承root 日志记录器（Logger）的级别，root日志记录器（Logger）经常被实例化而可用，它的默认级别为DEBUG。
Logger的级别：
Level.ALL < Level.DEBUG < Level.INFO < Level.WARN < Level.ERROR < Level.FATAL < Level.OFF
Appender（日志目的地）
每个Logger都可以拥有一个或者多个appender,每个appender表示一个日志的输出目的地，可以使用Logger.addAppender(Appender)为Logger增加一个appender，可以使用Logger.removeAppender(Appender)来为Logger移除一个appender。
默认情况下logger的additivity值为true，表示子logger将继承父Logger的所有appender，该选项可以被重置为false，表示子logger将不再继承父Logger的appender，如果一个category的additivity为false，同时没有appender-ref时将报错。
<category name="CORE" additivity="false">
<priority value="info"/>
<appender-ref ref="fileAppender"/>
</category>
在程序中Logger logger = Logger.getLogger(“CORE”);记录日志时将记录info或者info级别以上的日志信息到fileAppender。
Appender 控制日志怎样输出。下面列出一些可用的Appender(log4j API中所描述的 http://jakarta.apache.org/log4j/docs/api/index.html):
ConsoleAppender:使用用户指定的布局(layout) 输出日志事件到System.out或者 System.err。默认的目标是System.out。 ConsoleAppender appender = new ConsoleAppender(new PatternLayout());
可以使用ConsoleAppender对象把日志输出到控制台。每个ConsoleAppender都有一个target，表示它的输出目的地。它可以是System.out，标准输出设备（缓冲显示屏）；或者是System.err，标准错误设备（不缓冲显示屏）。
<appender name="consoleAppender" class="org.apache.log4j.ConsoleAppender">
<layout class="org.apache.log4j.SimpleLayout"/>
</appender>
FileAppender 把日志事件写入一个文件 appender = new FileAppender(new PatternLayout(),"filename"); FileAppender(Layout layout, String filename, boolean append)
<appender name="fileAppender" class="org.apache.log4j.FileAppender">
<param name="File" value="cyaniteCHLog.txt" />
<param name="Append" value="true" />
<layout class="org.apache.log4j.PatternLayout">
<param name="ConversionPattern" value="%d [%t] %p - %m%n" />
</layout>
</appender>
RollingFileAppender 扩展FileAppender备份容量达到一定大小的日志文件。不同的是该日志文件的大小受到限制，当日志内容超出最大的尺寸时，该文件将向上滚动（最老的日志被擦除）。还可以在该类对象中指定为日志文件做多少个备份
<appender name="rollingFileAppend"
class="org.apache.log4j.RollingFileAppender">
<param name="File" value="cyaniteCH.log" />
<param name="Append" value="true" />
<param name="MaxBackupIndex" value="2" />
<param name="MaxFileSize" value="1024" />
<layout class="org.apache.log4j.PatternLayout">
<param name="ConversionPattern" value="%d [%t] %p - %m%n" />
</layout>
</appender>
DailyRollingFileAppender 扩展FileAppender，因此多个日志文件可以以一个用户选定的频率进行循环日志记录。
WriterAppender根据用户的选择把日志事件写入到Writer或者OutputStream。 appender = new WriterAppender(new PatternLayout(),new FileOutputStream("filename"));
SMTPAppender 当特定的日志事件发生时，一般是指发生错误或者重大错误时，发送一封邮件。
SocketAppender 给远程日志服务器（通常是网络套接字节点）发送日志事件（LoggingEvent）对象。
SocketHubAppender 给远程日志服务器群组（通常是网络套接字节点）发送日志事件（LoggingEvent）对象。
SyslogAppender给远程异步日志记录的后台精灵程序(daemon)发送消息。
TelnetAppender 一个专用于向只读网络套接字发送消息的log4j appender。
还可以实现 Appender 接口，创建以自己的方式进行日志输出的Appender。
Layout
Appender必须使用一个与之相关联的 Layout，这样它才能知道怎样格式化它的输出。当前，log4j具有三种类型的Layout:
HTMLLayout 格式化日志输出为HTML表格。 HTMLLayout layout = new HTMLLayout();
PatternLayout 根据指定的 转换模式格式化日志输出，或者如果没有指定任何转换模式，就使用默认的转换模式。 %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);
SimpleLayout 以一种非常简单的方式格式化日志输出，它打印级别 Level，然后跟着一个破折号“-“ ，最后才是日志消息。SimpleLayout layout = new SimpleLayout();
Log4J采用类似C语言中的printf函数的打印格式格式化日志信息，打印参数如下： %m 输出代码中指定的消息
%p 输出优先级，即DEBUG，INFO，WARN，ERROR，FATAL
%r 输出自应用启动到输出该log信息耗费的毫秒数
%c 输出所属的类目，通常就是所在类的全名
%t 输出产生该日志事件的线程名
%n 输出一个回车换行符，Windows平台为“/r/n”，Unix平台为“/n”
%d 输出日志时间点的日期或时间，默认格式为ISO8601，也可以在其后指定格式，比如：%d{yyy MMM dd HH:mm:ss,SSS}，输出类似：
2002
年
10
月
18
日
22：10：28，921
%l 输出日志事件的发生位置，包括类目名、发生的线程，以及在代码中的行数。
Logger的初始化
BasicConfigurator.configure();
BasicConfigurator.configure()方法使用最简的方法配置log4j环境。注：所谓配置log4j环境，就是指配置root logger，因为所有其它的logger都是root logger的后代，所以它们（默认情况下）都将继承root logger的性质。
BasicConfigurator.configure()完成的任务是：
- 用默认pattern创建PatternLayout对象p：
PatternLayout p = new PatternLayout("%-4r[%t]%-5p%c%x - %m%n"); - 用p创建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);
DOMConfigurator.configure()
xml格式的log4j配置文件需要使用org.apache.log4j.xml.DOMConfigurator.configure()方法来读入。对xml文件的语法定义可以在log4j的发布包中找到：org/apache/log4j/xml/log4j.dtd。
PropertyConfigurator.configure()
读取使用Java的特性文件编写的配置文件。
log4j的xml配置文件的树状结构如下所示，下图只显示了常用的部分。
xml declaration and DTD
|
log4j:configuration
|
+-- appender (name, class)
| |
| +-- param (name, value)
| +-- layout (class)
| |
| +-- param (name, value)
+-- logger (name, additivity) | category
| |
| +-- level (class, value)
| | |
| | +-- param (name, value)
| +-- appender-ref (ref)
+-- root
|
+-- param (name, class)
+-- level
| |
| +-- param (name, value)
+-- appender-ref (ref)
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.apache.org/log4j/"
- appender [* child] : 一个appender子元素定义一个日志输出目的地
- logger [* child] : 一个logger子元素定义一个日志写出器
- root [? child] : root子元素定义了root logger
appender元素定义一个日志输出目的地。
- name [#REQUIRED attribute] : 定义appender的名字，以便被后文引用
- class [#REQUIRED attribute] : 定义appender对象所属的类的全名
- param [* child] : 创建appender对象时传递给类构造方法的参数
- layout [? child] : 该appender使用的layout对象
layout元素定义与某一个appender相联系的日志格式化器。
- class [#REQUIRED attribute] : 定义layout对象所属的类的全名
- param [* child] : 创建layout对象时传递给类构造方法的参数
logger元素定义一个日志输出器。
- name [#REQUIRED attribute] : 定义logger的名字，以便被后文引用
- additivity [#ENUM attribute] : 取值为"true"（默认）或者"false"，是否继承父logger的属性
- level [? child] : 定义该logger的日志级别
- appender-ref [* child] : 定义该logger的输出目的地
root元素定义根日志输出器root logger。
- param [* child] : 创建root logger对象时传递给类构造方法的参数
- level [? child] : 定义root logger的日志级别
- appender-ref [* child] : 定义root logger的输出目的地
level元素定义logger对象的日志级别。
- class [#IMPLIED attribute] : 定义level对象所属的类，默认情况下是"org.apache.log4j.Level类
- value [#REQUIRED attribute] : 为level对象赋值。可能的取值从小到大依次为"all"、"debug"、"info"、"warn"、"error"、"fatal"和"off"。当值为"off"时表示没有任何日志信息被输出
- param [* child] : 创建level对象时传递给类构造方法的参数
appender-ref元素引用一个appender元素的名字，为logger对象增加一个appender。
- ref [#REQUIRED attribute] : 一个appender元素的名字的引用
- appender-ref元素没有子元素
param元素在创建对象时为类的构造方法提供参数。它可以成为appender、layout、filter、errorHandler、level、categoryFactory和root等元素的子元素。
- name and value [#REQUIRED attributes] : 提供参数的一组名值对
- param元素没有子元素
Log4j的编码习惯
- 让每个类都拥有一个private static的Logger对象，用来输出该类中的全部日志信息
- 使用xml文件来完成对log4j环境的配置。在项目的main class中的静态初始化块里放log4j环境的配置代码。注意：在一个项目中，log4j环境只需要被配置一次，而不是在每个使用了logger的类里都需要调用一次
- 用MyClass.class作为参数创建该类的静态Logger对象 ，这个继承RootLogger的配置
扫一扫
731
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
