log4j详解

一、定义配置文件

Log4j支持两种配置文件格式，一种是XML格式的文件，一种是Java特性文件log4j.properties（键=值）。下面将介绍使用log4j.properties文件作为配置文件的方法:

1、配置根Logger　　

Logger 负责处理日志记录的大部分操作。 　　

其语法为：　　log4j.rootLogger = [ level ] , appenderName, appenderName, …

其中，level 是日志记录的优先级，分为OFF、FATAL、ERROR、WARN、INFO、DEBUG、ALL或者自定义的级别。Log4j建议只使用四个级别，优先级从高到低分别是ERROR、WARN、INFO、DEBUG。通过在这里定义的级别，您可以控制到应用程序中相应级别的日志信息的开关。比如在这里定义了INFO级别，只有等于及高于这个级别的才进行处理，则应用程序中所有DEBUG级别的日志信息将不被打印出来。ALL:打印所有的日志，OFF：关闭所有的日志输出。 appenderName就是指定日志信息输出到哪个地方。可同时指定多个输出目的地。

2、配置日志信息输出目的地 Appender　　

Appender 负责控制日志记录操作的输出。 　　

其语法为：　　log4j.appender.appenderName = fully.qualified.name.of.appender.class 　　log4j.appender.appenderName.option1 = value1 　　… 　　log4j.appender.appenderName.optionN = valueN 　　

这里的appenderName为在1里定义的，可任意起名。　　

其中，Log4j提供的appender有以下几种： 　　

org.apache.log4j.ConsoleAppender（控制台）， 　　

org.apache.log4j.FileAppender（文件）， 　　

org.apache.log4j.DailyRollingFileAppender（每天产生一个日志文件），　　

org.apache.log4j.RollingFileAppender（文件大小到达指定尺寸的时候产生一个新的文件），可通过log4j.appender.R.MaxFileSize=100KB设置文件大小，还可通过log4j.appender.R.MaxBackupIndex=1设置为保存一个备份文件。 　　

org.apache.log4j.WriterAppender（将日志信息以流格式发送到任意指定的地方）　　

例如：log4j.appender.stdout=org.apache.log4j.ConsoleAppender　　定义一个名为stdout的输出目的地，ConsoleAppender为控制台。

3、配置日志信息的格式（布局）Layout　　

Layout 负责格式化Appender的输出。　　

其语法为：　　log4j.appender.appenderName.layout = fully.qualified.name.of.layout.class 　　log4j.appender.appenderName.layout.option1 = value1 　　… 　　log4j.appender.appenderName.layout.optionN = valueN 　　

其中，Log4j提供的layout有以下几种： 　　

org.apache.log4j.HTMLLayout（以HTML表格形式布局）， 　　

org.apache.log4j.PatternLayout（可以灵活地指定布局模式）， 　　

org.apache.log4j.SimpleLayout（包含日志信息的级别和信息字符串）， 　　

org.apache.log4j.TTCCLayout（包含日志产生的时间、线程、类别等等信息）

4、格式化日志信息

　　Log4J采用类似C语言中的printf函数的打印格式格式化日志信息，打印参数如下： 　　

%m 输出代码中指定的消息　　

%p 输出优先级，即DEBUG，INFO，WARN，ERROR，FATAL 　　

%r 输出自应用启动到输出该log信息耗费的毫秒数 　　

%c 输出所属的类目，通常就是所在类的全名 　　

%t 输出产生该日志事件的线程名 　　

%n 输出一个回车换行符，Windows平台为“rn”，Unix平台为“n” 　　

%d 输出日志时间点的日期或时间，默认格式为ISO8601，也可以在其后指定格式，

比如：%d{yyyy MMM dd HH:mm:ss,SSS}，输出类似：2002年10月18日 22：10：28，921 　　

%l 输出日志事件的发生位置，包括类目名、发生的线程，以及在代码中的行数。

二、如何应用记录器的层次　　

1、　如果定义及获取不同层次的记录器　　任何一个记录器的使用都有两个步骤：　　

         1) 在配置文件中定义相应的记录器。　　

             在配置文件中定义记录器的格式有两种　　

             a、定义根记录器的格式为　　log4j.rootLogger = [ level ], appendName1, appendName2, …appendNameN　　

             b、 定义一个非根记录器的格式为　　

                   log4j.logger.loggerName1 = [ level ], appendName1,…appendNameN　　

                   ……　　log4j.logger.loggerNameM = [ level ], appendName1, …appendNameN　　我们可以定义任意个非根记录器。　　

         2) 在代码中调用Logger类的取得记录器方法取得相应的记录器对象。　　

             要取得根记录器对象可通过Logger.getRootLogger()函数，要取得非根记录器可通过Logger.getLogger()函数。

三、例子：

#1区
#### Use two appenders, one to log to console, another to log to a file
log4j.rootLogger = debug, stdout

#2区
#Print only messages of priority WARN or higher for your category
log4j.logger.TestLog4j= , R
log4j.logger.TestLog4j.TestLog4j2=WARN

#3区
#### First appender writes to console
log4j.appender.stdout=org.apache.log4j.ConsoleAppender
log4j.appender.stdout.layout=org.apache.log4j.PatternLayout
# Pattern to output the caller's file name and line number.
log4j.appender.stdout.layout.ConversionPattern=%5p [%t] (%F:%L) - %m%n

#4区
#### Second appender writes to a file
log4j.appender.R=org.apache.log4j.RollingFileAppender
log4j.appender.R.File=D:\\example.log
# Control the maximum log file size
log4j.appender.R.MaxFileSize=100KB
# Archive log files (one backup file here)
log4j.appender.R.MaxBackupIndex=1
log4j.appender.R.layout=org.apache.log4j.PatternLayout
log4j.appender.R.layout.ConversionPattern=%d{yyyy-MM-dd hh:mm:ss}:%p %t %c - %m%n

1、在1区中定义了一个根记录器。这个根记录器具有DEBUG级别并有一个名称为stdout的输出端appender。　　

2、 2区中的内容是这一节的重点，也是应用到记录器层次的地方，但其实也只有两句，充分体现了log4j的简单性。

       在这里，我们定义了两个名称分别为TestLog4j和TestLog4j.TestLog4j2设计器。　　

       在定义TestLog4j记录器时没有指定级别，所以它的级别继承自它的父记录器，即根记录器，所以它的级别也为DEBUG。

      在定义TestLog4j记录器时又定义了一个名称为R的输出端，所以它的输出端有两个，一个从根记录器继承而来的名为stdout的输出端，另一个为在此定义的名为R的输出端。在此需要注意的是，在定义记录器时必须先定义记录器的级别，然后才是记录器的输出端。如果只想定义输出端而不定义级别，则虽然级别可以为空，但逗号分隔符不能省略。如定义TestLog4j记录器的做法。　　

      在定义TestLog4j.TestLog4j2记录器时又指定了它的级别，由于一个记录器的级别只能有一个，所以新指定的级别将覆写掉它的父记录器的级别（这就象Java中的多态）。我们没有定义TestLog4j.TestLog4j2记录器的输出端，所以它的输出端将从它的父记录器中继承而来。它的父记录器为estLog4j记录器，所以它和TestLog4j记录器一样具有两个名称分别为 stdout和R的输出端。　　

3、 剩下的3区和4区分别设置了两个输出端的参数值。