Log4J文档

Log4j使用Log4J进行日志操作Log4J是Apache的一个开放源代码项目，它是一个日志操作包，通过使用Log4J，可以指定日志信息输出的目的地，如控制台、文件、ＣＵＩ组件、NT的事件记录器；还可以控制每一条日志输出格式。

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

在应用程序中输出日志有３个目的：●监视代码中变量的变化情况，把数据周期性记录到文件中供其他应用进行统计分析工作●跟踪代码运行时轨迹，作为日后审计的依据●担当集成开发环境中的调试器的作用，向文件和控制台打印代码的调试信息要在程序中输出日志，最普通的做法就是在代码中嵌入语句，这些打印语句可以把日志输出到控制台或文件中，比较好的做法就是构造一个日志操作类来封装此类操作，而不是让一系列的打印语句充斥代码的主体。

在进入学习Log4J之前，我们要了解通用日志包中的两个常用接口LogFactory和Log，下面分别介绍它们的用法。

（一）Log接口通用日志包把日志消息分为6种级别：FATAL(致命的)、ERROR(错误)、WARN(警告)、INFO(信息)、DEBUG(调试)和TRACE(细节)。

其中FATAL级别最高，TRACE级别最低。

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

mons.logging.Log接口代表日志器，它提供了一组输出日志的方法：●fatal(Object message): 输出FATAL级别的日志消息。

●error(Object message): 输出ERROR级别的日志消息。

●……●trace(Object message): 输出TRACE级别的日志消息。

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

例如，如果日志器的日志级别为WARN，那么在程序中，它的fatal()、error()和warn()方法会被执行，而info()、debug()和trace()方法不会被执行。

Log接口还提供了一组判断是否允许输出特定级别的日志消息的方法：●isFatalEnabled()●isErrorEnabled()●……●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接口mons.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简介在强调可重用组件的今天，除了自己从头到尾开发一个可重用的日志操作类名，Apache为我们提供了一个强有力的现成的日志操作包Log4J。

Log4J主要由三大组件构成：●Logger:负责生成日志，并能够对日志信息进行分类筛选，通俗地讲就是决定什么日志信息应该输出，什么日志信息应该被忽略●Appender：定义了日志信息输出的目的地，指定日志信息应该被输出到什么地方，这些地方可以是控制台、文件、网络设备等●Layout: 指定日志信息的输出格式这个３个组件协同工作，使得开发者能够依据日志信息类别记录信息，并能够在程序运行期间，控制日志信息的输出格式以及日志存放地点。

一个Logger可以有多个Appender，这意味着日志信息可以同时输出到多个设备上，每个Appender都对应一种Layout,Layout决定了输出日志信息的格式。

假定根据实际需要，要求程序中的日志信息既能输出到程序运行的控制台下，又能输出到指定的文件中，并且当日志信息输出到控制台时SimplLayout布局，当日志信息输出到文件时PatternLayout布局，此时Logger、Appender和Layout3个组件的关系如图Appender组件Log4J的Appender组件决定将日志信息输出到什么地方。

日前Log4J的Ａｐｐｅｎｄｅｒ支持将日志信息输出到以下的目的：●控制台(Console)●文件●ＧＵＩ组件一个logger可以同时对应多个Appender,也就是说，一个Logger的日志信息可以同时输出到多个目的地，例如：要为rootLogger配置两个Appender;一个是file，一个是console,则可以采用如下配置代码：Lay out组件Layout组件用来决定日志的输出格式，它有以下几种类型●org.apache.log4j.HTMLLayout(以ＨＴＭＬ表格形式布局)●org.apache.log4j.PatternLayout(可以灵活地指定布局模式)●org.apache.log4j.SimpleLayout(包含日志信息级别和信息字符串)●org.apache.log4j.TTCCLayout(包含日志产生的时间、线程和类别等信息)Ｌｏｇ４Ｊ的基本使用方法在应用程序中使用Log4J，首先在一个配置文件中配置Log4j的各个组件，然后就可以在程序中通过Log4ＪAPI来操作日志定义配置文件Log4J由３个重要的组件构成：Logger、Appender和layout。

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

Log4J支持两种配置文件格式，一种是ＸＭＬ格式，一种是Java属性文件，1. 配置Logger组件其语法为：log4j.rootLogger = [ level ] , appenderName1, appenderName2, …level : 是日志记录的优先级，分为OFF、FATAL、ERROR、WARN、INFO、DEBUG、ALL或者您定义的级别。

Log4j建议只使用四个级别，优先级从高到低分别是ERROR、WARN、INFO、DEBUG。

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

比如在这里定义了INFO级别，则应用程序中所有DEBUG级别的日志信息将不被打印出来。

appenderName:就是指定日志信息输出到哪个地方。

您可以同时指定多个输出目的地。

All：打印所有日志。

Off：关闭所有的日志。

例如：log4j.rootLogger＝info,A1,B2,C32. 配置Appender组件其语法为：log4j.appender.appenderName =.of.appender.class.".of.appender.class" 可以指定下面五个目的地中的一个：.apache.log4j.ConsoleAppender（控制台）.apache.log4j.FileAppender（文件）.apache.log4j.DailyRollingFileAppender（每天产生一个日志文件）.apache.log4j.RollingFileAppender（文件大小到达指定尺寸的时候产生一个新的文件）.apache.log4j.WriterAppender（将日志信息以流格式发送到任意指定的地方）A.ConsoleApp end er选项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.RollingFileA ppender 选项Threshold=WARN:指定日志消息的输出最低层次。