Log4j使用说明文档

dreamwhere 贡献于2011-10-18

作者 USER  创建于2009-01-19 03:44:00   修改者USER  修改于2009-01-19 03:45:00字数10549

文档摘要:我们在编程时经常不可避免地要使用到一些日志操作,比如开发阶段的调试信息、运行时的日志记录及审计。调查显示,日志代码占代码总量的4%。通常大家可以简单地使用System.out.println()语句输出日志信息,但是在发布时,通常不想在正式的版本中打印这些开发时的调试信息,于是又要手工地把这些语句删除,所以大量的这样的System.out.println()调试语句会带来麻烦。更多做法是把它封闭一个简单的输出
关键词:

 log4j用法  我们在编程时经常不可避免地要使用到一些日志操作,比如开发阶段的调试信息、运行时的日志记录及审计。调查显示,日志代码占代码总量的4%。通常大家可以简单地使用System.out.println()语句输出日志信息,但是在发布时,通常不想在正式的版本中打印这些开发时的调试信息,于是又要手工地把这些语句删除,所以大量的这样的System.out.println()调试语句会带来麻烦。更多做法是把它封闭一个简单的输出,比如: public final class Debug   {      public static final boolean debugOn = true;      public static void println(String msg) {          if (debugOn)           {              System.out.println(msg);          }      }  }  这样就可把代码中要用System.out.println()输出调试信息的地方全用Debug.println()替代,当在发布时只需把Debug类中的debugOn改成false即可。这样做虽然在一定程度上解决了问题,但如果需要的是更复杂的日志系统呢,比如把日志信息保存为文件等别的形式;又或是当系统在试运行了一段时间后我们又要更改某些试运行时的测试信息。如果真的遇到这样的情况,也行就只有修改代码了,这样又给开发工作带来了麻烦。 Log4J是Apache软件基金会Jakarta项目下的一个子项目,是用Java编写的优秀日志工具包。通过Log4J可以在不修改代码的情况下,方便、灵活地控制任意粒度的日志信息的开启或关闭,然后使用定制的格式,把日志信息输出到一个或多个需要的地方。并且,Log4J还有一条平滑的学习曲线,在三分钟内就可学会它的简单使用。随着使用深入,你会发现Log4J功能的强大,几乎可以满足日志方面的所有需要。 第一个log4j程序及其原理 1 第一个log4j程序 让我们从现在开始记时,看完成第一个log4j程序要不要3分钟。首先log4j-1.2.7.jar考到你的类路径下。然后创建一个类,代码如下: package TestLog4j;  import org.apache.log4j.Logger;  import org.apache.log4j.BasicConfigurator;  import org.apache.log4j.PropertyConfigurator;  import org.apache.log4j.Priority;;  public class TestLog4j   {      //代码(1)      static Logger logger = Logger.getLogger(TestLog4j.class.getName());      public TestLog4j(){}      public static void main(String[] args)  {       //代码(2)          BasicConfigurator.configure();           //代码(3)          logger.debug("Start of the main() in TestLog4j");          logger.info("Just testing a log message with priority set to INFO");          logger.warn("Just testing a log message with priority set to WARN");          logger.error("Just testing a log message with priority set to ERROR");          logger.fatal("Just testing a log message with priority set to FATAL");          logger.log(Priority.DEBUG, "Testing a log message use a alternate form");          logger.debug("End of the main() in TestLog4j");      }  }  最后运行这个类,你就会看到运行结果为: 0 [main] DEBUG TestLog4j.TestLog4j  - Start of the main() in TestLog4j 10 [main] INFO TestLog4j.TestLog4j  - Just testing a log message with priority set to INFO 10 [main] WARN TestLog4j.TestLog4j  - Just testing a log message with priority set to WARN 21 [main] ERROR TestLog4j.TestLog4j - Just testing a log message with priority set to ERROR 21 [main] FATAL TestLog4j.TestLog4j  - Just testing a log message with priority set to FATAL 111 [main] DEBUG TestLog4j.TestLog4j  - Testing a log message use a alternate form 111 [main] DEBUG TestLog4j.TestLog4j  - End of the main() in TestLog4j 好了,看一看你的表,应该不到3分钟吧。在这短短的3分钟里,我们做了些什么呢?下面我们来分析一下代码。 1)    首先代码(1)先通过Logger类的getLogger()方法得到一个Logger类的对象。在getLogger()方法中,通常把所在的类的Class对象或是所在类的全名作为参数。运用log4j输出日志要用到Logger对象。 2)    然后代码(2)进行一些必要的初始化,如要把调试信息输出到哪。当用System.out.println()时可以很明确的知道要把信息输出到标准输出设备且只能输出到那里。运用log4j,我们可以输出到许多地方,如控制台、文件、HTML文件等,至于要输出到哪里,就要自己进行初始化。在代码(2),我们调用自带的初始化方法来完成初始化。用这个方法进行初始化就不能体现出log4j的灵活性,所以基本上不会这样做。Log4j提供了用XML文件或Java配置文件来配置设置的方法,在下面我们将进行介绍。 3)    接着代码(3)就是输出信息的代码了。你可以看到代码(3)中尝试了用几种不同的方法来输出信息,对于这几种信息的作用,我会在下面进行介绍,你现在只需把它当成是输出语句就行。 最后,我们来看一下运行结果(日志信息)的意义。第一个数字是指程序开始运行到运行该日志语句所经历的毫秒数(用来做一点运行效率分析也不错),“[main]”是日志事件发生的线程,随后的“DEBUG”、“INFO”等信息是相应日志信息的优先级别,“TestLog4j.TestLog4”是当前TestLog4所在的包和名称,最后是日志信息。 2 实例原理 虽然完成了第一程序了,但程序中的内容还是不太了解。好,现在我就对上面的例子用到的log4j的原理进行讲解。在以后的章节中,我都会采取这种先实例,再根据实例来介绍所涉及的log4j原理的方法。 2.1 记录器Logger Logger类是在log4j1.2以后才有的,以前是用Category类来实现现在的Logger类的功能的。从API可知,Logger类是Category类的子类。Logger类的代码如下: package org.apache.log4j;  public class Logger {      // 创建和取回方法:      public static Logger getRootLogger();  public static Logger getLogger(String name);  public static Logger getLogger(Class class1);      // 打印方法:      public void debug(Object message);      public void info(Object message);      public void warn(Object message);      public void error(Object message);      public void fatal(Object message);      // 常用打印方法:      public void log(Level l, Object message);  }  在讨论Logger类中的方法之前,我先讲一下log4j中的级别(level)的概念。 2.1.1 级别Level Log4j中的日志级别分为五种:DEBUG、INFO、WARN、ERROR和FATAL,这五种级别从左到右级别依次增加。 2.1.2 Logger中的打印函数与级别 对于每一个记录器,我们都可对它赋于一定的级别,而打印函数打印的即是相应级别的信息。当对一个级别为A的Logger调用级别为B的打印方法时,只有当B>=A时才会进行打印。例如,如果有一个级别为WARN的Logger对象logger,只有对它调用logger.warn (message)、logger.error (message)和logger.fatal (message)这三个打印函数才会打印信息;而调用logger.debug (message)和logger.info (message)则不会打印信息,因为debug()函数只有当logger的级别为DEBUG时才打印信息,info()函数只有当logger的级别为INFO时才打印信息。 除了对应于每一个级别有一个打印函数外,在Logger类中还有一个log(),它可以让你通过参数来指定一个打印信息的打印级别。 引入级别后就可通过修改调试的级别来控制某个调试信息是否输出。假设我们有的信息是在开发时才需要输出的(称为测试信息),那么我们把输出测试信息的Logger的级别在开发时设为DEBUG级别的,并用debug(Object message)函数来进行打印。当要发布系统时,只需把相应的Logger的级别调高就可以屏蔽掉测试信息。 log4j配置方法及包说明 在强调可重用组件开发的今天,除了自己从头到尾开发一个可重用的日志操作类外,Apache为我们提供了一个强有力的日志操作包-Log4j。  Log4j是Apache的一个开放源代码项目,通过使用Log4j,我们可以控制日志信息输送的目的地是控制台、文件、GUI组件、甚至是套接口服务器、NT的事件记录器、UNIX Syslog守护进程等;我们也可以控制每一条日志的输出格式;通过定义每一条日志信息的级别,我们能够更加细致地控制日志的生成过程。最令人感兴趣的就是,这些可以通过一个配置文件来灵活地进行配置,而不需要修改应用的代码。  此外,通过Log4j其他语言接口,您可以在C、C++、.Net、PL/SQL程序中使用Log4j,其语法和用法与在Java程序中一样,使得多语言分布式系统得到一个统一一致的日志组件模块。而且,通过使用各种第三方扩展,您可以很方便地将Log4j集成到J2EE、JINI甚至是SNMP应用中。 说明:下面分为三部分,第一部分讲解如何配置log4j,第二部分为对log4j.properties配置文件中的各个属性的讲解,第三部分为对log4j的详细讲解,如果只想配置上log4j,那么只需要看前两个部分就可以,如果想对log4j深入了解,则还需看第三部分。 一、Log4j配置 第一步:加入log4j-1.2.8.jar到lib下。 第二步:在CLASSPATH下建立log4j.properties。内容如下: 1 log4j.rootCategory=INFO, stdout , R 2  3 log4j.appender.stdout=org.apache.log4j.ConsoleAppender 4 log4j.appender.stdout.layout=org.apache.log4j.PatternLayout 5 log4j.appender.stdout.layout.ConversionPattern=[QC] %p [%t] %C.%M(%L) | %m%n 6  7 log4j.appender.R=org.apache.log4j.DailyRollingFileAppender 8 log4j.appender.R.File=D:\Tomcat 5.5\logs\qc.log 9 log4j.appender.R.layout=org.apache.log4j.PatternLayout 10 log4j.appender.R.layout.ConversionPattern=%d-[TS] %p %t %c - %m%n 11  12 log4j.logger.com.neusoft=DEBUG 13 log4j.logger.com.opensymphony.oscache=ERROR 14 log4j.logger.net.sf.navigator=ERROR 15 log4j.logger.org.apache.commons=ERROR 16 log4j.logger.org.apache.struts=WARN 17 log4j.logger.org.displaytag=ERROR 18 log4j.logger.org.springframework=DEBUG 19 log4j.logger.com.ibatis.db=WARN 20 log4j.logger.org.apache.velocity=FATAL 21  22 log4j.logger.com.canoo.webtest=WARN 23  24 log4j.logger.org.hibernate.ps.PreparedStatementCache=WARN 25 log4j.logger.org.hibernate=DEBUG 26 log4j.logger.org.logicalcobwebs=WARN 第三步:相应的修改其中属性,修改之前就必须知道这些都是干什么的,在第二部分讲解。 第四步:在要输出日志的类中加入相关语句: 定义属性:protected final Log log = LogFactory.getLog(getClass()); 在相应的方法中: if (log.isDebugEnabled()) { log.debug(“System …..”); } 二、Log4j说明 1 log4j.rootCategory=INFO, stdout , R 此句为将等级为INFO的日志信息输出到stdout和R这两个目的地,stdout和R的定义在下面的代码,可以任意起名。等级可分为OFF、FATAL、ERROR、WARN、INFO、DEBUG、ALL,如果配置OFF则不打出任何信息,如果配置为INFO这样只显示INFO, WARN, ERROR的log信息,而DEBUG信息不会被显示,具体讲解可参照第三部分定义配置文件中的logger。 3 log4j.appender.stdout=org.apache.log4j.ConsoleAppender 此句为定义名为stdout的输出端是哪种类型,可以是 org.apache.log4j.ConsoleAppender(控制台),  org.apache.log4j.FileAppender(文件),  org.apache.log4j.DailyRollingFileAppender(每天产生一个日志文件), org.apache.log4j.RollingFileAppender(文件大小到达指定尺寸的时候产生一个新的文件) org.apache.log4j.WriterAppender(将日志信息以流格式发送到任意指定的地方) 具体讲解可参照第三部分定义配置文件中的Appender。 4 log4j.appender.stdout.layout=org.apache.log4j.PatternLayout 此句为定义名为stdout的输出端的layout是哪种类型,可以是 org.apache.log4j.HTMLLayout(以HTML表格形式布局),  org.apache.log4j.PatternLayout(可以灵活地指定布局模式),  org.apache.log4j.SimpleLayout(包含日志信息的级别和信息字符串),  org.apache.log4j.TTCCLayout(包含日志产生的时间、线程、类别等等信息) 具体讲解可参照第三部分定义配置文件中的Layout。 5 log4j.appender.stdout.layout.ConversionPattern= [QC] %p [%t] %C.%M(%L) | %m%n 如果使用pattern布局就要指定的打印信息的具体格式ConversionPattern,打印参数如下: %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 输出日志事件的发生位置,包括类目名、发生的线程,以及在代码中的行数。 [QC]是log信息的开头,可以为任意字符,一般为项目简称。 输出的信息 [TS] DEBUG [main] AbstractBeanFactory.getBean(189) | Returning cached instance of singleton bean 'MyAutoProxy' 具体讲解可参照第三部分定义配置文件中的格式化日志信息。 7 log4j.appender.R=org.apache.log4j.DailyRollingFileAppender 此句与第3行一样。定义名为R的输出端的类型为每天产生一个日志文件。 8 log4j.appender.R.File=D:\Tomcat 5.5\logs\qc.log 此句为定义名为R的输出端的文件名为D:\Tomcat 5.5\logs\qc.log 可以自行修改。 9 log4j.appender.R.layout=org.apache.log4j.PatternLayout 与第4行相同。 10 log4j.appender.R.layout.ConversionPattern=%d-[TS] %p %t %c - %m%n 与第5行相同。 12 log4j.logger.com. neusoft =DEBUG 指定com.neusoft包下的所有类的等级为DEBUG。 可以把com.neusoft改为自己项目所用的包名。 13 log4j.logger.com.opensymphony.oscache=ERROR 14 log4j.logger.net.sf.navigator=ERROR 这两句是把这两个包下出现的错误的等级设为ERROR,如果项目中没有配置EHCache,则不需要这两句。 15 log4j.logger.org.apache.commons=ERROR 16 log4j.logger.org.apache.struts=WARN 这两句是struts的包。 17 log4j.logger.org.displaytag=ERROR 这句是displaytag的包。(QC问题列表页面所用) 18 log4j.logger.org.springframework=DEBUG 此句为Spring的包。 24 log4j.logger.org.hibernate.ps.PreparedStatementCache=WARN 25 log4j.logger.org.hibernate=DEBUG 此两句是hibernate的包。 以上这些包的设置可根据项目的实际情况而自行定制。 三、log4j详解 1、定义配置文件 Log4j支持两种配置文件格式,一种是XML格式的文件,一种是Java特性文件log4j.properties(键=值)。下面将介绍使用log4j.properties文件作为配置文件的方法: ①、配置根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就是指定日志信息输出到哪个地方。可同时指定多个输出目的地。 ②、配置日志信息输出目的地 Appender Appender 负责控制日志记录操作的输出。  其语法为: log4j.appender.appenderName = fully.qualified.name.of.appender.class  log4j.appender.appenderName.option1 = value1  …  log4j.appender.appenderName.optionN = valueN  这里的appenderName为在①里定义的,可任意起名。 其中,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为控制台。 ③、配置日志信息的格式(布局)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(包含日志产生的时间、线程、类别等等信息) 2、格式化日志信息 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 输出日志事件的发生位置,包括类目名、发生的线程,以及在代码中的行数。 3、在代码中使用Log4j 我们在需要输出日志信息的类中做如下的三个工作: 1、导入所有需的commongs-logging类: import org.apache.commons.logging.Log; import org.apache.commons.logging.LogFactory; 2、在自己的类中定义一个org.apache.commons.logging.Log类的私有静态类成员: private final Log log = LogFactory.getLog(getClass()); LogFactory.getLog()方法的参数使用的是当前类的class。 3、使用org.apache.commons.logging.Log类的成员方法输出日志信息: if (log.isDebugEnabled()) { log.debug("111"); } if (log.isInfoEnabled()) { log.info("222"); } if (log.isWarnEnabled()) { log.warn("333"); } if (log.isErrorEnabled()) { log.error("444"); } if (log.isFatalEnabled()) { log.fatal("555") } 

下载文档到电脑,查找使用更方便

文档的实际排版效果,会与网站的显示效果略有不同!!

需要 15 金币 [ 分享文档获得金币 ] 2 人已下载

下载文档