Log4J

简介

Log4J

是


Apache


的一个开放源代码项目，它是一个日志操作包，通过使用


Log4J


，可以指定日志信息输出的目的地，如控制台、文件、ＣＵＩ组件、


NT


的事件记录器；还可以控制每一条日志输出格式。此外，通过定义日志信息的级别，能够非常细致地控制日志的输出，最令人感兴趣的是，这些功能可以通过一个配置文件来灵活进行配置，而不需要修改应程序代码。

在应用程序中输出日志有３个目的：

l

监视代码中变量的变化情况，把数据周期性记录到文件中供其他应用进行统计分析工作

l

跟踪代码运行时轨迹，作为日后审计的依据

l

担当集成开发环境中的调试器的作用，向文件和控制台打印代码的调试信息

要在程序中输出日志，最普通的做法就是在代码中嵌入语句，这些打印语句可以把日志输出到控制台或文件中，比较好的做法就是构造一个日志操作类来封装此类操作，而不是让一系列的打印语句充斥代码的主体。

在强调可重用组件的今天，除了自己从头到尾开发一个可重用的日志操作类名，

Apache

为我们提供了一个强有力的现成的日志操作包


Log4J


。

Log4J

主要由三大组件构成：

l Logger:

负责生成日志，并能够对日志信息进行分类筛选，通俗地讲就是决定什么日志信息应该输出，什么日志信息应该被忽略

l Appender

：定义了日志信息输出的目的地，指定日志信息应该被输出到什么地方，这些地方可以是控制台、文件、网络设备等

l Layout:

指定日志信息的输出格式

这个３个组件协同工作，使得开发者能够依据日志信息类别记录信息，并能够在程序运行期间，控制日志信息的输出格式以及日志存放地点。

一个

Logger

可以有多个


Appender


，这意味着日志信息可以同时输出到多个设备上，每个


Appender


都对应一种


Layout,Layout


决定了输出日志信息的格式。

假定根据实际需要，要求程序中的日志信息既能输出到程序运行的控制台下，又能输出到指定的文件中，并且当日志信息输出到控制台时

SimplLayout

布局，当日志信息输出到文件时


PatternLayout


布局，此时


Logger


、


Appender


和


Layout3


个组件的关系如图

Appender

组件 （指定输出目的）





Log4J

的


Appender


组件决定将日志信息输出到什么地方。日前


Log4J


的Ａｐｐｅｎｄｅｒ支持将日志信息输出到以下的目的：

l


控制台

(Console)

l


文件

l


ＧＵＩ组件

一个

logger

可以同时对应多个


Appender,


也就是说，一个


Logger


的日志信息可以同时输出到多个目的地，例如：要为


rootLogger


配置两个


Appender;


一个是


file


，一个是


console,


则可以采用如下配置代码：

Layout

组件



Layout

组件用来决定日志的输出格式，它有以下几种类型

l org.apache.log4j.HTMLLayout(

以ＨＴＭＬ表格形式布局


)

l org.apache.log4j.PatternLayout(

可以灵活地指定布局模式


)

l org.apache.log4j.SimpleLayout(

包含日志信息级别和信息字符串


)

l org.apache.log4j.TTCCLayout(

包含日志产生的时间、线程和类别等信息


)

Log4j



的基本使用方法

在应用程序中使用

Log4J

，首先在一个配置文件中配置


Log4j


的各个组件，然后就可以在程序中通过


Log4


Ｊ


API


来操作日志

定义配置文件



Log4J

由３个重要的组件构成：


Logger


、


Appender


和


layout


。


Log4J


支持在程序中以编程的方式设置这些组件，还支持通过配置文件来配置组件，后一种方式更为灵活。

Log4J

支持两种配置文件格式，一种是ＸＭＬ格式，一种是


Java


属性文件，

1. 配置Logger组件



其语法为：



log4j.rootLogger = [ level ] , appenderName1, appenderName2, …

举例：

log4j.rootLogger =WARN,file,console

level :

是日志记录的优先级，分为


OFF


、


FATAL


、


ERROR


、


WARN


、


INFO


、


DEBUG


、


ALL


或者您定义的级别。

Log4j

建议只使用四个级别，优先级从高到低分别是

ERROR>WARN>INFO>DEBUG

。通过在这里定义的级别，您可以控制到应用程序中相应级别的日志信息的开关。比如在这里定


义了

INFO

级别，则应用程序中所有


DEBUG


级别的日志信息将不被打印出来。

appenderName:

就是指定日志信息输出到哪个地方。您可以同时指定多个输出目的地。

All

：打印所有日志。

Off

：关闭所有的日志。



例如：


log4j.rootLogger


＝


info,A1,B2,C3

2.


配置

Appender

组件

其语法为：



log4j.appender.appenderName =fully.qualified.name.of.appender.class


.

举例：

