转:http://www.javalib.com/doc/log4j/config.htm
Log4j由三个重要的组件构成:日志信息的优先级,日志信息的输出目的地,日志信息的输出格式。日志信息的优先级从高到低有ERROR、WARN、INFO、DEBUG、FATAL,分别用来指定这条日志信息的重要程度;日志信息的输出目的地指定了日志将打印到控制台还是文件中;而输出格式则控制了日志信息的显示内容。
a、Logger:日志写出器
Logger的命名规则:
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
示例代码:
import org.apache.log4j.Logger;
import org.apache.log4j.BasicConfigurator;
import org.apache.log4j.Level;
public class Log4jTest {
public static void main(String argv[]) {
Create a logger by the name of class Log4jTest.
Logger logger = Logger.getLogger(Log4jTest.class);
// Use the default configuration.
BasicConfigurator.configure();
// Set the logger level to Level.INFO
logger.setLevel(Level.INFO);
// This request will be disabled since Level.DEBUG < Level.INFO.
logger.debug("This is debug.");
// These requests will be enabled.
logger.info("This is an info.");
logger.warn("This is a warning.");
logger.error("This is an error.");
logger.fatal("This is a fatal error.");
return;
}
}
b、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。
可以使用getAdditivity()和setAdditivity(boolean additive)获得和设置additive标志:是否继承父logger的appenders?。注意:在设置additive标志为false时,必须保证已经为该logger设置了新的appender,? 否则log4j将报错:log4j:WARN No appenders could be found for logger (x.y.z)。
ConsoleAppender:
可以使用ConsoleAppender对象把日志输出到控制台。每个ConsoleAppender都有一个target,表示它的输出目的地。它可以是System.out,标准输出设备(缓冲显示屏);或者是System.err,标准错误设备(不缓冲显示屏)。ConsoleAppender的使用方法参考如下API
//构造方法,使用一个Layout对象构造一个ConsoleAppender对象
//默认情况下,ConsoleAppender的target是System.out
public ConsoleAppender(Layout layout);
//构造方法,使用一个Layout对象和一个target字符串构造ConsoleAppender对象
//target的可能取值为ConsoleAppender.SYSTEM_OUT和ConsoleAppender.SYSTEM_ERR
public ConsoleAppender(Layout layout, String target);
FileAppender:
可以使用FileAppender对象把日志输出到一个指定的日志文件中去。使用方法可以参考如下的API
//构造方法,使用一个Layout对象和日志文件名构造一个FileAppender对象
public FileAppender(Layout layout, String filename) throws IOException;
public FileAppender(Layout layout, String filename, boolean append)?throws IOException;
RollingFileAppender:
可以使用FileAppender的子类RollingFileAppender对象,把日志输出到一个指定的日志文件中。不同的是该日志文件的大小受到限制,当日志内容超出最大的尺寸时,该文件将向上滚动(最老的日志被擦除)。还可以在该类对象中指定为日志文件做多少个备份。具体使用方法参考如下API
//构造方法,使用一个Layout对象和日志文件名构造一个RollingFileAppender对象
public RollingFileAppender(Layout layout, String filename)throws IOException;
public RollingFileAppender(Layout layout, String filename, boolean append) throws IOException;
//获得和设置日志备份文件的个数
public int getMaxBackupIndex();
public void setMaxBackupIndex(int index);
// 获得和设置滚动日志文件的最大尺寸 :.
public long getMaximumFileSize();
public void setMaximumFileSize(long size);<script src="../../../js/ad_atl.js" type="text/javascript"></script>
c、Layout:日志格式化器
每个appender都和一个layout相联系;layout的任务是格式化用户的logging request,appender的任务是把layout格式化好的输出内容送往指定的目的地。Log4j提供的布局模式有以下几种:HTMLLayout:以HTML表格形式布局;PatternLayout:可以灵活地指定布局模式;SimpleLayout:包含日志信息的级别和信息字符串。
PatternLayout:
PatternLayout是Layout的一个子类,用来使用类似C语言的printf函数中使用的格式控制字符串来控制日志的输出格式。使用方法参考如下API
//无参数构造方法,使用DEFAULT_CONVERSION_PATTERN构造一个PatternLayout
// 注意:DEFAULT_CONVERSION_PATTERN为"%m%n",只打印消息信息
public PatternLayout();
// 构造方法,使用自定义的pattern构造一个PatternLayout
public PatternLayout(String pattern);
// 获得和设置PatternLayout对象的日志pattern
public String getConversionPattern();
public void setConversionPattern(String pattern);
通过定义这个PatternLayout的值,我们可以指定输出信息的输出格式,如设置%-4r?[%t]?%-5p?%c?%x?-?%m%n。ConversionPattern参数的格式含义:
%c?输出日志信息所属的类的全名
%d?输出日志时间点的日期或时间,默认格式为ISO8601,也可以在其后指定格式,比如:%d{yyy-MM-dd?HH:mm:ss?},输出类似:2002-10-18-?22:10:28
%f?输出日志信息所属的类的类名
%l?输出日志事件的发生位置,即输出日志信息的语句处于它所在的类的第几行
%m?输出代码中指定的信息,如log(message)中的message
%n?输出一个回车换行符,Windows平台为“\r\n”,Unix平台为“\n”
%p?输出优先级,即DEBUG,INFO,WARN,ERROR,FATAL。如果是调用debug()输出的,则为DEBUG,依此类推
%r?输出自应用启动到输出该日志信息所耗费的毫秒数
%t?输出产生该日志事件的线程名
2、Log4j的配置
对log4j环境的配置就是对root logger的配置,包括把root logger设置为哪个级别(level);为它增加哪些appender,等等。这些可以通过设置系统属性的方法来隐式地完成,也可以在程序里调用XXXConfigurator.configure()方法来显式地完成。
a、默认的Log4j初始化过程
Logger类的静态初始化块中对log4j的环境做默认的初始化。注意:如果程序员已经通过设置系统属性的方法来配置了log4j环境,则不需要再显式地调用XXXConfigurator.configure()方法来配置log4j环境了。
Logger的静态初始化块在完成初始化过程时将检查一系列log4j定义的系统属性。它所做的事情如下:
- 检查系统属性log4j.defaultInitOverride,如果该属性被设置为false,则执行初始化;否则(只要不是false,无论是什么值,甚至没有值,都是否则),跳过初始化。
- 把系统属性log4j.configuration的值赋给变量resource。如果该系统变量没有被定义,则把resource赋值为"log4j.properties"。注意:在apache的log4j文档中建议使用定义log4j.configuration系统属性的方法来设置默认的初始化文件是一个好方法。
- 试图把resource变量转化成为一个URL对象url。如果一般的转化方法行不通,就调用org.apache.log4j.helpers.Loader.getResource(resource, Logger.class)方法来完成转化。
- 如果url以".html"结尾,则调用方法DOMConfigurator.configure(url)来完成初始化;否则,则调用方法PropertyConfigurator.configure(url)来完成初始化。如果url指定的资源不能被获得,则跳出初始化过程。
b、读取配置文件
有三个方法读取配置文件:
BasicConfigurator.configure (): 自动快速地使用缺省Log4j环境。
PropertyConfigurator.configure ( String configFilename) :读取使用Java的特性文件编写的配置文件。
DOMConfigurator.configure ( String filename ) :读取XML形式的配置文件。
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);