Log4j 使用学习

  首先浏览一下包：

  

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

Lo

gger的命名规则

Logger由一个String类的名字识别，logger的名字是大小写敏感的，且名字之间具有继承的关系，子名有父名作为前缀，用点号.分隔。如：x.y是x.y.z的父亲。

根logger (root logger)是所有logger的祖先，它具有如下属性：1) 它总是存在的；2) 它不可以通过名字获得。

通过调用public static Logger Logger.getRootLogger()获得root logger；通过调用public static Logger Logger.getLogger(String name)或者public static Logger Logger.getLogger(Class clazz)获得（或者创建）一个named logger。后者相当于调用Logger.getLogger(clazz.getName())。

在某对象中，用该对象所属的类为参数，调用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越优先输出 

Level类中预定义了五个level，它们的大小关系如下：

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

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。

Configuration

配置既可以在每个类里完成，又可以在web.xml 开始时设置一个监听启动，配置参数既可以在类里面调用api完成，也可以添加一个文本完成，文本既可以是xml又可以是.properties文件。

log4j的灵活性很吸引人。其中的appender既可以是local的也可以是remote的！

默认的log4j初始化过程

Logger类的静态初始化块(static initialization block)中对log4j的环境做默认的初始化。注意：如果程序员已经通过设置系统属性的方法来配置了log4j环境，则不需要再显式地调用XXXConfigurator.configure()方法来配置log4j环境了。

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)            

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

appender元素定义一个日志输出目的地。

name [#REQUIRED attribute] : 定义appender的名字，以便被后文引用 
class [#REQUIRED attribute] : 定义appender对象所属的类的全名 
param [* child] : 创建appender对象时传递给类构造方法的参数 
layout [? child] : 该appender使用的layout对象 

layout

layout元素定义与某一个appender相联系的日志格式化器。

class [#REQUIRED attribute] : 定义layout对象所属的类的全名 
param [* child] : 创建layout对象时传递给类构造方法的参数 

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] : 创建root logger对象时传递给类构造方法的参数 
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] : 创建level对象时传递给类构造方法的参数 

appender-ref

appender-ref元素引用一个appender元素的名字，为logger对象增加一个appender。

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

param

param元素在创建对象时为类的构造方法提供参数。它可以成为appender、layout、filter、errorHandler、level、categoryFactory和root等元素的子元素。

name and value [#REQUIRED attributes] : 提供参数的一组名值对 
param元素没有子元素 

下面给出一个小例子：

log4j.xml

<?xml version="1.0" encoding="GB2312" ?><!DOCTYPE log4j:configuration SYSTEM "log4j.dtd"><log4j:configuration xmlns:log4j="http://jakarta.apache.org/log4j/"><appender name="all" class="org.apache.log4j.RollingFileAppender"><!-- 设置通道ID:all和输出方式：org.apache.log4j.RollingFileAppender --><param name="File" value="src/output/all.log" /><!-- 设置File参数：日志输出文件名 --><param name="Append" value="false" /><!-- 设置是否在重新启动服务时，在原有日志的基础添加新日志 --><param name="MaxBackupIndex" value="10" /><layout class="org.apache.log4j.PatternLayout"><param name="ConversionPattern" value="%p (%c:%L)- %m%n" /><!-- 设置输出文件项目和格式 --></layout></appender><appender name="Log4App" class="org.apache.log4j.RollingFileAppender"><param name="File" value="src/output/Log4App.log" /><param name="Append" value="true" /><param name="MaxFileSize" value="10240" /> <!-- 设置文件大小 --><param name="MaxBackupIndex" value="10" /><layout class="org.apache.log4j.PatternLayout"><param name="ConversionPattern" value="%p (%c:%L)- %m%n" /></layout></appender><logger name="com.sk.log4.Log4App"> <!-- 设置域名限制，以下的日志均输出到下面对应的通道中 --><level value="info" /><!-- 设置级别 --><appender-ref ref="Log4App" /><!-- 与前面的通道id相对应 --></logger><root> <!-- 设置接收所有输出的通道 --><appender-ref ref="all" /><!-- 与前面的通道id相对应 --></root></log4j:configuration>

Log4App.java

package com.sk.log4;import org.apache.log4j.Logger;import org.apache.log4j.PropertyConfigurator;import org.apache.log4j.xml.DOMConfigurator;public class Log4App {public static void main(String[] args) {DOMConfigurator.configure("src/com/sk/log4/log4j.xml");// 加载.xml文件// PropertyConfigurator.configure("E:/study/log4j/log4j.properties");//加载.properties文件Logger log = Logger.getLogger(Log4App.class.getName());log.debug("debug");log.info("info");log.warn("warn");log.error("error");}}

运行两次，第二次更改了level

DEBUG (Log4App:13)- debug
INFO (Log4App:14)- info
WARN (Log4App:15)- warn
ERROR (Log4App:16)- error
DEBUG (com.sk.log4.Log4App:13)- debug
INFO (com.sk.log4.Log4App:14)- info
WARN (com.sk.log4.Log4App:15)- warn
ERROR (com.sk.log4.Log4App:16)- error
INFO (com.sk.log4.Log4App:14)- info
WARN (com.sk.log4.Log4App:15)- warn
ERROR (com.sk.log4.Log4App:16)- error