log4j.appender.console=org.apache.log4j.ConsoleAppender

“fully.qualified.name.of.appender.class”

可以指定下面五个目的地中的一个



：




1.org.apache.log4j.ConsoleAppender

（控制台）




2.org.apache.log4j.FileAppender

（文件）


【只能把日志输出一个文件，不推荐】




3.org.apache.log4j.DailyRollingFileAppender

（每天产生一个日志文件）




4.org.apache.log4j.RollingFileAppender

（文件大小到达指定尺寸的时候产生一个新的文件）




5.org.apache.log4j.WriterAppender

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

A.


ConsoleAppender

选项



Threshold=WARN:

指定日志消息的输出最低层次。


ImmediateFlush=true:

默认值是


true,


意谓着所有的消息都会被立即输出。


Target=System.err

：默认情况下是：


System.out,


指定输出控制台



B

.

FileAppender

选项

Threshold=WARN:

指定日志消息的输出最低层次。

ImmediateFlush=true:

默认值是


true,


意谓着所有的消息都会被立即输出。

File=mylog.txt:

指定消息输出到


mylog.txt


文件。


Append=false:

默认值是


true,


即将消息增加到指定文件中，


false


指将消息覆盖

指定的文件内容。



C


.DailyRollingFileAppender

选项





Threshold=WARN:

指定日志消息的输出最低层次。


ImmediateFlush=true:

默认值是


true,


意谓着所有的消息都会被立即输出。


File=mylog.txt:

指定消息输出到


mylog.txt


文件。


Append=false:

默认值是


true,


即将消息增加到指定文件中，


false


指将消息覆盖指定

的文件内容。


DatePattern=’.’yyyy-ww:

每周滚动一次文件，即每周产生一个新的文件。当然也可

以指定按月、周、天、时和分。即对应的格式如下：


1)’.’yyyy-MM:

每月


2)’.’yyyy-ww:

每周


3)’.’yyyy-MM-dd:

每天


4)’.’yyyy-MM-dd-a:

每天两次


5)’.’yyyy-MM-dd-HH:

每小时


6)’.’yyyy-MM-dd-HH-mm:

每分钟



D


.RollingFileAppender

选项





Threshold=WARN:

指定日志消息的输出最低层次。


ImmediateFlush=true:

默认值是


true,


意谓着所有的消息都会被立即输出。


File=mylog.log:

指定消息输出到


mylog.txt


文件。


Append=false:

默认值是


true,


即将消息增加到指定文件中，


false


指将消息覆盖指

定的文件内容。


MaxFileSize=100KB:

后缀可以是


KB, MB


或者是


GB.


在日志文件到达该大小

时，将会自动滚动，即将原来的内容移到

mylog.log.1

文件。


MaxBackupIndex=2:

指定可以产生的滚动文件的最大数。

3

、配置日志信息的格式

其语法为：





1)


log4j.appender.appenderName.layout


=


fully.qualified.name.of.layout.class



“fully.qualified.name.of.layout.class”

可以指定下面


4


个格式中的一个



：

举例：



log4j.appender.console.layout=org.apache.log4j.PatternLayout

log4j.appender.console.layout.ConversionPattern=%d %p %c.%M()-%m%n

1.org.apache.log4j.HTMLLayout

（以


HTML


表格形式布局


）包含选项：

LocationInfo=true:

默认值是


false,


输出


java


文件名称和行号


Title=my app file:

默认值是


Log4J Log Messages.

2.org.apache.log4j.PatternLayout

（可以灵活地指定布局模式


）


包含选项：

ConversionPattern=%m%n :

指定怎样格式化指定的消息。

3.org.apache.log4j.SimpleLayout

（包含日志信息的级别和信息字符串）




4.org.apache.log4j.TTCCLayout

（包含日志产生的时间、线程、类别等等信息）



2)


log4j.appender.A1.layout.ConversionPattern=%-4r %-5p %d{yyyy-MM-dd HH:mm:ssS} %c %m%n






日志信息格式中几个符号所代表的含义：








－


X


号


: X


信息输出时左对齐；


%p:

输出日志信息优先级，即


DEBUG


，


INFO


，


WARN


，


ERROR


，


FATAL,


%d:

输出日志时间点的日期或时间，默认格式为


ISO8601


，也可以在其后指定格式，比如：

%d{yyy MMM dd HH:mm:ss,SSS}

，输出类似：


2002


年


10


月


18


日


22


：


10


：


28


，


921


%r:

输出自应用启动到输出该


log


信息耗费的毫秒数


%c:

输出日志信息所属的类目，通常就是所在类的全名


%t:

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


%l:

输出日志事件的发生位置，相当于


%C.%M(%F:%L)


的组合


,


包括类目名、发生的线程，


以及在代码中的行数。举例：

Testlog4.main(TestLog4.java:10)

%x:

输出和当前线程相关联的


