log4j的日志功能的实现

大家都知道log4j是apache的开源代码项目,要说到怎么用,大家也许只会想到拷包,配置下,然后写下代码就可以直接用了(我觉得这个大家都知道)。但也许问的细一点就不会了吧。。。

通过使用Log4j,我们可以控制日志信息输送的目的地是控制台、文件、GUI组件等;也可以控制每一条日志的输出格式;通过定义每一条日志信息的级别,能够更加细致地控制日志的生成过程。最方便的一点是,这些功能都可以通过一个配置文件来灵活地进行配置,而不需要修改应用的代码。所以,它的配置文件是很重要的。

说到配置文件,插个题外话---配置文件分2种,properties和xml。这2种有啥区别呢?简单来说,就是properties是以键值对的形式来存放,如果在前后两行properties文件中给同一个属性赋不同值,得到的结果往往是属性是后面赋值的值。properties的局限性在于,只能处理赋值。

xml配置文件则是一个树的结构,因此,可以处理各种各样定义好的情况,例如add一个属性之类的,这在properties配置文件中就没有办法实现了。

总体来说,properties配置文件易于理解配置了哪些信息,适合于简单的属性配置

xml配置文件结构清晰,相对结构复杂,内容也比较繁琐,配置的时侯通常需要查阅相关文档才能保证不会错漏。

言归正传,我觉得对于日志来说,配置信息还是很重要的,下面来看看一个一般的配置信息:

 log4j.rootLogger=INFO, stdout , R

 log4j.appender.stdout=org.apache.log4j.ConsoleAppender

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

 log4j.appender.stdout.layout.ConversionPattern=[QC] %p [%t] %C.%M(%L) | %m%n

 log4j.appender.R=org.apache.log4j.DailyRollingFileAppender

 log4j.appender.R.File=D:\\Tomcat 5.5\\logs\\qc.log

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

 log4j.appender.R.MaxFileSize= 100KB

 log4j.appender.R.MaxBackupIndex=1

 log4j.appender.R.layout.ConversionPattern=%d-[TS] %p %t %c - %m%n

 log4j.logger.com.neusoft=DEBUG

 log4j.logger.com.opensymphony.oscache=ERROR

 log4j.logger.net.sf.navigator=ERROR

 log4j.logger.org.apache.commons=ERROR

 log4j.logger.org.apache.struts=WARN

 log4j.logger.org.displaytag=ERROR

 log4j.logger.org.springframework=DEBUG

 log4j.logger.com.ibatis.db=WARN

 log4j.logger.org.apache.velocity=FATAL

 log4j.logger.com.canoo.webtest=WARN

 log4j.logger.org.hibernate.ps.PreparedStatementCache=WARN

 log4j.logger.org.hibernate=DEBUG

 log4j.logger.org.logicalcobwebs=WARN

下面来做下详细的解析:

log4j.rootLogger=INFO, stdout , R

  此句为将等级为INFO的日志信息输出到stdout和R这两个目的地,stdout和R的定义在下面的代码,可以任意起名。等级可分为OFF、FATAL、ERROR、WARN、INFO、DEBUG、ALL,如果配置OFF则不打出任何信息,如果配置为INFO这样只显示INFO, WARN, ERROR的log信息,而DEBUG信息不会被显示,具体讲解可参照第三部分定义配置文件中的logger。

 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(将日志信息以流格式发送到任意指定的地方)

 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(包含日志产生的时间、线程、类别等等信息)

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'

log4j.appender.R=org.apache.log4j.DailyRollingFileAppender

。定义名为R的输出端的类型为每天产生一个日志文件。

log4j.appender.R.File=D:\\Tomcat 5.5\\logs\\qc.log

  此句为定义名为R的输出端的文件名为D:\\Tomcat 5.5\\logs\\qc.log可以自行修改。

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

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

  此句为定义名为R的输出端的layout是哪种类型

log4j.appender.R.layout.ConversionPattern=%d-[TS] %p %t %c - %m%n

  如果使用pattern布局就要指定的打印信息的具体格式ConversionPattern,同上。

 l

og4j.logger.com. neusoft =DEBUG

  指定com.neusoft包下的所有类的等级为DEBUG。

  可以把com.neusoft改为自己项目所用的包名。

log4j.logger.com.opensymphony.oscache=ERROR

log4j.logger.net.sf.navigator=ERROR

  这两句是把这两个包下出现的错误的等级设为ERROR,如果项目中没有配置EHCache,则不需要这两句。

 log4j.logger.org.apache.commons=ERROR

 log4j.logger.org.apache.struts=WARN

  这两句是struts的包。

 log4j.logger.org.displaytag=ERROR

  这句是displaytag的包。(QC问题列表页面所用)

 log4j.logger.org.springframework=DEBUG

  此句为Spring的包。

 log4j.logger.org.hibernate.ps.PreparedStatementCache=WARN

 log4j.logger.org.hibernate=DEBUG

  此两句是hibernate的包。

  以上这些包的设置可根据项目的实际情况而自行定制。

①、配置根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(包含日志产生的时间、线程、类别等等信息)

格式化日志信息

  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 输出日志事件的发生位置,包括类目名、发生的线程,以及在代码中的行数。

在代码中使用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");

  }

恩,大部分摘录的,自己实在写不了那么多,不过都理解了,留着做备份,万一忘了回头好看看。

猜你喜欢

转载自634082093-qq-com.iteye.com/blog/1756662