NDC(


嵌套诊断环境


),


尤其用到像


java servlets


这样的多客户多线程的应用中。


%%:

输出一个


“%”


字符


%F:

输出日志消息产生时所在的文件名称


%L:

输出代码中的行号


%m:

输出代码中指定的消息


,


产生的日志具体信息


%n:

输出一个回车换行符，


Windows


平台为


“\r\n”


，


Unix


平台为


“\n”


输出日志信息换行

%M

代表方法的名字




可以在


%


与模式字符之间加上修饰符来控制其最小宽度、最大宽度、和文本的对齐方式。如：





1)%20c

：指定输出


category


的名称，最小的宽度是


20


，如果


category


的名称小于


20


。


2)%-20c:

指定输出


category


的名称，最小的宽度是


20


，如果


category


的名称小于


20


的话，


“-”


号指定左对齐。


3)%.30c:

指定输出


category


的名称，最大的宽度是


30


，如果


category


的名称大于


30


的话，就会将左边多出的字符截掉，但小于


30


的话也不会有空格。


4)%20.30c:

如果


category


的名称小于


20


就补空格，并且右对齐，如果其名称长于


30


字符，就从左边交远销出的字符截掉。

在程序中访问

Log4J,

需要用到


Log4J


的ＪＡＲ文件。



在程序中使用

Log4J

包含以下过程：

l

获得日志记录器

l

读取配置文件，配置

Log4J

环境

l

输出日志信息

在进入学习

Log4J

之前，我们要了解通用日志包中的两个常用接口


LogFactory


和


Log


，下面分别介绍它们的用法。

Log

接口

通用日志包把日志消息分为

6

种级别：


FATAL(


致命的


)


、


ERROR(


错误


)


、


WARN(


警告


)


、


INFO(


信息


)


、


DEBUG(


调试


)


和


TRACE(


细节


)


。其中


FATAL


级别最高，


TRACE


级别最低。通用日志包采用日志级别机制，可以灵活的控制输出的日志内容。

org.apache.commons.logging.Log

接口代表日志器，它提供了一组输出日志的方法：

l fatal(Object message):

输出


FATAL


级别的日志消息。

l error(Object message):

输出


ERROR


级别的日志消息。

l ……

l trace(Object message):

输出


TRACE


级别的日志消息。

对于以上输出日志的方法，只有当它输出日志的级别大于或等于为日志其配置的日志级别时，这个方法才会被真正执行。



例如，如果日志器的日志级别为

WARN

，那么在程序中，它的


fatal()


、


error()


和


warn()


方法会被执行，而


info()


、


debug()


和


trace()


方法不会被执行



。

Log

接口还提供了一组判断是否允许输出特定级别的日志消息的方法：

l isFatalEnabled()

l isErrorEnabled()

l ……

l isTraceEnabled()

在程序输出某种级别的日志消息之前，提倡先调用以上方法来判断该级别的日志是否允许输出，这有助于提高应用的性能。例如以下代码先把日志消息添加到

StringBuffer

中，最后在调用日志器的


debug()


方法输出日志：

StringBuffer buf = new StringBuffer();

buf.append(“Login Successsul – ”);

buf.append(“Name:”);

buf.append(username);

log.debug(buf.toString());

对于以上代码，如果日志器实际上不允许输出

DEBUG

级别的日志，那么执行日志器的


debug()


方法不会输出任何消息，此时向


StringBuffer


中添加消息的一大串操做都将是多余的。为了提高性能，可以合理的使用


isDebugEnabled()


方法，避免应用执行多余的操作：

if(log.isDebugEnabled){

StringBuffer buf = new StringBuffer();

buf.append(“Login Successsul – ”);

buf.append(“Name:”);

buf.append(username);

log.debug(bug.toString());

}

(

二


)LogFactory


接口

org.apache.commons.logging.LogFactory

接口提供了获得日志器实例的两个静态方法：

public static Log getLog(String name)throws LogConfigurationException;

public static Log getLog(Class class) throws LogConfigurationException;

第一个

getLog()

方法以


name


参数作为日志器的名字；第二个


getLog()


方法以


class


参数指定的类的名字作为日志器的名字，以下是第二个


getLog()


方法的一种实现方式：

public static Log getLog(Class class) throws LogConfigurationException{

getLog(class.getName);     //call getLog(String name)

}

小结

Log4J

主要由３大组件构成：


Logger


、


Appender


和


Layout


。


Logger


控制日志信息的输出；


Appender


决定日志信息的输出目的地；


Layout


决定日志信息的输出格式。


Log4J


允许用户在配置文件中灵活地配置这些组件。在程序中使用


Log4J


非常方便，只要先取得日志记录器，然后读取配置文件并配置


Log4J


环境，接下来就可以在程序中任何需要输出日志的地方，调用


Logger


类的适当方法来生成日志。